/api/currency/options-summary
GETDisponível

Resumo de opções da página da moeda

Resumo de opções da página da moeda (OI, volume, put/call, max pain)

GET/api/currency/options-summary
Corretora única: calculado apenas a partir dos dados públicos de opções da Deribit. Os campos do tipo `volume_usd` são baseados em prêmio onde a corretora reporta o volume de prêmios. Para seis corretoras com cobertura por corretora, use `/api/sd/options/overview`.

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
coinstringObrigatório——Símbolo da moeda base (em maiúsculas, p. ex., BTC). Exemplo: BTC

Exemplo de requisição

curl -s "https://www.coinboss.com/api/currency/options-summary?coin=BTC"

Campos da resposta

A tabela de campos é gerada a partir de respostas reais, portanto lista exatamente o que o endpoint retorna. Os caminhos usam a[] para itens de array e {*} para objetos indexados por um nome dinâmico, como uma moeda ou uma corretora.

CampoTipoUnidadeDescrição
successboolean—true quando a requisição foi bem-sucedida. Em caso de falha, o corpo é `{ success: false, code, error, request_id }`.
coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC).
dataobject|null—Conteúdo da resposta.
data.oi_usdnumberUSDContratos em aberto em valor nocional em USD.
data.change_pctnumber%Variação percentual.
data.sourcestring—De onde vem o valor.
data.tsnumbermsTimestamp.

Gerada 2026-11-11 23:00 UTC a partir de 4 respostas reais.

Exemplo de resposta

/api/currency/options-summary?coin=BTC · Resposta real capturada 2026-11-13 03:58:22 UTC.

  • {
    • "success": true,
    • "coin": "BTC",
    • "data": {
      • "oi_usd": 24978601771.99,
      • "change_pct": -4.71,
      • "source": "Deribit",
      • "ts": 1794541801732
      }
    }

Amostras verificadas

Além do exemplo acima, a sonda chama este endpoint com estes parâmetros e verifica o esquema a cada vez.

ParâmetrosHTTPLatênciaResultado
coin=ETH200494 msAprovado
coin=SOL2001 msAprovado
coin=ARKM2001 msAprovado

Verificado 2026-11-13 03:58:22 UTC

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
5m
Microcache de borda
10s
Frequência de atualização
a cada 10 min (substituição completa do snapshot); arquivo horário para a comparação de 24h
Janela
snapshot mais recente; variação em relação ao snapshot horário de cerca de 24 horas antes
Fontes de dados
Contratos em aberto de opções agregados a partir da API pública de uma única corretora (Deribit).
Cobertura de corretoras
Somente BTC e ETH (os dados são null para outras moedas); somente Deribit.
Unidades
USD notional (oi_usd); percent (change_pct)
Método
oi_usd = sum over contracts of open interest (coins) x underlying price; change_pct compares with the archived snapshot closest to 23 hours ago.
Timestamps
Milissegundos da época Unix (UTC), salvo se a descrição do campo indicar o contrário
Formato da resposta
json
Estabilidade
Estável

Status ao vivo

DisponívelVerificado 2026-11-13 03:58:22 UTCHTTP 200613 msEsquema confereDado mais recente: há 8m

Disponibilidade, últimos 30 dias

100% de 410 verificações aprovadas

Erros

As chamadas com falha têm o mesmo formato em todos os endpoints. A lista completa está na página de erros. Erros e limites de requisições →

CódigoHTTPSignificadoO que fazer
INVALID_PARAM400Falta um parâmetro obrigatório ou um valor não é aceito. `param` indica o nome do parâmetro quando ele é conhecido.Não repita a requisição sem alterações; corrija-a.
UNAUTHORIZED401O cabeçalho `CB-API-KEY` foi enviado, mas a chave é desconhecida ou foi revogada. Dados públicos não exigem chave — remova o cabeçalho ou use uma chave válida.Não repita a requisição sem alterações.
FORBIDDEN403A rota não faz parte da API pública (é interna ou exclusiva de conta).Não tente novamente.
NOT_FOUND404Rota desconhecida, ou a moeda / corretora / fundo solicitado não existe.Não tente novamente; confira o caminho e os identificadores no catálogo.
RATE_LIMITED429Mais requisições do que o limite por minuto. `Retry-After` informa os segundos a aguardar.Aguarde `Retry-After` e então tente novamente com backoff.
INTERNAL500Erro inesperado do servidor. A mensagem é genérica de propósito; cite `request_id` ao reportá-lo.Tente novamente uma vez após alguns segundos; se persistir, reporte-o com o ID da requisição.
UPSTREAM_FAILED503A fonte de dados por trás deste endpoint não respondeu a tempo. Nenhum número desatualizado ou substituto é retornado em seu lugar.Tente novamente com backoff; consulte a página de status.
UNAVAILABLE501 / 503O conjunto de dados ainda não está pronto temporariamente (aquecimento do cache) ou o endpoint ainda não tem uma fonte pública lícita.Tente novamente mais tarde; o catálogo marca os endpoints que são indisponíveis por design.
REQUEST_FAILED200Alguns endpoints mais antigos respondem HTTP 200 com `success: false`. Verifique sempre `success`, não apenas o status HTTP.Depende da mensagem; trate como uma requisição com falha.

Experimente

GET/api/currency/options-summaryDisponível
Parâmetros

string — Base coin symbol (uppercase, e.g. BTC).

URL da requisiçãohttps://www.coinboss.com/api/currency/options-summary?coin=BTC
Escolha um endpoint e clique em “Enviar requisição”. A resposta, os cabeçalhos e o tempo de resposta aparecerão aqui.