Skip to content

Health

Fields

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

FieldTypeAlways presentDescription
checksobjectyesIts fields follow, as checks.….
checks.callbacksstringnoWebhook delivery, judged by the organization served most on time. ok: at most 60 seconds late. One of: ok, degraded, down, disabled. More
checks.dbstringnoOne of: ok, fail.
checks.docs_rootstringnoOne of: ok, missing.
checks.livestringnoLive ingest, which adds filings seconds after SEC accepts them. ok: working, or idle outside SEC's hours. One of: ok, paused, degraded, down, disabled. More
checks.mcpstringnoThe MCP server. disabled: not set up. For information only: it never changes status. One of: ok, down, disabled.
checks.storestringnoThe SEC snapshot. stale: more than 3 days old, still used. loading: not served yet. disabled: not set up. One of: ok, stale, loading, unavailable, disabled.
checks.streamstringnoThe filing stream behind /v3/stream. ok: it moved within the last 30 seconds. stale: it has not; status is then degraded. disabled: not set up. One of: ok, stale, disabled.
liveobjectnoLive ingest. Present only when it is set up. Counts and details are on /v3/coverage, which needs a key.
live.lag_secondsinteger | nullnoMedian seconds from SEC's acceptance to the filing being seen, over the last 15 minutes. Null with fewer than 5 filings.
live.last_new_filing_atdate-time (RFC 3339, UTC) | nullnoWhen the newest filing was first seen.
live.last_poll_atdate-time (RFC 3339, UTC) | nullnoThe last successful check of SEC's list of new filings.
live.paused_untildate-time (RFC 3339, UTC) | nullnoWhen the current pause ends. Null when there is none.
live.statestring | nullnoWhat live ingest last reported, such as ok, idle, catching_up, paused, or stopped; dry_run for a test run that adds no filings. Null when it never reported. More
meteringobjectnoPresent only when usage limits are configured. Shows each limit's mode, whether the limit settings could be read, and the state of usage counting. More
statusstringyesok when every check is ok, else degraded. Live ingest counts only on weekdays from 06:00 to 22:00 New York time, when SEC accepts filings. One of: ok, degraded. More
storeobjectnoThe SEC snapshot in use. Counts and load details are on /v3/coverage, which needs a key.
store.availablebooleanno—
store.snapshot_datedate (YYYY-MM-DD) | nullno—
store.staleboolean | nullno—
timedate-time (RFC 3339, UTC)no—
versionstringno—

Field notes

checks.callbacks

degraded: up to 5 minutes late. down: later, or deliveries cannot be read. degraded and down make status degraded. disabled: not set up.

checks.live

paused: SEC refused a request; it waits until live.paused_until, then goes slowly for 30 minutes. degraded: SEC unreachable, database down, disk low, or stopped after repeated pauses. down: not running. disabled: not set up.

live.state

checks.live is the overall judgement, because it also knows how old this report is.

metering

It makes status degraded, never down, while the settings cannot be read, or while a limit is enforced but plans cannot be read.

status

A part that is not set up does not count. The HTTP status is 503 only when the database is down.

Used by

Markdown version: /docs/reference/schemas/health.md