StreamPage
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
data | array of StreamEvent | yes | Events in stream order: the order they were sent, not the order SEC accepted the filings. |
has_more | boolean | yes | True when more events are waiting: ask again at once. |
head_cursor | string | yes | — |
live | object | yes | Its fields follow, as live.…. |
live.covered_until | date-time (RFC 3339, UTC) | null | no | — |
live.state | string | no | The state of live ingest, or down. |
next_cursor | string | yes | Always present, even on an empty answer. With filters, it moves past the events they skipped. |
retention | object | yes | Its fields follow, as retention.…. |
retention.days | integer | no | — |
retention.oldest_cursor | string | null | no | — |
Used by
- Returned by
GET /v3/stream.
Markdown version: /docs/reference/schemas/stream-page.md