> ## Documentation Index
> Fetch the complete documentation index at: https://docs.focusalpha.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Service status & coverage

> Coverage and freshness reporting, liveness, and readiness endpoints.

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

```bash theme={null}
curl "https://api.focusalpha.ai/v1/_status" \
  -H "Authorization: Bearer $FOCUSALPHA_API_KEY"
```

```json theme={null}
{
  "coverage": "subset",
  "coverage_pct": null,
  "last_sweep_at": null,
  "families": [
    {
      "family": "filings",
      "available": true,
      "pending": false,
      "last_refreshed_at": "2026-08-27T09:00:00Z",
      "note": "…"
    }
  ],
  "generated_at": "2026-08-27T12:00:00Z"
}
```

* `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`.

<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](/concepts/errors).
</Note>

## GET /v1/health

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

```bash theme={null}
curl "https://api.focusalpha.ai/v1/health"
```

```json theme={null}
{ "status": "ok", "service": "retrieval-api", "timestamp": "2026-08-27T12:00:00Z" }
```

## 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.

```bash theme={null}
curl "https://api.focusalpha.ai/v1/ready"
```

```json theme={null}
{
  "status": "ready",
  "checks": { "config": "ok", "database": "ok" },
  "timestamp": "2026-08-27T12:00:00Z"
}
```

<Note>
  For monitoring, poll `/v1/health` for liveness and `/v1/ready` before routing traffic. A 503 from `/v1/ready` is temporary — retry shortly.
</Note>