Coverage
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
computed_at | date-time (RFC 3339, UTC) | no | When data was computed, in UTC. |
data | array of CoverageDay | yes | One row per feed day, newest first, with the day's latest ingest run. At most window.max_days rows: the newest days of the window. |
live | object | null | no | The last status report of live ingest, written every 10 seconds. Null when there is none. It can be old: live_check gives the judgement. Values out of range are null. |
live.covered_until | date-time (RFC 3339, UTC) | null | no | SEC's list of new filings has been read without a gap up to this time. |
live.ended | string | null | no | How the run ended. Null while it runs. One of: clean, failed. |
live.fetch | object | no | Requests to SEC: requests, http_404, http_429, http_5xx, network, integrity, too_large, bytes, and recent {requests, failed}. |
live.filings | object | no | Counts since the run started: seen, listed, documents, failed, skipped_known, per_min_1, per_min_5, and per_min_peak. |
live.heartbeat_at | date-time (RFC 3339, UTC) | null | no | — |
live.items_unmapped | number | null | no | 8-K item descriptions seen without an item code. |
live.last_new_accession | string | null | no | — |
live.last_new_filing_at | date-time (RFC 3339, UTC) | null | no | — |
live.latency_ms | object | no | recent (the last window_s seconds) and day: n, and p50 and p95 of accept_to_seen, seen_to_listed, and seen_to_documents. |
live.limiter | object | no | The shared limit on requests to SEC: priority (on, off, or unavailable), wait_ms {p50, p95}, waits_over_1s, and refused. |
live.mode | string | null | no | One of: live, dry_run. |
live.paused_until | date-time (RFC 3339, UTC) | null | no | — |
live.pauses_24h | number | null | no | — |
live.poll | object | no | Counts of checks of SEC's list. rtt_ms and skew_ms are in milliseconds. |
live.poll.below_page0 | number | null | no | — |
live.poll.failed | number | null | no | — |
live.poll.last_ok_at | date-time (RFC 3339, UTC) | null | no | — |
live.poll.last_poll_failed | boolean | no | Whether the last check failed. |
live.poll.ok | number | null | no | — |
live.poll.out_of_order | number | null | no | — |
live.poll.overflows | number | null | no | — |
live.poll.pages_swept | number | null | no | — |
live.poll.rtt_ms | object | no | — |
live.poll.skew_ms | number | null | no | — |
live.poll.sweeps | object | no | — |
live.poll.sweeps_abandoned | number | null | no | — |
live.poll.sweeps_exhausted | number | null | no | — |
live.poll.uncovered | array of object | no | Up to 50 time spans of SEC's list that could not be read. The nightly feed covers those filings. |
live.poll.uncovered[].at | date-time (RFC 3339, UTC) | null | no | — |
live.poll.uncovered[].from | date-time (RFC 3339, UTC) | null | no | — |
live.poll.uncovered[].reason | string | null | no | One of: max_start, page_unanswered. |
live.poll.uncovered[].until | date-time (RFC 3339, UTC) | null | no | — |
live.poll_interval_ms | number | null | no | — |
live.queue | object | no | Work waiting: fetch_fresh, fetch_backlog, build, retry, oldest_age_s, and behind_since. |
live.roles_unmapped | integer | no | Role names in SEC's list that match no known role. |
live.schema | number | null | no | — |
live.started_at | date-time (RFC 3339, UTC) | null | no | — |
live.state | string | null | no | One of: ok, idle, catching_up, paused, cautious, sec_unreachable, db_down, disk_low, halted, stopping, stopped, failed. |
live.window_open | boolean | null | no | — |
live_check | string | no | Same as checks.live of /v3/health. One of: ok, paused, degraded, down, disabled. |
snapshot | object | yes | The SEC snapshot in use. |
snapshot.accessions | integer | null | no | Distinct filings in the snapshot. |
snapshot.age_days | integer | null | no | — |
snapshot.available | boolean | no | — |
snapshot.date | date (YYYY-MM-DD) | null | no | — |
snapshot.fallback | boolean | null | no | True when a newer snapshot exists but could not be loaded. |
snapshot.filers | integer | null | no | — |
snapshot.filings | integer | null | no | Filing rows in the snapshot. A filing listed by two filers counts twice. |
snapshot.loaded_at | date-time (RFC 3339, UTC) | null | no | — |
snapshot.reloading | boolean | null | no | True while a newer snapshot loads. The current one keeps serving. |
snapshot.stale | boolean | null | no | True when the snapshot is more than 3 days old. |
snapshot.state | string | no | One of: ok, stale, loading, unavailable, disabled. |
snapshot.tickers_date | date (YYYY-MM-DD) | null | no | Date of the newest copy of SEC's ticker file. |
snapshot.tickers_from | date (YYYY-MM-DD) | null | no | Date of the oldest copy kept. |
totals | object | yes | Totals over all filings, whatever the window. Computed in the background every few minutes. If a computation fails, the previous totals stay; computed_at shows their age. |
totals.accepted_at_stored | integer | no | Filings with a stored acceptance time, from the filing's header or from SEC's records. |
totals.amendments | integer | no | Amendments, not counting deleted ones. |
totals.amendments_resolved | integer | no | Amendments linked to their original. |
totals.computed_at | date-time (RFC 3339, UTC) | no | When the totals were computed, in UTC. |
totals.deleted_filings | integer | no | — |
totals.documents | integer | no | — |
totals.filings | integer | no | — |
totals.max_feed_date | date (YYYY-MM-DD) | null | no | — |
totals.max_filing_date | date (YYYY-MM-DD) | null | no | — |
totals.min_feed_date | date (YYYY-MM-DD) | null | no | — |
totals.min_filing_date | date (YYYY-MM-DD) | null | no | — |
truncated | boolean | yes | True when the window holds more than max_days feed days. The older days are left out; ask for them with from and to. |
window | object | yes | The feed days this answer covers. |
window.default | boolean | no | True when neither from nor to was given: the last 90 feed days. |
window.from | date (YYYY-MM-DD) | null | no | The from you asked for. Without one, the oldest day listed; null when no day is listed. |
window.max_days | integer | no | The most days one answer lists: 90 by default, 366 when from or to is given. |
window.to | date (YYYY-MM-DD) | null | no | The to you asked for. Without one, the newest day listed; null when no day is listed. |
Used by
- Returned by
GET /v3/coverage.
Markdown version: /docs/reference/schemas/coverage.md