Skip to content
Bitelex Docs

System routes

Two routes are outside /api/v1, unversioned, and need no API key.

Health

Section titled “Health”
GET /api/health

Liveness of the API instance that answered. Not wrapped in the response envelope.

Terminal window
curl https://api-dinio.bitelex.com/api/health
{ "status": "ok", "db": "up", "nats": "up", "version": "1.0.0", "ts": 1760000000 }

status is ok when every dependency is up, degraded otherwise.

OpenAPI specification

Section titled “OpenAPI specification”
GET /api/docs/openapi.json

The full OpenAPI 3.0 specification of the API. Open it in Swagger Editor, Postman or Redoc, or generate a client for a language without an official SDK.

Terminal window
curl https://api-dinio.bitelex.com/api/docs/openapi.json