Utilitários
Status da API
Changed onMostra 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.
get/health
Request
- Base URLhttps://brapi.dev
- URLhttps://brapi.dev/health
- Authnone declared
Query parameters
format'json'
Formato da resposta. Só aceita json.
Response
API operando normalmente.
Example response
{
"status": "ok",
"timestamp": "2026-02-08T16:25:38.608Z",
"uptime": 866.658018047,
"database": {
"status": "ok",
"latencyMs": 1
}
}Changes
- info
added the new optional
queryrequest parameterformat
- info
- info
api operation id
getHealthwas added
- info