---
title: "Status da API"
method: GET
path: "/health"
tags: ["Utilitários"]
---

# Status da API

`GET /health`

## Request

- Base URL: `https://brapi.dev`
- URL: `https://brapi.dev/health`
- Auth: none declared

Mostra se a API está no ar. `status` é sempre `ok` quando a API responde.

Use em monitores de disponibilidade e checks de CI.

`timestamp` é a hora da verificação em ISO 8601 e `uptime` é o tempo no ar em
segundos. `database.status` vale `ok` ou `error` e `database.latencyMs`
traz a latência da verificação interna. Endpoint público, sem token.

## Query parameters

- `format` 'json': Formato da resposta. Só aceita json.

## Response `200`

API operando normalmente.

- HealthResponse
  - `status` 'ok', required
  - `timestamp` string, date-time, required
  - `uptime` number, required
  - `database` DatabaseHealth
    - `status` 'ok' | 'error', required
    - `latencyMs` number
    - `error` string

## Changes

- **2026-08-21** `f19b0058d946`: 1 info
  - added the new optional `query` request parameter `format`
- **2026-08-21** `d51b6ee0304a`: 1 info
  - api operation id `getHealth` was added
- **2026-04-07** `19f807c15a24`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/changes/health/get.md)

---

[API](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro.md) - [All operations](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/llms.txt) - [OpenAPI document](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/revisions/7c732d79148a?raw)