---
title: "Health check"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check

`GET /health`

## Request

- Base URL: `https://stockmarketscan.com/api/v1`
- URL: `https://stockmarketscan.com/api/v1/health`
- Auth: none required

Service status and database reachability. No authentication, never cached.

## Response `200`

Service healthy

- object
  - `data` Health, required
    - `status` 'ok', required
    - `version` string, required
    - `db` object, required
      - `reachable` boolean, required
      - `latency_ms` integer, required
  - `meta` Meta, required: Response metadata. Endpoint-specific keys are documented per operation.
    - `as_of` string, date, nullable: Trading date of the underlying data. Null when there is no data.
    - `generated_at` string, date-time, required: When this response was produced (RFC 3339 UTC).
    - `pagination` Pagination: Present on list endpoints. Follow `next_cursor` until it is null.
      - `limit` integer, required: Page size that was applied.
      - `next_cursor` string, nullable, required: Cursor for the next page; null on the last page.
      - `total` integer: Rows across all pages. Only where it is cheap and exact.
    - `parameters` object: Parameters applied after defaults.

## Other responses

- `500`: Unexpected server error. Quote `request_id` when reporting it.
- `503`: A dependency (database or key store) is unavailable.

---

[API](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api.md) · [All operations](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api/llms.txt) · [OpenAPI document](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api/revisions/2cca1387a5fe?raw)