# network.bsky.jetstream.listSegments

> Published by [bsky-lexicons.bsky.social](https://lexicon.garden/identity/did:plc:4v4y5r3lwsbtmsxhile2ljac)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/network.bsky.jetstream.listSegments)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/network.bsky.jetstream.listSegments/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/network.bsky.jetstream.listSegments/examples)

## Definitions

### `network.bsky.jetstream.listSegments`

**Type**: `query`

Enumerate sealed segment files available for download, in ascending index order.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of segment file names to return. |
| `cursor` | `string` | No | Opaque pagination cursor from a previous response. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `segments` | `array` | Yes |  |

### `network.bsky.jetstream.listSegments#segment`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | Segment filename; pass to getSegment. |
| `index` | `integer` | Yes | Zero-based segment index. |
| `maxSeq` | `integer` | Yes |  |
| `minSeq` | `integer` | Yes |  |
| `checksum` | `string` | Yes | Segment-format xxh3 metadata checksum as 16-char hex; equals the getSegment ETag. |
| `sizeBytes` | `integer` | Yes | File size in bytes. |
| `eventCount` | `integer` | Yes | Number of events in the segment. |
| `maxWitnessedAt` | `integer` | Yes | Latest witnessed-at, unix microseconds. |
| `minWitnessedAt` | `integer` | Yes | Earliest witnessed-at, unix microseconds. |

## Raw Schema

```json
{
  "id": "network.bsky.jetstream.listSegments",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "segments"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "segments": {
              "type": "array",
              "items": {
                "ref": "#segment",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 100,
            "maximum": 1000,
            "minimum": 1,
            "description": "Maximum number of segment file names to return."
          },
          "cursor": {
            "type": "string",
            "description": "Opaque pagination cursor from a previous response."
          }
        }
      },
      "description": "Enumerate sealed segment files available for download, in ascending index order."
    },
    "segment": {
      "type": "object",
      "required": [
        "name",
        "index",
        "sizeBytes",
        "checksum",
        "eventCount",
        "minSeq",
        "maxSeq",
        "minWitnessedAt",
        "maxWitnessedAt"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Segment filename; pass to getSegment."
        },
        "index": {
          "type": "integer",
          "description": "Zero-based segment index."
        },
        "maxSeq": {
          "type": "integer"
        },
        "minSeq": {
          "type": "integer"
        },
        "checksum": {
          "type": "string",
          "description": "Segment-format xxh3 metadata checksum as 16-char hex; equals the getSegment ETag."
        },
        "sizeBytes": {
          "type": "integer",
          "description": "File size in bytes."
        },
        "eventCount": {
          "type": "integer",
          "description": "Number of events in the segment."
        },
        "maxWitnessedAt": {
          "type": "integer",
          "description": "Latest witnessed-at, unix microseconds."
        },
        "minWitnessedAt": {
          "type": "integer",
          "description": "Earliest witnessed-at, unix microseconds."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```