Skip to content

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

StatusBodyDescription
200StreamStatus (application/json)OK
defaultProblem (application/problem+json)Any other error (405, 500, 503).

Response body

A 200 carries a StreamStatus object.

FieldTypeRequiredDescription
head_cursorstringyes
latencyobjectyesPercentiles 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_acceptedobjectno
latency.from_registeredobjectno
liveobjectyes
live.covered_untildate-time (RFC 3339, UTC) | nullno
live.statestringno
retentionobjectyes
retention.daysintegerno
retention.oldest_cursorstring | nullno
sequencerobjectyes
sequencer.lag_eventsinteger | nullno
sequencer.lag_secondsnumber | nullno
sequencer.leadingboolean | nullno

Example request

Shell
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