Skip to Content
Referência da APIHealth Check

Verificação de Saúde

Verifique o status operacional do serviço SharpAPI e o quão atualizados estão seus dados de odds.

GET /api/v1/health

AutenticaçãoLink permanente para esta seção

Nenhuma autenticação necessária. Este é um endpoint público. (Uma requisição HEAD retorna apenas o código de status, sem corpo.) Apenas GET e HEAD são aceitos — veja Outros métodos.

Exemplos de RequisiçõesLink permanente para esta seção

curl -X GET "https://api.sharpapi.io/api/v1/health"

RespostaLink permanente para esta seção

A resposta é um objeto plano com exatamente dois campos, status e newest_odds_age_s. Não há wrapper checks/timestamp, e nenhum dado de build ou diagnóstico do backend é retornado.

Saudável (200)Link permanente para esta seção

{ "status": "ok", "newest_odds_age_s": 1 }

Degradado (200)Link permanente para esta seção

O serviço está no ar, mas não tem dados de odds recentes (a última atualização concluída tem mais de 60 s, ou nenhuma foi concluída ainda). O código HTTP permanece 200 para que os balanceadores de carga continuem roteando para cá durante um incidente nos dados de origem:

{ "status": "degraded", "newest_odds_age_s": 142 }

Iniciando (503)Link permanente para esta seção

O processo está no ar e aceitando conexões, mas a inicialização (carregamento das odds, preparação dos caches) não terminou. Tente novamente em instantes:

{ "status": "starting", "newest_odds_age_s": -1 }

Inativo (503)Link permanente para esta seção

Uma dependência central do backend está inacessível:

{ "status": "down", "newest_odds_age_s": 9 }

Cabeçalhos de RespostaLink permanente para esta seção

X-Request-Id: 1782526326424224-82519

O endpoint de saúde não retorna cabeçalhos de rate limit nem cabeçalhos de tier, pois não requer autenticação.

Campos da RespostaLink permanente para esta seção

CampoTipoDescrição
statusstringStatus geral: ok, degraded, starting ou down
newest_odds_age_sintegerSegundos desde que a API concluiu a última atualização dos seus dados de odds. -1 enquanto nenhum dado de odds tiver sido carregado. Mede o ciclo de atualização, não a idade de cada odd individual.

Versões anteriores deste endpoint também retornavam um identificador de build e diagnósticos do backend. Eles não fazem mais parte da resposta pública — leia apenas status e newest_odds_age_s.

Valores de StatusLink permanente para esta seção

StatusCódigo HTTPSignificado
ok200Dados de odds recentes carregados (última atualização há 60 s ou menos)
degraded200No ar, mas sem dados de odds recentes (última atualização há mais de 60 s, ou nenhuma carregada)
starting503Processo no ar, mas a inicialização não terminou
down503Uma dependência central do backend está inacessível

Lógica de StatusLink permanente para esta seção

O status geral é determinado nesta ordem:

  1. Inicialização não concluída → starting (503).
  2. Dependência central do backend inacessível → down (503).
  3. Dados de odds desatualizados ou vazios (a última atualização tem mais de 60 segundos, ou nenhuma foi concluída ainda) → degraded (200).
  4. Caso contrário → ok (200).

Outros métodosLink permanente para esta seção

Qualquer método diferente de GET ou HEAD retorna 405 Method Not Allowed com o cabeçalho Allow: GET, HEAD:

curl -i -X POST "https://api.sharpapi.io/api/v1/health"
HTTP/1.1 405 Method Not Allowed Allow: GET, HEAD X-Error-Code: method_not_allowed
{ "error": { "code": "method_not_allowed", "message": "Method not allowed" } }

Veja Códigos de erro HTTP.

Casos de UsoLink permanente para esta seção

Monitoramento e AlertasLink permanente para esta seção

Use o endpoint de saúde em sua stack de monitoramento (Prometheus, Datadog, UptimeRobot, etc.) para detectar problemas:

# Simple health check for monitoring scripts STATUS=$(curl -s https://api.sharpapi.io/api/v1/health | jq -r '.status') if [ "$STATUS" != "ok" ]; then echo "ALERT: SharpAPI status is $STATUS" fi

Verificação de Saúde Pré-RequisiçãoLink permanente para esta seção

Verifique a saúde antes de fazer requisições críticas:

async function safeRequest(endpoint) { const health = await fetch('https://api.sharpapi.io/api/v1/health') .then(r => r.json()); if (health.status === 'down' || health.status === 'starting') { throw new Error(`SharpAPI is not ready (status: ${health.status})`); } if (health.status === 'degraded') { console.warn('SharpAPI is degraded - data may be stale'); } return fetch(`https://api.sharpapi.io/api/v1${endpoint}`, { headers: { 'X-API-Key': 'YOUR_API_KEY' } }).then(r => r.json()); }

Painel de UptimeLink permanente para esta seção

import requests response = requests.get('https://api.sharpapi.io/api/v1/health') health = response.json() print(f"SharpAPI Status: {health['status'].upper()}") print(f"Newest odds: {health['newest_odds_age_s']}s old")

Endpoints RelacionadosLink permanente para esta seção

Last updated on