/api/oi/summary
GETDisponível

Resumo de contratos em aberto de uma moeda

Resumo de contratos em aberto de uma moeda (OI por corretora e variações)

GET/api/oi/summary

Requisição

Parâmetros de consulta

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

Exemplo de requisição

curl -s "https://www.coinboss.com/api/oi/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).
pricenumber—Último preço na moeda de cotação (USD ou USDT, salvo indicação em contrário).
total_usdnumberUSDTotal.
total_change_24h_pctnumber%Variação de 24h do total de contratos em aberto: corretoras presentes agora e no snapshot horário mais próximo de 24 horas atrás, (Σ atual − Σ anterior) ÷ Σ anterior.
total_change_24h_basisobject—Entradas de `total_change_24h_pct`: corretoras pareadas, hora da linha de base, contratos excluídos por linha de base congelada e o nome da regra; null quando nenhuma variação está disponível.
total_change_24h_basis.n_matchednumber—Itens presentes nas duas pontas da comparação.
total_change_24h_basis.prev_hour_tsnumbermsInício do bucket da hora anterior.
total_change_24h_basis.frozen_excludedobject—Linhas excluídas porque o valor da fonte não se moveu.
total_change_24h_basis.frozen_excluded.n_baselinenumber—Itens no snapshot de base.
total_change_24h_basis.frozen_excluded.n_currentnumber—Itens no snapshot atual.
total_change_24h_basis.frozen_excluded.cur_usdnumberUSDValor atual.
total_change_24h_basis.frozen_excluded.prev_usdnumberUSDValor de base.
total_change_24h_basis.rulestring—Nome da regra de comparação; sempre `same_exchange_pairing_nearest_hour_excl_frozen_baseline`.
exchange_countnumber—Número de corretoras.
dataarray—Conteúdo da resposta.
data[]object—Conteúdo da resposta.
data[].exchangestring—ID da corretora, em minúsculas (por exemplo, `binance`).
data[].oi_usdnumberUSDContratos em aberto em valor nocional em USD.
data[].share_pctnumber%Participação no total.
data[].change_24h_pctnumber|null%Variação percentual em 24h.
data[].change_4h_pctnumber|null%Variação dos contratos em aberto da corretora em relação ao seu snapshot horário mais próximo de 4 horas atrás; sempre null para a CME, que publica diariamente.
data[].is_dailyboolean—Presente e true somente na linha da CME, cujos contratos em aberto são publicados uma vez por dia de negociação; ausente nas demais linhas. pode estar ausente

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

Exemplo de resposta

/api/oi/summary?coin=BTC · Resposta real capturada 2026-11-13 03:57:41 UTC. Arrays e mapas longos são encurtados para exibição: data tinha 22 itens.

  • {
    • "success": true,
    • "coin": "BTC",
    • "price": 68907.3,
    • "total_usd": 49032953661.26,
    • "total_change_24h_pct": -3.57,
    • "total_change_24h_basis": {
      • "n_matched": 22,
      • "prev_hour_ts": 1794456000000,
      • "frozen_excluded": { … 4 },
      • "rule": "same_exchange_pairing_nearest_hour_excl_frozen_baseline"
      },
    • "exchange_count": 22,
    • "data": [
      • { … 5 },
      • { … 5 }
      ]
    }

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=ETH20036 msAprovado
coin=SOL20022 msAprovado
coin=ARKM20022 msAprovado

Verificado 2026-11-13 03:57:41 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
a cada 60 s para a maioria das corretoras (gravado junto com os tickers; jobs dedicados de 60 s para o top 50 da binance e para a okx); varreduras completas de binance / bingx / aster / gate / htx a cada 5 min; contratos com margem em cripto / USDC / com vencimento a cada 120 s (promovidos à tabela compartilhada a cada 5 min); cme uma vez por dia de negociação (04:10 UTC)
Janela
snapshot mais recente; variações em relação aos buckets horários mais próximos de agora - 24 h e agora - 4 h (dentro de +/- 1 h)
Fontes de dados
Contratos em aberto consultados por coletores internos nas APIs REST públicas de 22 corretoras de derivativos (p. ex., binance, okx, bybit, gate, bitget, hyperliquid), mais o relatório diário oficial de volume/contratos em aberto da CME.
Cobertura de corretoras
23 fontes com linhas atualizadas (22 corretoras + cme); todos os tipos de contrato (lineares USDT / USDC / USD, inversos com margem em cripto, perpétuos e com vencimento); bybit e gate reportam contratos em aberto bilaterais, conforme divulgado pela corretora; linhas com mais de 3 h (cme: 120 h) são excluídas
Ordenação
ordem fixa de corretoras (binance, cme, okx, bybit, bitget, gate, htx, ...), depois alfabética
Unidades
oi_usd in USD notional; share_pct / change_*_pct in percent; price in USD
Método
per exchange: oi_usd = SUM over fresh contracts of the coin; share_pct = oi_usd / total x 100; change = (cur - prev) / prev x 100 with same-contract pairing (frozen baselines excluded); total_change_24h_pct = same-exchange paired change across all exchanges; cme compared with its previous published value and has no 4 h change
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:57:41 UTCHTTP 20034 msEsquema confere

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/oi/summaryDisponível
Parâmetros

string · padrão BTC — Base coin symbol (uppercase, e.g. BTC).

URL da requisiçãohttps://www.coinboss.com/api/oi/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.