Volume 24h—Contratos em aberto—Liquidações 24h$1.36BLong/Short 24h—Dominância BTC—Dominância ETH—
App
Idioma ▾
R$ BRL ▾
/api/currency/overview
GETDisponível

Visão geral detalhada da moeda

Visão geral detalhada da moeda (preço, capitalização de mercado, oferta, resumo de derivativos)

GET/api/currency/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/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 }`.
dataobject—Conteúdo da resposta.
data.coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC).
data.supplyobject—Oferta, em moedas.
data.supply.price_usdstring(decimal)USDPreço.
data.supply.market_cap_usdstring(decimal)USDCapitalização de mercado.
data.supply.mcap_ranknumber—Posição por capitalização de mercado.
data.supply.vol_24h_usdstring(decimal)USDVolume de 24h.
data.supply.circulatingstring(decimal)—Oferta em circulação, em moedas.
data.supply.total_supplystring(decimal)—Oferta total, em moedas.
data.supply.max_supplystring(decimal)|null—Oferta máxima, em moedas; null quando ilimitada ou desconhecida.
data.supply.change_24h_pctstring(decimal)%Variação percentual em 24h.
data.supply.image_urlstring—Caminho do ícone, de mesma origem, servido pela CoinBoss; null quando não existe ícone verificado.
data.supply.website_urlstring—Site oficial do projeto, obtido dos metadados da moeda.
data.supply.reddit_urlstring|null—Subreddit do projeto; null quando nenhum está listado.
data.supply.github_urlstring|null—Repositório principal de código-fonte do projeto; null quando nenhum está listado.
data.supply.whitepaper_urlstring—Link para o whitepaper do projeto.
data.supply.explorer_urlstring—Link para um explorador de blocos da moeda.
data.supply.categorystring—Categoria.
data.supply.asofnumbermsHorário do dado mais recente utilizado.
data.supply.staleboolean—Linhas ou indicador referentes a dados mais antigos que a janela de atualidade.
data.supply.spot_vol_usdnumberUSDSoma do volume spot de 24h da moeda nas corretoras spot que a própria CoinBoss coleta (snapshot mais recente); null quando não coletado.
data.supply.futures_vol_usdnumberUSDSoma do volume de futuros de 24h em todas as corretoras com ticker mais recente que 1 hora, mesmo valor de `futures_vol.total_usd`; null sem dados próprios.
data.supply.oi_total_usdnumberUSDContratos em aberto agregados da moeda em todas as corretoras e tipos de contrato, mesmo valor de `oi.total_usd`; null sem dados próprios.
data.supply.high_24hstring(decimal)—Máxima de 24h.
data.supply.low_24hstring(decimal)—Mínima de 24h.
data.futures_vol_chg_pctnumber%Variação de 24h do volume de futuros: corretoras presentes agora e no snapshot horário de cerca de 24 horas atrás, (Σ atual − Σ anterior) ÷ Σ anterior.
data.oi_chg_pctnumber%Variação de 24h dos contratos em aberto calculada sobre os contratos presentes tanto agora quanto no snapshot horário mais próximo de 24 horas atrás.
data.oiobject—Contratos em aberto.
data.oi.total_usdnumberUSDTotal.
data.oi.local_usdnumberUSDContratos em aberto somados a partir da coleta própria da CoinBoss por corretora; idêntico a `oi.total_usd`.
data.oi.by_exchangearray—Detalhamento por corretora.
data.oi.by_exchange[]object—Detalhamento por corretora.
data.oi.by_exchange[].exchangestring—ID da corretora, em minúsculas (por exemplo, `binance`).
data.oi.by_exchange[].oi_usdnumberUSDContratos em aberto em valor nocional em USD.
data.oi.n_exchangesnumber—Número de corretoras que contribuem.
data.oi.asofnumbermsHorário do dado mais recente utilizado.
data.oi.chg_basisobject—Entradas de `oi_chg_pct`: somas atual e anterior pareadas (`cur`, `prev`), número de corretoras pareadas, hora da linha de base e contratos congelados excluídos.
data.oi.chg_basis.curnumber—Valor atual.
data.oi.chg_basis.prevnumber—Valor anterior (linha de base).
data.oi.chg_basis.n_matchednumber—Itens presentes nas duas pontas da comparação.
data.oi.chg_basis.prev_hour_tsnumbermsInício do bucket da hora anterior.
data.oi.chg_basis.frozen_excludedobject—Linhas excluídas porque o valor da fonte não se moveu.
data.oi.chg_basis.frozen_excluded.n_baselinenumber—Itens no snapshot de base.
data.oi.chg_basis.frozen_excluded.n_currentnumber—Itens no snapshot atual.
data.oi.chg_basis.frozen_excluded.cur_usdnumberUSDValor atual.
data.oi.chg_basis.frozen_excluded.prev_usdnumberUSDValor de base.
data.futures_volobject—Volume de futuros.
data.futures_vol.total_usdnumberUSDTotal.
data.futures_vol.n_exchangesnumber—Número de corretoras que contribuem.
data.futures_vol.chg_basisobject—Entradas de `futures_vol_chg_pct`: somas de volume atual e anterior pareadas (`cur`, `prev`), número de corretoras pareadas e hora da linha de base.
data.futures_vol.chg_basis.curnumber—Valor atual.
data.futures_vol.chg_basis.prevnumber—Valor anterior (linha de base).
data.futures_vol.chg_basis.n_matchednumber—Itens presentes nas duas pontas da comparação.
data.futures_vol.chg_basis.prev_hour_tsnumbermsInício do bucket da hora anterior.
data.fundingnumber—Bloco ou valor da taxa de financiamento.
data.funding_detailobject—Detalhamento por trás de `funding`: taxas normalizadas para 8h, simples e ponderada pelos contratos em aberto, taxa anualizada, contagens de corretoras e uma entrada por corretora.
data.funding_detail.basisstring—Preço dos futuros menos o preço spot, ou o bloco de base.
data.funding_detail.avg_8hnumber—Média das taxas normalizadas para 8h.
data.funding_detail.oi_weighted_8hnumber—Média das taxas normalizadas para 8h, ponderada pelos contratos em aberto.
data.funding_detail.apr_pctnumber% per yearPercentual anualizado.
data.funding_detail.n_exchangesnumber—Número de corretoras que contribuem.
data.funding_detail.n_normalizednumber—Corretoras normalizadas para 8h.
data.funding_detail.n_unknown_intervalnumber—Corretoras com intervalo de financiamento desconhecido.
data.funding_detail.by_exchangearray—Detalhamento por corretora.
data.funding_detail.by_exchange[]object—Detalhamento por corretora.
data.funding_detail.by_exchange[].exchangestring—ID da corretora, em minúsculas (por exemplo, `binance`).
data.funding_detail.by_exchange[].symbolstring—Símbolo do instrumento conforme normalizado pela CoinBoss (por exemplo, BTCUSDT).
data.funding_detail.by_exchange[].ratenumber—Taxa.
data.funding_detail.by_exchange[].interval_hnumberhIntervalo.
data.funding_detail.by_exchange[].rate_8hnumber—Taxa normalizada para um período de 8 horas.
data.funding_detail.by_exchange[].next_funding_timenumber|nullmsTimestamp.
data.long_shortobject—Bloco long/short.
data.long_short.longnumber—Valor do lado long.
data.long_short.shortnumber—Valor do lado short.
data.long_short.rationumber—Razão.
data.long_short.typestring—Tipo.
data.long_short.n_exchangesnumber—Número de corretoras que contribuem.
data.derivedobject—Indicadores da moeda recalculados periodicamente (RSI, base, contratos em aberto agregados, financiamento médio, participações long/short, liquidações de 24h); null quando não calculados.
data.derived.rsi_1hstring(decimal)—RSI(14) em candles de 1h.
data.derived.rsi_4hstring(decimal)—RSI(14) em candles de 4h.
data.derived.rsi_1dstring(decimal)—RSI(14) em candles diários.
data.derived.basis_pctstring(decimal)|null%(futuros − spot) / spot × 100.
data.derived.basis_annual_pctnull% per yearBase anualizada pelos dias até o vencimento.
data.derived.oi_usd_aggstring(decimal)USDContratos em aberto agregados em todas as corretoras e tipos de contrato na última atualização dos indicadores; pode ficar ligeiramente atrás de `oi.total_usd`.
data.derived.funding_avgstring(decimal)—Taxa de financiamento média entre corretoras.
data.derived.ls_accountstring(decimal)—Razão long/short por contas.
data.derived.ls_takerstring(decimal)|null—Razão compra/venda taker.
data.derived.liq_24h_usdstring(decimal)USDLiquidações em 24h.
data.liquidationobject—Bloco de liquidações. chaves dinâmicas: 1h,4h,12h,24h
data.liquidation.{*}object—Bloco de liquidações.
data.liquidation.{*}.winstring—Rótulo da janela da entrada, repetindo a sua chave (`1h`, `4h`, `12h` ou `24h`).
data.liquidation.{*}.long_usdnumberUSDLado long.
data.liquidation.{*}.short_usdnumberUSDLado short.
data.liquidation.{*}.total_usdnumberUSDTotal.
data.liquidation.{*}.cntnumber—Quantidade.

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

Exemplo de resposta

/api/currency/overview?coin=BTC · Resposta real capturada 2026-11-13 03:57:31 UTC. Arrays e mapas longos são encurtados para exibição: data.liquidation tinha 4 itens; data.oi.by_exchange tinha 22 itens; data.funding_detail.by_exchange tinha 23 itens.

  • {
    • "success": true,
    • "data": {
      • "coin": "BTC",
      • "supply": { … 22 },
      • "futures_vol_chg_pct": 67.76,
      • "oi_chg_pct": -3.65,
      • "oi": { … 6 },
      • "futures_vol": { … 3 },
      • "funding": 0.000057831612725940206,
      • "funding_detail": { … 8 },
      • "long_short": { … 5 },
      • "derived": { … 10 },
      • "liquidation": { … 2 }
      }
    }

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=ETH20086 msAprovado
coin=SOL20081 msAprovado
coin=ARKM20079 msAprovado

Verificado 2026-11-13 03:57:31 UTC

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
30s
Microcache de borda
10s
Frequência de atualização
agregador terceiro de dados de mercado a cada 10 min; tickers a cada 1 min; OI/financiamento/long-short a cada 5 min (moedas principais a cada 1 min); volume spot a cada 10 min; cache em memória de 30 s
Janela
24h móveis para volume/liquidações; snapshot mais recente para OI/financiamento/long-short
Fontes de dados
Oferta, capitalização de mercado e posição vêm do agregador terceiro de dados de mercado; preço, contratos em aberto, financiamento, long/short e volume de futuros e spot são agregados internamente a partir das APIs públicas das corretoras; as liquidações vêm dos fluxos de liquidação das corretoras.
Cobertura de corretoras
Qualquer moeda presente na tabela baseada no agregador terceiro de dados de mercado ou que tenha um contrato de derivativos listado
Paginação
nenhuma
Unidades
USD; rates as decimals; changes in percent
Método
OI = SUM(oi_usd) over fresh contracts incl. multiplier contracts (3h; CME 120h); funding = OI-weighted mean of rate normalized to 8h (rate * 8 / interval_hours)
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:31 UTCHTTP 20095 msEsquema confereDado mais recente: há 20s

Disponibilidade, últimos 30 dias

99.76% de 411 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/overviewDisponível
Parâmetros

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

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