Visão geral de opções
Visão geral de opções (OI, volume, put/call, vencimento mais próximo)
/api/options/overviewRequisição
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Padrão | Valores aceitos | Descrição |
|---|---|---|---|---|---|
| currency | string | Opcional | BTC | BTC, ETH | Ativo subjacente: `BTC` ou `ETH`. Qualquer outro valor retorna 400 `INVALID_PARAM`. Alias: `coin`. Exemplo: BTC |
Exemplo de requisição
curl -s "https://www.coinboss.com/api/options/overview?currency=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.
| Campo | Tipo | Unidade | Descrição |
|---|---|---|---|
| success | boolean | — | true quando a requisição foi bem-sucedida. Em caso de falha, o corpo é `{ success: false, code, error, request_id }`. |
| currency | string | — | Símbolo da moeda / do ativo. |
| snap_ts | number | ms | Horário do snapshot. |
| index_price | number | — | Preço do índice do subjacente. |
| data | object | — | Conteúdo da resposta. |
| data.total_oi_usd | number | USD | Total de contratos em aberto. |
| data.total_oi_coins | number | coin | Total de contratos em aberto de todas as opções da Deribit sobre a moeda, em unidades da moeda subjacente. |
| data.volume_24h_usd | number | USD | Volume de opções de 24 horas em USD, conforme reportado pela Deribit; trata-se de giro de prêmios, e não de valor nocional, por isso fica muito abaixo de `volume_24h_coins` × preço. |
| data.volume_24h_coins | number | coin | Volume negociado em 24 horas de todas as opções da Deribit sobre a moeda, em unidades da moeda subjacente. |
| data.pcr_oi | number | ratio | Razão put/call por contratos em aberto: contratos em aberto de puts ÷ contratos em aberto de calls, ambos em unidades da moeda; null quando não há contratos em aberto de calls. |
| data.pcr_volume | number | ratio | Razão put/call por volume: volume de puts de 24 horas ÷ volume de calls de 24 horas, ambos em unidades da moeda; null quando não há volume de calls. |
| data.max_pain | object | — | Strike no qual os titulares de opções mais perdem no vencimento. |
| data.max_pain.expiry | string | — | Data de vencimento da série de opções. |
| data.max_pain.price | number | — | Último preço na moeda de cotação (USD ou USDT, salvo indicação em contrário). |
| data.contracts | number | — | Linhas por contrato. |
| data.expiries | number | — | Vencimentos de opções / futuros. |
Gerada 2026-11-11 23:00 UTC a partir de 2 respostas reais.
Exemplo de resposta
/api/options/overview?currency=BTC · Resposta real capturada 2026-11-13 03:58:25 UTC.
- "success"true
- "currency""BTC"
- "snap_ts"1794541801732
- "index_price"69009.96
- "data"
- "total_oi_usd"24978601771.99
- "total_oi_coins"358629.9
- "volume_24h_usd"46910595.32
- "volume_24h_coins"36010
- "pcr_oi"0.7462
- "pcr_volume"1.6655
- "max_pain"
- "contracts"960
- "expiries"12
Amostras verificadas
Além do exemplo acima, a sonda chama este endpoint com estes parâmetros e verifica o esquema a cada vez.
| Parâmetros | HTTP | Latência | Resultado |
|---|---|---|---|
| currency=ETH | 200 | 3 ms | Aprovado |
| currency=SOL | 400 | 1 ms | Aprovado retorna o erro esperado |
Verificado 2026-11-13 03:58:25 UTC
Detalhes
- Autenticação
- Nenhuma. Endpoint público.
- Limite de requisições
- 1200 requisições por minuto por IP
- Cache do servidor
- 2m
- Microcache de borda
- 10s
- Frequência de atualização
- a cada 10 min (substituição completa do snapshot)
- Janela
- snapshot mais recente (volume de 24h conforme reportado pela corretora)
- Fontes de dados
- Totais do mercado de opções agregados a partir da API pública de uma única corretora (Deribit).
- Cobertura de corretoras
- Somente Deribit, opções de BTC e ETH; outras corretoras (opções de Binance/OKX/Bybit, CME) não estão incluídas.
- Unidades
- USD notional and coins (open interest, volume); ratios; USD strike (max pain)
- Método
- Sums over all contracts; pcr_oi = put OI / call OI (in coins); max pain = strike minimizing total option-holder payoff for the main expiry (nearest expiry holding >=5% of total OI, else the largest).
- 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
Disponibilidade, últimos 30 dias
99.76% de 409 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ódigo | HTTP | Significado | O que fazer |
|---|---|---|---|
| INVALID_PARAM | 400 | Falta 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. |
| UNAUTHORIZED | 401 | O 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. |
| FORBIDDEN | 403 | A rota não faz parte da API pública (é interna ou exclusiva de conta). | Não tente novamente. |
| NOT_FOUND | 404 | Rota desconhecida, ou a moeda / corretora / fundo solicitado não existe. | Não tente novamente; confira o caminho e os identificadores no catálogo. |
| RATE_LIMITED | 429 | Mais 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. |
| INTERNAL | 500 | Erro 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_FAILED | 503 | A 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. |
| UNAVAILABLE | 501 / 503 | O 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_FAILED | 200 | Alguns 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
/api/options/overviewDisponívelstring · padrão BTC — Underlying: `BTC` or `ETH`. Any other value returns 400 `INVALID_PARAM`. Alias: `coin`.
https://www.coinboss.com/api/options/overview?currency=BTCMais nesta categoria
- Cadeia de opções (uma corretora) /api/sd/options/chain
- Opções por vencimento /api/sd/options/expiries
- Histórico de opções (horário) /api/sd/options/history
- Visão geral de opções (todas as corretoras) /api/sd/options/overview
- Opções por strike /api/sd/options/strikes
- Resumo de opções da página da moeda /api/currency/options-summary
- Sorriso / estrutura a termo da volatilidade implícita de opções /api/options/iv
- Histórico da volatilidade implícita de opções /api/options/iv-history
- Max pain de opções /api/options/max-pain
- OI de opções por vencimento /api/options/oi-by-expiry
- OI de opções por strike /api/options/oi-by-strike
- Visão geral de opções /api/options/overview
- Distribuição do volume de opções /api/options/volume-dist