Skip to content

GET /v3/stream

The filing stream: a cursor long-poll over every new, updated, corrected and deleted filing.

API key: required. See Authentication.

Group: Filing stream

Parameters

NameInTypeRequiredDefaultDescription
afterquerystringnoA cursor (next_cursor of an earlier answer), or now. Omitted: the head.
waitqueryintegerno25Seconds to hold the request while nothing matches, 0 to 30.
limitqueryintegerno100Events per answer, 1 to 1000.
typesquerycomma-separated list of stringnofiling.new,filing.corrected,filing.deletedEvent types: filing.new, filing.updated, filing.corrected, filing.deleted, feed.day_closed.
detailquerystringnofullsummary (no document list) or full. One of: summary, full.
include_latequerystringnotrueInclude filings first seen in the nightly feed (late: true). One of: true, false.
schema_versionqueryintegerno1The payload schema version; only 1 exists.
formsquerycomma-separated list of stringnoRoot form types (EDGAR alias): 10-K matches 10-K, 10-K/A, 10-K405. A leading - excludes (forms=-3,-4,-5).
form_typesquerycomma-separated list of stringnoExact form types, for example 10-K/A. A leading - excludes.
form_familiesquerycomma-separated list of stringnoRoot form types. A leading - excludes.
ciksquerycomma-separated list of stringnoCIKs (1 to 10 digits each, at most 1,024); any entity role.
tickersquerycomma-separated list of stringnoTickers (at most 64), resolved to CIKs through the current SEC ticker list; an unknown ticker adds no CIK.
sicsquerycomma-separated list of stringnoSIC codes; a * suffix matches a prefix (73*).
statesquerycomma-separated list of stringnoBusiness-address state codes.
itemsquerycomma-separated list of stringno8-K item codes, exact (2.02).

Responses

StatusBodyDescription
200StreamPage (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter (invalid_parameter, unknown_parameter), or an after that is not a cursor or is past the head (invalid_cursor).
401Problem (application/problem+json)Missing, invalid or inactive API key.
403Problem (application/problem+json)The plan of the key's organization does not include the stream (code plan_required; a legacy key follows the plan of the legacy organization), or the organization is suspended (code blocked).
410Problem (application/problem+json)The cursor is older than the 30-day retention (code cursor_expired, with oldest_cursor).
429Problem (application/problem+json)More requests at once than the plan's stream connections, per organization (per key for a legacy key); a waiting request counts (code rate_limited, reason stream_connections).
503Problem (application/problem+json)Postgres cannot answer (code db_unavailable; reason cold_queue_full when the queue of reads for old cursors is full, entitlements_unknown when the plan of the key's organization cannot be read and has not been read before). Retry after the Retry-After delay.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a StreamPage object.

FieldTypeRequiredDescription
dataarray of StreamEventyesIn stream order (the order of emission, not acceptance order).
has_morebooleanyestrue when more events are waiting: ask again at once.
head_cursorstringyes
liveobjectyes
live.covered_untildate-time (RFC 3339, UTC) | nullno
live.statestringnoThe live ingest daemon's state, or down.
next_cursorstringyesOn every answer, an empty one included; with filters it moves past the events they dropped.
retentionobjectyes
retention.daysintegerno
retention.oldest_cursorstring | nullno

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/stream'

Open this route in the console

More in Filing stream

Next: GET /v3/stream/status

Markdown version: /docs/reference/get-stream.md