/api/sd/options/overview
GETDegradadoSTALE

Visão geral de opções (todas as corretoras)

Contratos em aberto, volume de 24h, razões put/call, max pain, volatilidade implícita ATM, skew de 25 delta e estrutura a termo da IV de opções de uma moeda, agregados entre seis corretoras, com detalhamento por corretora.

GET/api/sd/options/overview
Degradado. O endpoint reporta qualidade dos dados STALE

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
coinstringObrigatório——Símbolo da moeda, sem distinção entre maiúsculas e minúsculas (por exemplo, `BTC`). Valores ausentes ou malformados retornam 400. Exemplo: BTC

Exemplo de requisição

curl -s "https://www.coinboss.com/api/sd/options/overview?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 }`.
schemastring—ID do esquema desta resposta. Só muda quando um campo existente muda de significado ou de tipo.
nownumbermsHorário do servidor em que a resposta foi montada.
coinstring—Símbolo da moeda (em maiúsculas).
index_pricenumber|nullUSDPreço do índice spot usado para a conversão em USD (nos agregados, a mediana dos preços do índice das próprias corretoras).
n_contractsnumber|null—Número de contratos de opções incluídos.
oi_usdnumber|nullUSDContratos em aberto em valor nocional em USD: quantidade de moedas × preço do índice spot. Unilateral.
call_oi_usdnumber|nullUSDContratos em aberto de calls, valor nocional em USD.
put_oi_usdnumber|nullUSDContratos em aberto de puts, valor nocional em USD.
oi_coinnumber|nullcoinContratos em aberto em unidades da moeda subjacente.
call_oi_coinnumber|nullcoinContratos em aberto de calls em unidades da moeda subjacente.
put_oi_coinnumber|nullcoinContratos em aberto de puts em unidades da moeda subjacente.
vol_usd_24hnumber|nullUSDVolume nocional de 24h: quantidade de moedas negociada × preço atual do índice spot. Não é o volume de prêmios.
call_vol_usd_24hnumber|nullUSDVolume nocional de 24h das calls.
put_vol_usd_24hnumber|nullUSDVolume nocional de 24h das puts.
vol_coin_24hnumber|nullcoinQuantidade negociada em 24h em unidades da moeda subjacente.
call_vol_coin_24hnumber|nullcoinQuantidade negociada em 24h das calls, em moedas.
put_vol_coin_24hnumber|nullcoinQuantidade negociada em 24h das puts, em moedas.
vol_premium_usd_24hnumber|nullUSDVolume de prêmios de 24h (preço da opção × quantidade) onde a corretora o publica; `null` nos demais casos. Nunca é somado ao volume nocional.
pcr_oinumber|nullratioContratos em aberto de puts ÷ contratos em aberto de calls, em unidades de moeda; `null` quando o lado das calls é 0.
pcr_volnumber|nullratioVolume de 24h das puts ÷ volume de 24h das calls, em unidades de moeda; `null` quando o lado das calls é 0.
n_expiriesnumber|null—Número de datas de vencimento incluídas.
vol_exchangesarray—Corretoras que contribuem para o volume nocional.
vol_exchanges[]string—Corretoras que contribuem para o volume nocional.
vol_premium_exchangesarray—Corretoras que publicam o volume de prêmios.
vol_premium_exchanges[]string—Corretoras que publicam o volume de prêmios.
max_pain_nearestobject|null—Max pain do vencimento mais próximo que tem contratos em aberto.
max_pain_nearest.expirystring—Data de vencimento (UTC), `YYYY-MM-DD`, ou `all`.
max_pain_nearest.days_leftnumberdaysDias até o vencimento.
max_pain_nearest.strikenumberUSDPreço de exercício (strike).
max_pain_nearest.pain_usdnumberUSDPagamento total aos titulares de opções se o vencimento fosse liquidado neste strike.
max_pain_nearest.oi_usdnumberUSDContratos em aberto em valor nocional em USD: quantidade de moedas × preço do índice spot. Unilateral.
max_pain_nearest.exchangesarray—Corretoras incluídas nesta linha.
max_pain_nearest.exchanges[]string—Corretoras incluídas nesta linha.
max_pain_mainobject|null—Max pain do vencimento principal: o vencimento mais próximo que detém pelo menos 5 % do total de contratos em aberto.
max_pain_main.expirystring—Data de vencimento (UTC), `YYYY-MM-DD`, ou `all`.
max_pain_main.days_leftnumberdaysDias até o vencimento.
max_pain_main.strikenumberUSDPreço de exercício (strike).
max_pain_main.pain_usdnumberUSDPagamento total aos titulares de opções se o vencimento fosse liquidado neste strike.
max_pain_main.oi_usdnumberUSDContratos em aberto em valor nocional em USD: quantidade de moedas × preço do índice spot. Unilateral.
max_pain_main.exchangesarray—Corretoras incluídas nesta linha.
max_pain_main.exchanges[]string—Corretoras incluídas nesta linha.
atm_iv_nearestnumber|null%IV ATM do vencimento mais próximo.
atm_iv_mainnumber|null%IV ATM do vencimento principal.
atm_iv_30dnumber|null%IV ATM interpolada linearmente para um prazo constante de 30 dias; `null` quando os 30 dias não ficam entre dois vencimentos.
skew_25d_mainnumber|nullpercentage pointsSkew 25-delta do vencimento principal.
term_structurearray—IV ATM por vencimento, o mais próximo primeiro.
term_structure[]object—IV ATM por vencimento, o mais próximo primeiro.
term_structure[].expirystring—Data de vencimento (UTC), `YYYY-MM-DD`, ou `all`.
term_structure[].days_leftnumberdaysDias até o vencimento.
term_structure[].atm_ivnumber%Volatilidade implícita no dinheiro (ATM): média da IV de marcação no strike mais próximo do preço a termo.
term_structure[].oi_usdnumberUSDContratos em aberto em valor nocional em USD: quantidade de moedas × preço do índice spot. Unilateral.
exchangesarray—Corretoras incluídas nesta linha.
exchanges[]object—Corretoras incluídas nesta linha.
exchanges[].exchangestring—ID da corretora (em minúsculas).
exchanges[].oi_share_pctnumber%Participação no total de contratos em aberto (valor nocional em USD) da seleção.
exchanges[].n_contractsnumber—Número de contratos de opções incluídos.
exchanges[].oi_usdnumberUSDContratos em aberto em valor nocional em USD: quantidade de moedas × preço do índice spot. Unilateral.
exchanges[].call_oi_usdnumberUSDContratos em aberto de calls, valor nocional em USD.
exchanges[].put_oi_usdnumberUSDContratos em aberto de puts, valor nocional em USD.
exchanges[].oi_coinnumbercoinContratos em aberto em unidades da moeda subjacente.
exchanges[].call_oi_coinnumbercoinContratos em aberto de calls em unidades da moeda subjacente.
exchanges[].put_oi_coinnumbercoinContratos em aberto de puts em unidades da moeda subjacente.
exchanges[].vol_usd_24hnumberUSDVolume nocional de 24h: quantidade de moedas negociada × preço atual do índice spot. Não é o volume de prêmios.
exchanges[].call_vol_usd_24hnumberUSDVolume nocional de 24h das calls.
exchanges[].put_vol_usd_24hnumberUSDVolume nocional de 24h das puts.
exchanges[].vol_coin_24hnumbercoinQuantidade negociada em 24h em unidades da moeda subjacente.
exchanges[].call_vol_coin_24hnumbercoinQuantidade negociada em 24h das calls, em moedas.
exchanges[].put_vol_coin_24hnumbercoinQuantidade negociada em 24h das puts, em moedas.
exchanges[].vol_premium_usd_24hnumber|nullUSDVolume de prêmios de 24h (preço da opção × quantidade) onde a corretora o publica; `null` nos demais casos. Nunca é somado ao volume nocional.
exchanges[].pcr_oinumberratioContratos em aberto de puts ÷ contratos em aberto de calls, em unidades de moeda; `null` quando o lado das calls é 0.
exchanges[].pcr_volnumberratioVolume de 24h das puts ÷ volume de 24h das calls, em unidades de moeda; `null` quando o lado das calls é 0.
exchanges[].n_expiriesnumber—Número de datas de vencimento incluídas.
exchanges[].oi_usd_inversenumber|nullUSDContratos em aberto dos contratos liquidados em cripto.
exchanges[].oi_usd_linearnumberUSDContratos em aberto dos contratos liquidados em stablecoin.
exchanges[].oi_usd_reportednumber|nullUSDO valor de contratos em aberto em USD da própria corretora, onde ela o publica. Apenas para conferência cruzada.
exchanges[].vol_usd_reported_24hnumber|nullUSDO volume nocional negociado da própria corretora, onde ela o publica. Apenas para conferência cruzada.
exchanges[].index_pricenumberUSDPreço do índice spot usado para a conversão em USD (nos agregados, a mediana dos preços do índice das próprias corretoras).
exchanges[].received_atnumbermsHorário em que o coletor da CoinBoss recebeu os dados.
exchanges[].observed_atnumber|nullmsTimestamp informado pela fonte para os dados.
exchanges[].age_snumbersSegundos desde que a linha foi recebida.
exchanges[].is_staleboolean—True quando os dados são mais antigos que sua janela de atualidade.
coverageobject—O que está e o que não está incluído nos números. Compare isto antes de comparar totais com outra fonte.
coverage.included_exchangesarray—Fontes cujos dados atualizados estão incluídos.
coverage.included_exchanges[]string—Fontes cujos dados atualizados estão incluídos.
coverage.unavailablearray—Fontes que não puderam ser incluídas, cada uma com um motivo. Nunca são contadas como 0.
coverage.unavailable[]object—Fontes que não puderam ser incluídas, cada uma com um motivo. Nunca são contadas como 0.
coverage.unavailable[].exchangestring—ID da corretora (em minúsculas).
coverage.unavailable[].reasonstring—Código de motivo legível por máquina.
coverage.unavailable[].detailstring—Explicação do motivo em linguagem natural.
coverage.stale_excludedarray—Linhas deixadas de fora porque sua última atualização está fora da janela de atualidade. vazio nas amostras usadas para gerar esta tabela
coverage.field_gapsarray—Colunas que uma corretora não publica; elas são `null` para essa corretora.
coverage.field_gaps[]object—Colunas que uma corretora não publica; elas são `null` para essa corretora.
coverage.field_gaps[].exchangestring—ID da corretora (em minúsculas).
coverage.field_gaps[].fieldsarray—Nomes das colunas ausentes.
coverage.field_gaps[].fields[]string—Nomes das colunas ausentes.
coverage.field_gaps[].kindstring—Família de contratos: `inverse` (liquidados em cripto) ou `linear` (liquidados em stablecoin).
methodobject—Descrição em texto simples das fórmulas usadas nesta resposta, uma entrada por campo.
method.oi_usdstring—Nota sobre a fórmula de `oi_usd`, em texto simples.
method.vol_usd_24hstring—Nota sobre a fórmula de `vol_usd_24h`, em texto simples.
method.vol_premium_usd_24hstring—Nota sobre a fórmula de `vol_premium_usd_24h`, em texto simples.
method.pcr_oistring—Nota sobre a fórmula de `pcr_oi`, em texto simples.
method.pcr_volstring—Nota sobre a fórmula de `pcr_vol`, em texto simples.
method.max_painstring—Nota sobre a fórmula de `max_pain`, em texto simples.
method.atm_ivstring—Nota sobre a fórmula de `atm_iv`, em texto simples.
method.atm_iv_30dstring—Nota sobre a fórmula de `atm_iv_30d`, em texto simples.
method.skew_25dstring—Nota sobre a fórmula de `skew_25d`, em texto simples.
method.oi_share_pctstring—Nota sobre a fórmula de `oi_share_pct`, em texto simples.
method.index_pricestring—Nota sobre a fórmula de `index_price`, em texto simples.
method.max_pain_mainstring—Nota sobre a fórmula de `max_pain_main`, em texto simples.
method.oi_usd_reportedstring—Nota sobre a fórmula de `oi_usd_reported`, em texto simples. pode estar ausente
method.vol_usd_reported_24hstring—Nota sobre a fórmula de `vol_usd_reported_24h`, em texto simples. pode estar ausente
metaobject—Linhagem e atualidade desta resposta.
meta.schemastring—ID do esquema desta resposta. Só muda quando um campo existente muda de significado ou de tipo.
meta.sourcearray—Endpoints públicos de origem dos quais os dados foram coletados.
meta.source[]object—Endpoints públicos de origem dos quais os dados foram coletados.
meta.source[].exchangestring—ID da corretora (em minúsculas).
meta.source[].endpointstring—Endpoint público da fonte que o coletor lê (exibido para fins de linhagem; os clientes nunca o chamam).
meta.observed_atnumber|nullmsTimestamp informado pela fonte para os dados.
meta.received_atnumber|nullmsHorário em que o coletor da CoinBoss recebeu os dados.
meta.fetched_atnumbermsHorário em que esta resposta foi montada.
meta.windowstring—Janela de tempo coberta pelos números.
meta.qualitystring—FRESH, PARTIAL, STALE, BROKEN ou UNAVAILABLE, avaliado a partir dos timestamps dos dados e da cobertura.
meta.is_staleboolean—True quando os dados são mais antigos que sua janela de atualidade.
meta.cache_ttl_snumbersTempo de vida do cache desta resposta.
meta.fallbackstring—O que o endpoint retorna quando o coletor ou uma fonte falha.

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

Exemplo de resposta

/api/sd/options/overview?coin=BTC · Resposta real capturada 2026-11-13 03:58:21 UTC. Arrays e mapas longos são encurtados para exibição: exchanges tinha 6 itens; meta.source tinha 6 itens; term_structure tinha 12 itens; coverage.field_gaps tinha 4 itens; coverage.unavailable tinha 12 itens; coverage.stale_included tinha 6 itens.

  • {
    • "success": true,
    • "schema": "coinboss.sd.options/1",
    • "now": 1794542301260,
    • "coin": "BTC",
    • "index_price": 71498.15576087,
    • "n_contracts": 5792,
    • "oi_usd": 32670143083.84,
    • "call_oi_usd": 18276964561.96,
    • "put_oi_usd": 14393178521.88,
    • "oi_coin": 457419.65,
    • "call_oi_coin": 255899.54,
    • "put_oi_coin": 201520.11,
    • "vol_usd_24h": 4295495191.7,
    • "call_vol_usd_24h": 2031780368.24,
    • "put_vol_usd_24h": 2263714823.46,
    • "vol_coin_24h": 60122.56,
    • "call_vol_coin_24h": 28436.77,
    • "put_vol_coin_24h": 31685.79,
    • "vol_premium_usd_24h": 34033631.12,
    • "pcr_oi": 0.7875,
    • "pcr_vol": 1.1143,
    • "n_expiries": 12,
    • "vol_exchanges": [
      • "binance",
      • "bybit",
      • "coincall",
      • "deribit",
      • "gate",
      • "okx"
      ],
    • "vol_premium_exchanges": [
      • "binance",
      • "deribit",
      • "gate"
      ],
    • "max_pain_nearest": {
      • "expiry": "2026-11-13",
      • "days_left": 0.1678,
      • "strike": 75000,
      • "pain_usd": 15831410,
      • "oi_usd": 3892192707.39,
      • "exchanges": [ … 6 ]
      },
    • "max_pain_main": {
      • "expiry": "2026-11-13",
      • "days_left": 0.1678,
      • "strike": 75000,
      • "pain_usd": 15831410,
      • "oi_usd": 3892192707.39,
      • "exchanges": [ … 6 ]
      },
    • "atm_iv_nearest": 40.28,
    • "atm_iv_main": 40.28,
    • "atm_iv_30d": 37.2,
    • "skew_25d_main": 6.6,
    • "term_structure": [
      • { … 4 },
      • { … 4 }
      ],
    • "exchanges": [
      • { … 28 },
      • { … 28 }
      ],
    • "coverage": {
      • "included_exchanges": [ … 6 ],
      • "unavailable": [ … 2 ],
      • "stale_excluded": [],
      • "field_gaps": [ … 2 ],
      • "stale_included": [ … 2 ]
      },
    • "method": {
      • "oi_usd": "sum over contracts of oi_coin x that exchange's spot index price (USDT/USDC treated 1:1 as USD); oi_coin is open interest in units of the underlying coin after …",
      • "vol_usd_24h": "NOTIONAL 24h volume = sum of vol_coin (24h traded quantity in underlying coin) x the exchange's CURRENT spot index price; not premium turnover. Binance statisti…",
      • "vol_premium_usd_24h": "PREMIUM turnover (option price x quantity) as reported by the exchange: Deribit volume_usd, Binance amount, Gate sum(|size| x multiplier x price) from the 24h t…",
      • "pcr_oi": "put open interest / call open interest, both in underlying-coin units; null when call side is 0 or missing",
      • "pcr_vol": "put 24h volume / call 24h volume, both in underlying-coin units; null when call side is 0 or missing",
      • "max_pain": "per expiry: settlement price S among strikes with OI>0 minimizing pain_usd(S) = sum_calls oi_coin x max(S-K,0) + sum_puts oi_coin x max(K-S,0); ties take the lo…",
      • "atm_iv": "per exchange and expiry: reference price F = median of the exchange-published forward/underlying price of that expiry (the exchange index price where no forward…",
      • "atm_iv_30d": "30-day constant-maturity ATM IV: linear interpolation in days between the two expiries bracketing 30 days; null when 30 days is not bracketed",
      • "skew_25d": "IV(put with delta closest to -0.25, within +-0.10) - IV(call with delta closest to +0.25, within +-0.10), in percentage points, using exchange-published deltas …",
      • "oi_share_pct": "exchange oi_usd / sum of oi_usd over included exchanges x 100",
      • "index_price": "median of the included exchanges' own spot index prices",
      • "max_pain_main": "main expiry = nearest expiry holding >=5% of total OI notional (same rule as legacy /api/options/overview); max_pain_nearest = nearest listed expiry with OI",
      • "oi_usd_reported": "sum of the exchange's own USD figure where it publishes one (Binance sumOpenInterestUsd, OKX oiUsd), for cross-checking only; null elsewhere",
      • "vol_usd_reported_24h": "exchange-reported notional turnover where published (Bybit turnover24h), for cross-checking only; null elsewhere"
      },
    • "meta": {
      • "schema": "coinboss.sd.options/1",
      • "source": [ … 2 ],
      • "observed_at": 1794522472654,
      • "received_at": 1794522473814,
      • "fetched_at": 1794542301260,
      • "window": "latest",
      • "quality": "STALE",
      • "is_stale": true,
      • "cache_ttl_s": 60,
      • "fallback": "on collector failure the last stored rows are served: an exchange whose newest batch is older than 25 min (collector cycle is 10 min) is excluded from totals (l…"
      }
    }

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=ETH20066 msAprovado STALE
coin=SOL20022 msAprovado STALE
coin=PEPE2002 msAprovado UNAVAILABLE
—4001 msAprovado retorna o erro esperado

Verificado 2026-11-13 03:28:18 UTC

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
60s
Microcache de borda
10s
Frequência de atualização
Rodada do coletor a cada 10 minutos; uma corretora é considerada atualizada por 25 minutos após sua última rodada bem-sucedida.
Janela
Snapshot mais recente; os campos de volume cobrem as últimas 24 horas, conforme reportado por cada corretora.
Fontes de dados
Endpoints REST públicos de opções de Deribit, Binance, Bybit, OKX, Gate e Coincall, coletados e armazenados pela CoinBoss (sd_opt_latest, sd_opt_summary_hourly). Nenhum agregador terceiro está envolvido.
Cobertura de corretoras
Seis corretoras de opções. Uma moeda sem opções listadas nas corretoras selecionadas retorna HTTP 200 com campos nulos, `meta.quality = "UNAVAILABLE"` e o motivo em `coverage.unavailable`. As corretoras sem feed público de opções também são listadas ali.
Unidades
USD notional = contracts × contract size × spot index price of the venue. `*_coin` fields are in units of the underlying coin. Implied volatility is in percent (55 = 55 %). `vol_premium_usd_24h` is premium turnover, reported separately and never added to notional volume.
Método
pcr_oi = put OI ÷ call OI (coin units). Max pain = the strike that minimises the total intrinsic value paid to option holders at expiry. ATM IV = mean mark IV of the contracts at the strike closest to the forward price published by the venue for that expiry; `atm_iv_30d` is interpolated linearly between the two expiries that bracket 30 days. skew_25d = IV(put with delta closest to −0.25) − IV(call with delta closest to +0.25), in percentage points, using deltas published by the venues only.
Timestamps
Milissegundos da época Unix (UTC), salvo se a descrição do campo indicar o contrário
Formato da resposta
json
Estabilidade
Estável
Disponível desde
2026-11-11

Status ao vivo

DegradadoVerificado 2026-11-13 03:52:55 UTCHTTP 20057 msEsquema confereDado mais recente: há 5.4h

O endpoint reporta qualidade dos dados STALE

Disponibilidade, últimos 30 dias

100% de 407 verificações aprovadas

Divergência de esquema detectada pela última sondagem
  • Retornado, mas não documentado: coverage.stale_included, coverage.stale_included[], coverage.stale_included[].exchange, coverage.stale_included[].age_s

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/sd/options/overviewDegradado
Parâmetros

string — Coin symbol, case-insensitive (for example `BTC`). Missing or malformed values return 400.

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