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

# Verificar status da API

`GET /health`

Endpoint de Health Check para monitoramento da disponibilidade e saúde da API.

### O que Retorna

*   `status` — Status do sistema (`ok` ou `error`)
*   `timestamp` — Data/hora da verificação (ISO 8601)
*   `uptime` — Tempo de atividade do servidor (segundos)
*   `database.status` — Saúde do banco de dados (`ok` ou `error`)
*   `database.latencyMs` — Latência da conexão com o banco (ms)

### Exemplo de Uso

```bash
curl "https://brapi.dev/health"
```

### Caso de Uso

Ideal para monitoramento com ferramentas como UptimeRobot, Datadog, ou checks de disponibilidade em pipelines CI/CD.

**Plano Mínimo:** Gratuito
**Autenticação:** Não necessária (Público)

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

---

[API](https://skmtc.net/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro.md) · [All operations](https://skmtc.net/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brapi-dev/brapi-api-do-mercado-financeiro-brasileiro/versions/f275d46193ea/schema)