/api/sd/liquidity/rank
GETParcialPARTIAL

Moedas classificadas pela profundidade do livro de ofertas

Moedas classificadas pela profundidade agregada do livro de ofertas (compra + venda) dentro de uma faixa, com o número de contratos incluídos e o spread mais estreito.

GET/api/sd/liquidity/rank

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
marketstringOpcionalperpperp, spotTipo de mercado. Os livros de perpétuos e spot nunca são somados.
bandstringOpcional10.5, 1, 2Distância em relação ao preço médio, em porcentagem.
limitintegerOpcional50≥ 1 · ≤ 200Número de linhas.

Exemplo de requisição

curl -s "https://www.coinboss.com/api/sd/liquidity/rank"

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.
marketstring—`perp` ou `spot`.
band_pctnumber%Faixa selecionada: distância em relação ao preço médio.
limitnumber—Limite de linhas aplicado.
total_coinsnumber—Moedas que têm pelo menos uma linha de livro de ofertas.
rowsarray—Uma linha por moeda.
rows[]object—Uma linha por moeda.
rows[].coinstring—Símbolo da moeda (em maiúsculas).
rows[].bid_depth_usdnumberUSDValor nocional das ordens de compra em espera entre o preço médio e a borda inferior da faixa. É um limite inferior quando `complete` é false.
rows[].ask_depth_usdnumberUSDValor nocional das ordens de venda em espera entre o preço médio e a borda superior da faixa. É um limite inferior quando `complete` é false.
rows[].total_depth_usdnumberUSDProfundidade de compra + profundidade de venda da faixa, usada apenas como chave de ranking.
rows[].n_includednumber—Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade.
rows[].n_freshnumber—Linhas atualizadas.
rows[].n_rowsnumber—Linhas encontradas, inclusive as desatualizadas.
rows[].mid_mediannumberUSDMediana do preço médio das linhas atualizadas.
rows[].spread_bps_minnumberbpSpread mais estreito entre as linhas atualizadas.
rows[].included_exchangesarray—Fontes cujos dados atualizados estão incluídos.
rows[].included_exchanges[]string—Fontes cujos dados atualizados estão incluídos.
rows[].uses_aggregated_bucketsboolean—True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior.
rows[].ranknumber—Posição no ranking; `null` quando a linha não tem valor para ranquear.
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. vazio nas amostras usadas para gerar esta tabela
coverage.stale_excludedarray—Linhas deixadas de fora porque sua última atualização está fora da janela de atualidade.
coverage.stale_excluded[]object—Linhas deixadas de fora porque sua última atualização está fora da janela de atualidade.
coverage.stale_excluded[].exchangestring—ID da corretora (em minúsculas).
coverage.stale_excluded[].age_snumbersSegundos desde que a linha foi recebida.
coverage.n_fresh_rowsnumber—Linhas atualizadas de todas as moedas.
coverage.n_stale_rowsnumber—Linhas desatualizadas de todas as moedas.
coverage.n_incomplete_rowsnumber—Linhas atualizadas cujo snapshot não alcança a borda da faixa.
methodobject—Descrição em texto simples das fórmulas usadas nesta resposta, uma entrada por campo.
method.bid_depth_usdstring—Nota sobre a fórmula de `bid_depth_usd`, em texto simples.
method.ask_depth_usdstring—Nota sobre a fórmula de `ask_depth_usd`, em texto simples.
method.completestring—Nota sobre a fórmula de `complete`, em texto simples.
method.aggregatestring—Nota sobre a fórmula de `aggregate`, em texto simples.
method.freshstring—Nota sobre a fórmula de `fresh`, em texto simples.
method.rankstring—Nota sobre a fórmula de `rank`, em texto simples.
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[].marketstring—`perp` ou `spot`.
meta.source[].endpointstring—Endpoint público da fonte que o coletor lê (exibido para fins de linhagem; os clientes nunca o chamam).
meta.observed_atnumbermsTimestamp informado pela fonte para os dados.
meta.received_atnumbermsHorá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.
meta.collector_heartbeat_age_snumbersSegundos desde que o coletor informou pela última vez que está em execução.

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

Exemplo de resposta

/api/sd/liquidity/rank · Resposta real capturada 2026-11-13 04:02:46 UTC. Arrays e mapas longos são encurtados para exibição: rows tinha 50 itens; meta.source tinha 23 itens; coverage.stale_excluded tinha 23 itens; rows[].included_exchanges tinha 19 itens; coverage.included_exchanges tinha 23 itens.

  • {
    • "success": true,
    • "schema": "coinboss.sd.liquidity/1",
    • "now": 1794542566023,
    • "market": "perp",
    • "band_pct": 1,
    • "limit": 50,
    • "total_coins": 89,
    • "rows": [
      • { … 12 },
      • { … 12 }
      ],
    • "coverage": {
      • "included_exchanges": [ … 8 ],
      • "unavailable": [],
      • "stale_excluded": [ … 2 ],
      • "n_fresh_rows": 1481,
      • "n_stale_rows": 82,
      • "n_incomplete_rows": 8
      },
    • "method": {
      • "bid_depth_usd": "sum of resting bid notional with price >= mid * (1 - band%), in USD; notional = price * size * contract_value (inverse contracts: size * contract_value); USDT /…",
      • "ask_depth_usd": "sum of resting ask notional with price <= mid * (1 + band%), in USD; same notional rule as bid_depth_usd",
      • "complete": "true when BOTH sides of the snapshot reach the band edge (reach_pct >= band) or the whole side of the book was returned; when false the depth values are lower b…",
      • "aggregate": "per market and band: sum over rows that are fresh AND complete for that band; n_included / n_fresh is the denominator; lower_bound_* additionally adds the incom…",
      • "fresh": "a row is fresh when now - received_at <= max(3 * period_s, 300s); stale rows are listed in coverage.stale_excluded; rows older than 24h are dropped",
      • "rank": "coins ordered by bid_depth_usd + ask_depth_usd of the chosen market and band, aggregated as in aggregate; coins with no fresh complete row carry nulls and sort …"
      },
    • "meta": {
      • "schema": "coinboss.sd.liquidity/1",
      • "source": [ … 2 ],
      • "observed_at": 1794542565862,
      • "received_at": 1794542565977,
      • "fetched_at": 1794542566023,
      • "window": "latest",
      • "quality": "PARTIAL",
      • "is_stale": false,
      • "cache_ttl_s": 30,
      • "fallback": "stale rows (older than max(3 * period_s, 300s)) are left out; coins whose rows are all stale or incomplete keep their place in the list with null depth",
      • "collector_heartbeat_age_s": 4
      }
    }

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
market=spot2005 msAprovado PARTIAL
band=0.5&limit=102007 msAprovado PARTIAL
limit=04002 msAprovado retorna o erro esperado

Verificado 2026-11-13 03:58:06 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
O mesmo ciclo de coleta de `/api/sd/liquidity`.
Janela
Snapshot mais recente por contrato.
Fontes de dados
Snapshots públicos REST do livro de ofertas de 24 corretoras (mercados perpétuos e spot), coletados e armazenados pela CoinBoss (sd_book_latest, sd_book_hist). A profundidade e o slippage são calculados pela CoinBoss a partir dos níveis de preço brutos.
Cobertura de corretoras
24 corretoras, 38 combinações corretora × mercado. Quando um snapshot público não alcança ±0.5 / 1 / 2 % do preço médio (limite de níveis da corretora), essa faixa é marcada com `complete: false`, seu valor é um limite inferior e ela fica fora do agregado; `n_included` / `n_fresh` dão o denominador e `excluded_incomplete` lista o que ficou de fora.
Paginação
Sem paginação; `limit` limita o número de linhas (máx. 200).
Ordenação
`total_depth_usd` decrescente; moedas sem nenhuma linha completa e atualizada vêm por último, com `rank: null`.
Unidades
Depth in USD notional, bid and ask side reported separately and never added. Spread and slippage in basis points (1 bp = 0.01 %). USDT / USDC / USD quotes are counted 1:1 as USD.
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

ParcialVerificado 2026-11-13 04:02:46 UTCHTTP 2009 msEsquema confereDado mais recente: há 0s

O endpoint reporta qualidade dos dados PARTIAL

Disponibilidade, últimos 30 dias

100% de 408 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/sd/liquidity/rankParcial
Parâmetros

string · padrão perp — Market type. Perpetual and spot books are never added together.

string · padrão 1 — Distance from mid price in percent.

integer · padrão 50 · mín. 1 · máx. 200 — Number of rows.

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