GET /v3/stream/status
Stream state: the head cursor, live ingest state, sequencer lag and latency percentiles of the last hour and day.
API key: not needed.
Group: Filing stream
Parameters
This route takes no parameters.
Responses
| Status | Body | Description |
|---|---|---|
200 | StreamStatus (application/json) | OK |
default | Problem (application/problem+json) | Any other error (405, 500, 503). |
Response body
A 200 carries a StreamStatus object.
| Field | Type | Required | Description |
|---|---|---|---|
head_cursor | string | yes | |
latency | object | yes | Percentiles in seconds of live filing.new, over the last hour and the last 24 hours: from SEC's acceptance to the event, and from registration to the event. |
latency.from_accepted | object | no | |
latency.from_registered | object | no | |
live | object | yes | |
live.covered_until | date-time (RFC 3339, UTC) | null | no | |
live.state | string | no | |
retention | object | yes | |
retention.days | integer | no | |
retention.oldest_cursor | string | null | no | |
sequencer | object | yes | |
sequencer.lag_events | integer | null | no | |
sequencer.lag_seconds | number | null | no | |
sequencer.leading | boolean | null | no |
Example request
curl -sS 'https://api.secblast.com/v3/stream/status'Open this route in the console
More in Filing stream
Previous: GET /v3/stream
Markdown version: /docs/reference/get-stream-status.md