Visão Geral da Referência da API

Referência completa para a API REST SharpAPI v1. Todos os endpoints retornam JSON e seguem convenções consistentes para autenticação, filtragem, paginação e tratamento de erros.

URL BasePermalink for this section

https://api.sharpapi.io/api/v1

Especificação OpenAPIPermalink for this section

A especificação completa OpenAPI 3.1 está disponível para importação em ferramentas como Postman, Insomnia ou geradores de código:

• Baixar Especificação OpenAPI (JSON)

Formato da RequisiçãoPermalink for this section

• Todas as requisições usam HTTPS
• Autenticação via cabeçalho X-API-Key, cabeçalho Authorization: Bearer ou parâmetro de consulta api_key
• Corpos de requisição (quando aplicável) usam JSON com Content-Type: application/json
• Todos os nomes de campo são snake_case

Resumo dos EndpointsPermalink for this section

A SharpAPI expõe 35 rotas em 7 namespaces, além de endpoints de referência e de saúde.

OddsPermalink for this section

EventosPermalink for this section

OportunidadesPermalink for this section

SplitsPermalink for this section

StreamingPermalink for this section

ContaPermalink for this section

Dados de Referência (Públicos)Permalink for this section

EnterprisePermalink for this section

SaúdePermalink for this section

Formato da RespostaPermalink for this section

Duas formas de nível superior — ambas colocam data primeiro e updated_at por último, com um bloco pagination opcional no meio. Não existe campo success; o código de status HTTP é a fonte da verdade. Consulte Convenções de Resposta para o conjunto completo de regras.

Resposta de lista paginadaPermalink for this section

{
  "data": [
    {
      "id": "draftkings_33483153_moneyline_PHO",
      "sportsbook": "draftkings",
      "sport": "basketball",
      "home_team": "PHI 76ers",
      "away_team": "PHO Suns",
      "market_type": "moneyline",
      "selection": "PHO Suns",
      "odds_american": -150,
      "odds_decimal": 1.667,
      "odds_probability": 0.60,
      "is_live": false
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "count": 1,
    "total": 3095,
    "has_more": true,
    "next_offset": 50,
    "next_cursor": "eyJlIjoiMzM0ODMxNTMiLCJiIjoiZHJhZnRraW5ncyIsIm0iOiJtb25leWxpbmUiLCJpIjoiZHJhZnRraW5nc18zMzQ4MzE1M19tb25leWxpbmVfUEhJIn0"
  },
  "updated_at": "2026-01-26T02:10:37.846Z"
}

Resposta de Recurso ÚnicoPermalink for this section

Usada para recursos únicos (/account, /events/:eventId) e endpoints de referência não paginados. Sem bloco pagination.

{
  "data": {
    "id": "evt_abc123",
    "sport": "nba",
    "home_team": "PHI 76ers",
    "away_team": "PHO Suns",
    "start_time": "2026-01-26T19:00:00Z"
  },
  "updated_at": "2026-01-26T02:10:37.846Z"
}

Envelope de ErroPermalink for this section

Todos os erros seguem um formato consistente:

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Upgrade your plan or wait 45 seconds.",
    "docs": "https://docs.sharpapi.io/en/authentication#rate-limits"
  }
}

Cabeçalhos de Resposta PadrãoPermalink for this section

Toda resposta da API inclui estes cabeçalhos:

Comparação de TiersPermalink for this section

FiltragemPermalink for this section

Todos os endpoints de listagem suportam filtragem via parâmetros de consulta. Os filtros usam nomes de parâmetros no singular e aceitam valores separados por vírgula para seleção múltipla.

Parâmetros de FiltroPermalink for this section

ExemplosPermalink for this section

# Múltiplos sportsbooks (separados por vírgula)
curl "https://api.sharpapi.io/api/v1/odds?sportsbook=draftkings,fanduel" \
  -H "X-API-Key: YOUR_KEY"
 
# Combinar filtros
curl "https://api.sharpapi.io/api/v1/odds?league=nba,nhl&sportsbook=pinnacle&live=true" \
  -H "X-API-Key: YOUR_KEY"
 
# Paginar pelos resultados
curl "https://api.sharpapi.io/api/v1/odds?limit=25&offset=50" \
  -H "X-API-Key: YOUR_KEY"

Formatos de OddsPermalink for this section

Todas as odds são retornadas como campos planos em cada objeto de odds:

{
  "odds_american": -110,
  "odds_decimal": 1.909,
  "odds_probability": 0.5238
}

Códigos de ErroPermalink for this section

A lista canônica de códigos de erro emitidos pela API. A string em error.code é o contrato estável — verifique-a em vez do texto em message.

Códigos de erro HTTPPermalink for this section

Emitidos em respostas REST.

Códigos de erro em frames WebSocketPermalink for this section

Emitidos apenas dentro de frames {"type": "error", "code": "..."} em uma conexão WebSocket aberta. Eles descrevem erros do protocolo do cliente e não correspondem a um status HTTP.