Skip to content

StreamFiling

The filing in a filing.* event. It has the members of GET /v3/filings/{accession} under the same names, plus form_family, registered_at, documents_state, primary_document, and links.sec_index. It holds details and links only; get document bytes from the document links.

Fields

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

FieldTypeAlways presentDescription
accepted_atdate-time (RFC 3339, UTC) | nullno—
accepted_at_sourcestring | nullno—
accessionstringno—
base_formstring | nullno—
doc_countintegerno—
documentsarray of objectnoUp to 100 documents. Empty with detail=summary.
documents_statestringnopending: the documents were not fetched within 15 seconds. documents is empty, and a filing.updated event with change documents_added follows. One of: complete, pending.
documents_truncatedbooleannoTrue when the list was cut: the filing has more than 100 documents, or the event had to fit in 16 KiB.
entitiesarray of objectnoThe companies and people named in the filing, as on GET /v3/filings/{accession}, with tickers.
entities_truncatedbooleannoTrue when the list was cut so the event fits in 16 KiB: the filer plus the first 50, or the filer alone.
filing_datedate (YYYY-MM-DD) | nullno—
first_seen_atdate-time (RFC 3339, UTC) | nullno—
form_familystring | nullno—
form_typestring | nullno—
itemsarray of stringno—
latebooleanno—
linksobjectnoIts fields follow, as links.….
links.sec_indexstringno—
links.selfstringno—
period_of_reportdate (YYYY-MM-DD) | nullno—
primary_documentobject | nullno—
provisionalbooleanno—
registered_atdate-time (RFC 3339, UTC) | nullno—
sourcestringnorealtime for a filing seen live. feed for one first seen in the nightly feed (late: true).
statusstringno—
total_bytesintegerno—

Used by

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