Skip to content

StreamPage

Fields

Nested fields are written with dots; [] marks the items of an array.

FieldTypeAlways presentDescription
dataarray of StreamEventyesEvents in stream order: the order they were sent, not the order SEC accepted the filings.
has_morebooleanyesTrue when more events are waiting: ask again at once.
head_cursorstringyes—
liveobjectyesIts fields follow, as live.….
live.covered_untildate-time (RFC 3339, UTC) | nullno—
live.statestringnoThe state of live ingest, or down.
next_cursorstringyesAlways present, even on an empty answer. With filters, it moves past the events they skipped.
retentionobjectyesIts fields follow, as retention.….
retention.daysintegerno—
retention.oldest_cursorstring | nullno—

Used by

Markdown version: /docs/reference/schemas/stream-page.md