Skip to main content
Three endpoints report on the service itself. None of them costs credits.

​
GET /v1/_status

Coverage and freshness for the SEC data families — answers “do you have this data” and “how fresh is it”. Requires a valid API key but is not metered. Plan: Free and above · Credits: free
  • coverage is the overall level: none, subset, or full.
  • coverage_pct is universe coverage as a 0–1 fraction, or null while unmeasured — a null means “unmeasured”, not “0%”.
  • families reports each of filings, financials, financial-metrics, company-facts, and ownership: whether its data path is live (available), whether it is still being built or backfilled (pending), when it last refreshed, and a human-readable note.
Unlike the dataset routes, this endpoint returns its payload flat — no data wrapper and no pagination — and errors use the compact { "error": …, "message": … } body described in Errors.

​
GET /v1/health

Liveness. No authentication required. Always returns 200 while the process is up.

​
GET /v1/ready

Readiness. No authentication required. Returns 200 with status: "ready" when the service can serve traffic, and 503 with status: "not_ready" otherwise. checks details each dependency’s state.
For monitoring, poll /v1/health for liveness and /v1/ready before routing traffic. A 503 from /v1/ready is temporary — retry shortly.