Skip to Content
Referência da APIInformações da Conta

Informações da Conta

Recupere os detalhes da sua conta, informações de nível, limites de taxa e recursos habilitados.

GET /api/v1/account

Este endpoint substitui o antigo endpoint /me. O formato da resposta foi atualizado para usar o envelope padrão v1.

Autenticação

Requer chave de API. Disponível em todos os níveis.

Exemplos de Requisições

curl -X GET "https://api.sharpapi.io/api/v1/account" \ -H "X-API-Key: YOUR_API_KEY"

Resposta

Sucesso (200)

{ "data": { "key": { "id": "key_abc123def456", "tier": "pro" }, "limits": { "requests_per_minute": 300, "max_streams": 10, "odds_delay_seconds": 0, "max_books": 15 }, "features": { "ev": true, "arbitrage": true, "middles": true, "streaming": true }, "addons": ["websocket"], "streaming_trial": { "active": false, "eligible": false, "used": true, "activated_at": "2026-01-15T12:00:00Z", "expires_at": "2026-01-15T16:00:00Z" } }, "meta": { "updated_at": "2026-02-08T14:44:32.123Z" } }

Cabeçalhos da Resposta

X-RateLimit-Limit: 300 X-RateLimit-Remaining: 287 X-RateLimit-Reset: 1707401100 X-Data-Delay: 0 X-Request-Id: req_acct123xyz

Respostas de Erro

401 Unauthorized

{ "error": { "code": "unauthorized", "message": "Invalid or missing API key", "docs": "https://docs.sharpapi.io/en/authentication" } }

Campos da Resposta

Objeto Key

CampoTipoDescrição
idstringIdentificador da chave de API usada nesta requisição
tierstringNível de assinatura: free, hobby, pro, sharp ou enterprise
user_idstringIdentificador do usuário (quando disponível)

Objeto Limits

CampoTipoDescrição
requests_per_minutenumberNúmero máximo de requisições à API permitidas por minuto
max_streamsnumberNúmero máximo de streams SSE/WebSocket simultâneos (0 se streaming não estiver habilitado)
odds_delay_secondsnumberAtraso dos dados de odds em segundos (0 para níveis pagos, 60 para o gratuito)
max_booksnumberNúmero máximo de sportsbooks acessíveis no seu nível

Objeto Features

CampoTipoDescrição
evbooleanAcesso à detecção de oportunidades +EV
arbitragebooleanAcesso à detecção de arbitragem
middlesbooleanAcesso à detecção de middles
streamingbooleanAcesso a streaming SSE/WebSocket (via add-on, trial ou enterprise)

Add-ons

CampoTipoDescrição
addonsstring[]Add-ons ativos (ex.: ["websocket"])

Objeto Streaming Trial (Opcional)

Presente quando o usuário possui um trial ativo, é elegível ou já utilizou um trial.

CampoTipoDescrição
activebooleanIndica se um trial de streaming está atualmente ativo
eligiblebooleanIndica se o usuário é elegível para um trial
usedbooleanIndica se o usuário já utilizou seu trial
activated_atstringTimestamp ISO 8601 de quando o trial foi ativado
expires_atstringTimestamp ISO 8601 de quando o trial expira
remaining_hoursnumberHoras restantes do trial

Casos de Uso

Verificar Acesso a Recursos Antes de Fazer Requisições

const { data: account } = await fetch( 'https://api.sharpapi.io/api/v1/account', { headers: { 'X-API-Key': 'YOUR_API_KEY' } } ).then(r => r.json()); if (!account.features.ev) { console.log('Upgrade to Pro tier for +EV detection'); } else { // Proceed with EV endpoint const evData = await fetch( 'https://api.sharpapi.io/api/v1/opportunities/ev', { headers: { 'X-API-Key': 'YOUR_API_KEY' } } ).then(r => r.json()); }

Endpoints Relacionados

Last updated on