Skip to content

GET /v3/coverage/summary

What v3 holds, in one answer that needs no key: filings by status, documents, document versions, the feed days ingested (first, last, count), filings per filing-date year, amendment links by status, the known coverage gaps (a list maintained by hand) and, when this deployment has live ingest, the live daemon's state and lag. The counts are computed in the background, never by a request: once at start and then every 15 minutes by default (at the next background pass after that); computed_at says when, and they are served until the next computation replaces them. live is read per request. Until the first computation after a start has finished the answer is 503 with code warming_up and Retry-After. Cache-Control: public, max-age=300.

API key: not needed.

Group: Coverage, usage and service

Parameters

This route takes no parameters.

Responses

StatusBodyDescription
200CoverageSummary (application/json)OK
503Problem (application/problem+json)Database unavailable (code db_unavailable); or the answer, which the server computes in the background, has not been computed yet since it started (code warming_up). Retry the same request after the Retry-After delay.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a CoverageSummary object.

FieldTypeRequiredDescription
amendmentsobjectyesAmendment links by link status; amendments of deleted filings are not counted. link_rate is resolved / total, rounded to 4 decimals; null when total is 0.
amendments.ambiguousintegerno
amendments.link_ratenumber | nullno
amendments.resolvedintegerno
amendments.target_not_publicintegerno
amendments.target_not_yet_ingestedintegerno
amendments.totalintegerno
amendments.unresolvedintegerno
before_1993objectyesFilings whose by_year_basis date is before 1993, deleted filings not counted: paper records keyed in later, and dates SEC mistyped. Not years of coverage, so not in by_year.
before_1993.filingsintegerno
before_1993.first_yearinteger | nullnoThe earliest year counted; null when filings is 0.
before_1993.paperintegernoPaper filing records among filings (is_paper).
by_yeararray of objectyesFilings per calendar year of by_year_basis from 1993 (EDGAR's first year), oldest year first; deleted filings are not counted. Filings dated earlier are counted in before_1993.
by_year[].filingsintegerno
by_year[].paperintegernoPaper filing records among filings (is_paper).
by_year[].yearintegerno
by_year_basisstringyesThe date by_year groups by. One of: filing_date.
callbacksobject | nullyesWebhook delivery, computed with the counts. Null when this deployment has no webhook delivery.
callbacks.computed_atdate-time (RFC 3339, UTC)noWhen the callbacks block was computed, UTC.
callbacks.latencyobjectno
callbacks.latency.first_attempt_from_acceptedobjectnoSeconds from SEC's acceptance to the first delivery attempt, over the first attempts of the last 24 hours of filing.new and search.match deliveries of live filings (test sends and filings first seen in the nightly feed are left out; nearest-rank percentiles; n is the number of first attempts).
callbacks.latency.first_attempt_from_accepted.nintegerno
callbacks.latency.first_attempt_from_accepted.p50number | nullnoNull when n is 0.
callbacks.latency.first_attempt_from_accepted.p95number | nullnoNull when n is 0.
computed_atdate-time (RFC 3339, UTC)yesWhen the counts were computed, UTC. They are served until a later computation replaces them.
document_versionsintegeryesStored document versions, every delivery of every document.
documentsintegeryesCurrent documents (one per document of each filing).
feed_daysobjectyesFeed days with a complete or partial ingest run (targeted repair runs not counted).
feed_days.countintegerno
feed_days.firstdate (YYYY-MM-DD) | nullno
feed_days.lastdate (YYYY-MM-DD) | nullno
filingsobjectyesFilings in v3 by status; total counts every status.
filings.deletedintegerno
filings.finalintegerno
filings.provisionalintegerno
filings.totalintegerno
gapsobject | nullyesKnown coverage gaps, from a list maintained by hand and read when the server starts: feed days absent from the archive, feed days SEC delivered truncated, and filings no feed delivers. Null when this deployment has no list.
liveobject | nullyesLive ingest, read per request from the daemon's newest session (at most once every 2 s for the whole process). Null when this deployment has no live ingest.
live.checkstringnoAs checks.live of /v3/health. One of: ok, paused, degraded, down.
live.covered_untildate-time (RFC 3339, UTC) | nullnoSEC's list of new filings has been read without a gap up to here.
live.last_new_filing_atdate-time (RFC 3339, UTC) | nullnoWhen the newest filing was first seen.
live.median_lag_secondsinteger | nullnoMedian seconds from SEC's acceptance to the filing being seen, over the daemon's current New York day; null with fewer than 5 filings that day, and when the figure is negative or absurd.
live.modestring | nullnoOne of: live, dry_run, null.
live.statestring | nullnoThe daemon's own state in its last heartbeat, as live.state of /v3/health without the dry_run substitution.
streamobject | nullyesThe filing stream, computed with the counts. Null when this deployment has no stream.
stream.computed_atdate-time (RFC 3339, UTC)noWhen the stream block was computed, UTC.
stream.head_seqinteger | nullnoThe last stream seq the sequencer assigned; null before its first pass.
stream.latencyobjectno
stream.latency.from_acceptedobjectnoSeconds from SEC's acceptance to the filing.new event, over live filings of the last 24 hours (nearest-rank percentiles; n is the number of filings, zeros when it is 0).
stream.latency.from_accepted.nintegerno
stream.latency.from_accepted.p50number | nullnoNull when n is 0.
stream.latency.from_accepted.p95number | nullnoNull when n is 0.

Example request

Shell
curl -sS 'https://api.secblast.com/v3/coverage/summary'

Open this route in the console

More in Coverage, usage and service

Previous: GET /v3/coverage/count · Next: GET /v3/forms

Markdown version: /docs/reference/get-coverage-summary.md