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

# Health

> Lightweight liveness check that returns API availability.

## Overview

Returns a minimal JSON payload indicating that the BlockDB API is reachable and serving requests. Use this endpoint for uptime monitoring, load balancer health probes, and quick connectivity checks.

<Info>
  This endpoint is intended to be inexpensive and safe to poll. It does not return account or usage data.
</Info>

## Parameters

No query parameters or request body.

## Response Fields

<ResponseField name="status" type="string">
  Always `"ok"` when the service is healthy.
</ResponseField>

### See Also

* [Usage & Limits](/api-reference/account-and-usage/usage) — Plan, shared CU, and shared `rate_limit_rps` for your account
* [Authorization](/api-reference/overview/authorization) — API key usage and auth

<RequestExample>
  ```bash cURL theme={null}
  curl -s "https://api.blockdb.io/v1/health"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get("https://api.blockdb.io/v1/health")
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.blockdb.io/v1/health");
  const data = await response.json();
  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "ok"
  }
  ```

  ```json 503 theme={null}
  {
    "error": {
      "code": "SERVICE_UNAVAILABLE",
      "http_status": 503,
      "message": "The service is temporarily unable to handle the request.",
      "hint": "The database connection pool is briefly saturated. Retry after a short delay.",
      "severity": "warning",
      "retryable": true,
      "details": null,
      "docs_url": "https://docs.blockdb.io/api-reference/overview/error-codes"
    }
  }
  ```
</ResponseExample>
