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.
| Field | Type | Always present | Description |
|---|---|---|---|
accepted_at | date-time (RFC 3339, UTC) | null | no | — |
accepted_at_source | string | null | no | — |
accession | string | no | — |
base_form | string | null | no | — |
doc_count | integer | no | — |
documents | array of object | no | Up to 100 documents. Empty with detail=summary. |
documents_state | string | no | pending: 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_truncated | boolean | no | True when the list was cut: the filing has more than 100 documents, or the event had to fit in 16 KiB. |
entities | array of object | no | The companies and people named in the filing, as on GET /v3/filings/{accession}, with tickers. |
entities_truncated | boolean | no | True when the list was cut so the event fits in 16 KiB: the filer plus the first 50, or the filer alone. |
filing_date | date (YYYY-MM-DD) | null | no | — |
first_seen_at | date-time (RFC 3339, UTC) | null | no | — |
form_family | string | null | no | — |
form_type | string | null | no | — |
items | array of string | no | — |
late | boolean | no | — |
links | object | no | Its fields follow, as links.…. |
links.sec_index | string | no | — |
links.self | string | no | — |
period_of_report | date (YYYY-MM-DD) | null | no | — |
primary_document | object | null | no | — |
provisional | boolean | no | — |
registered_at | date-time (RFC 3339, UTC) | null | no | — |
source | string | no | realtime for a filing seen live. feed for one first seen in the nightly feed (late: true). |
status | string | no | — |
total_bytes | integer | no | — |
Used by
- Part of StreamEvent, WebhookFilingCorrected, WebhookFilingNew, and WebhookFilingUpdated.
Markdown version: /docs/reference/schemas/stream-filing.md