GETParcialPARTIAL
Profundidade do livro de ofertas e slippage
Profundidade do livro de ofertas por corretora dentro de ±0.5 / 1 / 2 % do preço médio, spread e slippage de uma ordem a mercado de 10k / 100k / 1M USD, além de um agregado por tipo de mercado com o respectivo denominador.
GET
/api/sd/liquidityCobertura parcial. Para as moedas mais líquidas, os snapshots públicos de várias grandes corretoras não alcançam a faixa completa, por isso essas corretoras são excluídas do agregado e o agregado subestima a profundidade total. Os campos `lower_bound_*` acrescentam a parte que foi observada. Leia sempre `n_included` junto com o valor da profundidade.
Requisição
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Padrão | Valores aceitos | Descrição |
|---|---|---|---|---|---|
| coin | string | Obrigató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 |
| market | string | Opcional | all | perp, spot, all | Tipo de mercado. Os livros de perpétuos e spot nunca são somados. |
Exemplo de requisição
curl -s "https://www.coinboss.com/api/sd/liquidity?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.
| 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 }`. |
| schema | string | — | ID do esquema desta resposta. Só muda quando um campo existente muda de significado ou de tipo. |
| now | number | ms | Horário do servidor em que a resposta foi montada. |
| coin | string | — | Símbolo da moeda (em maiúsculas). |
| market | string | — | `perp` ou `spot`. |
| venues | array | — | Uma linha por corretora × mercado × contrato. |
| venues[] | object | — | Uma linha por corretora × mercado × contrato. |
| venues[].exchange | string | — | ID da corretora (em minúsculas). |
| venues[].market | string | — | `perp` ou `spot`. |
| venues[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. |
| venues[].quote | string | — | Moeda de cotação do mercado; USDT, USDC e USD são contabilizados 1:1 como USD. |
| venues[].multiplier | number | — | Moedas por unidade cotada (1000 para contratos do tipo `1000PEPE`). Os preços já estão divididos por esse valor. |
| venues[].contract_value | number | — | Tamanho de um contrato: moedas nos contratos lineares, USD nos contratos inversos. |
| venues[].inverse | boolean | — | True para contratos com margem em cripto cotados em USD por contrato. |
| venues[].mid | number | USD | (melhor compra + melhor venda) ÷ 2, preço de uma moeda. |
| venues[].best_bid | number | USD | Melhor preço de compra (bid) de uma moeda. |
| venues[].best_ask | number | USD | Melhor preço de venda (ask) de uma moeda. |
| venues[].spread_bps | number | bp | (melhor preço de venda − melhor preço de compra) ÷ preço médio. |
| venues[].n_bids | number | — | Níveis de preço de compra no snapshot. |
| venues[].n_asks | number | — | Níveis de preço de venda no snapshot. |
| venues[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. |
| venues[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. |
| venues[].book_complete_bid | boolean | — | True quando todo o lado de compra do livro foi retornado. |
| venues[].book_complete_ask | boolean | — | True quando todo o lado de venda do livro foi retornado. |
| venues[].bands | object | — | Profundidade por faixa; as chaves `0.5`, `1` e `2` são a distância em relação ao preço médio, em porcentagem. |
| venues[].bands.1 | object | — | Faixa a esta distância do preço médio, em porcentagem. |
| venues[].bands.1.bid_depth_usd | number | USD | Valor 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. |
| venues[].bands.1.ask_depth_usd | number | USD | Valor 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. |
| venues[].bands.1.complete | boolean | — | True quando os dois lados do snapshot alcançam a borda da faixa. Linhas incompletas ficam fora dos agregados. |
| venues[].bands.2 | object | — | Faixa a esta distância do preço médio, em porcentagem. |
| venues[].bands.2.bid_depth_usd | number | USD | Valor 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. |
| venues[].bands.2.ask_depth_usd | number | USD | Valor 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. |
| venues[].bands.2.complete | boolean | — | True quando os dois lados do snapshot alcançam a borda da faixa. Linhas incompletas ficam fora dos agregados. |
| venues[].bands.0.5 | object | — | Faixa a esta distância do preço médio, em porcentagem. |
| venues[].bands.0.5.bid_depth_usd | number | USD | Valor 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. |
| venues[].bands.0.5.ask_depth_usd | number | USD | Valor 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. |
| venues[].bands.0.5.complete | boolean | — | True quando os dois lados do snapshot alcançam a borda da faixa. Linhas incompletas ficam fora dos agregados. |
| venues[].slippage | object | — | Slippage de uma ordem a mercado; as chaves `10000`, `100000` e `1000000` são o tamanho da ordem em USD. |
| venues[].slippage.10000 | object | — | Ordem a mercado deste tamanho em USD. |
| venues[].slippage.10000.buy_bps | number | bp | Média do preço de execução de uma compra a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.10000.sell_bps | number|null | bp | Média do preço de execução de uma venda a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.10000.buy_flag | null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].slippage.10000.sell_flag | string|null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].slippage.100000 | object | — | Ordem a mercado deste tamanho em USD. |
| venues[].slippage.100000.buy_bps | number|null | bp | Média do preço de execução de uma compra a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.100000.sell_bps | number|null | bp | Média do preço de execução de uma venda a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.100000.buy_flag | string|null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].slippage.100000.sell_flag | string|null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].slippage.1000000 | object | — | Ordem a mercado deste tamanho em USD. |
| venues[].slippage.1000000.buy_bps | number|null | bp | Média do preço de execução de uma compra a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.1000000.sell_bps | number|null | bp | Média do preço de execução de uma venda a mercado em relação ao preço médio (inclui metade do spread); `null` quando o snapshot não consegue executar a ordem. |
| venues[].slippage.1000000.buy_flag | string|null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].slippage.1000000.sell_flag | string|null | — | `insufficient_book` quando a ordem não pode ser executada com o snapshot, `upper_bound` quando foi usado um bucket agregado; caso contrário, `null`. |
| venues[].book_bid_usd | number | USD | Valor nocional de todas as ordens de compra contidas no snapshot. |
| venues[].book_ask_usd | number | USD | Valor nocional de todas as ordens de venda contidas no snapshot. |
| venues[].agg_step_bps | number|null | bp | Bucket de agregação de preços mais largo usado dentro de ±2 %; `null` quando apenas níveis brutos foram usados. |
| venues[].layers | number | — | Número de snapshots unidos para compor esta linha. |
| venues[].observed_at | number|null | ms | Timestamp informado pela fonte para os dados. |
| venues[].received_at | number | ms | Horário em que o coletor da CoinBoss recebeu os dados. |
| venues[].lag_ms | number|null | ms | Horário de recebimento menos o timestamp do livro informado pela corretora; `null` quando a corretora não fornece nenhum. |
| venues[].age_s | number | s | Segundos desde que a linha foi recebida. |
| venues[].fresh_window_s | number | s | Uma linha mais antiga que isto está desatualizada. |
| venues[].is_stale | boolean | — | True quando os dados são mais antigos que sua janela de atualidade. |
| venues[].tier | string | — | Nível de coleta: `A` para as moedas mais negociadas, `B` para as demais. |
| venues[].period_s | number | s | Período de coleta da linha. |
| aggregate | object | — | Totais por tipo de mercado. Perpétuos e spot nunca são somados. |
| aggregate.perp | object | — | Agregado dos livros de perpétuos; `null` quando não há nenhuma linha. pode estar ausente |
| aggregate.perp.n_rows | number | — | Linhas encontradas, inclusive as desatualizadas. pode estar ausente |
| aggregate.perp.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.perp.mid_median | number | USD | Mediana do preço médio das linhas atualizadas. pode estar ausente |
| aggregate.perp.spread_bps_min | number | bp | Spread mais estreito entre as linhas atualizadas. pode estar ausente |
| aggregate.perp.bands | object | — | Profundidade por faixa; as chaves `0.5`, `1` e `2` são a distância em relação ao preço médio, em porcentagem. pode estar ausente |
| aggregate.perp.bands.1 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.perp.bands.1.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.1.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.1.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.perp.bands.1.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.perp.bands.1.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.1.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.1.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.1.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.1.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.1.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| aggregate.perp.bands.2 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.perp.bands.2.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.2.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.2.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.perp.bands.2.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.perp.bands.2.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.2.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.2.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.2.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.2.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.2.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| aggregate.perp.bands.0.5 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.perp.bands.0.5.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.0.5.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.perp.bands.0.5.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.perp.bands.0.5.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.perp.bands.0.5.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.0.5.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.0.5.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.perp.bands.0.5.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.0.5.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.perp.bands.0.5.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| aggregate.spot | object | — | Agregado dos livros spot; `null` quando não há nenhuma linha. pode estar ausente |
| aggregate.spot.n_rows | number | — | Linhas encontradas, inclusive as desatualizadas. pode estar ausente |
| aggregate.spot.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.spot.mid_median | number | USD | Mediana do preço médio das linhas atualizadas. pode estar ausente |
| aggregate.spot.spread_bps_min | number | bp | Spread mais estreito entre as linhas atualizadas. pode estar ausente |
| aggregate.spot.bands | object | — | Profundidade por faixa; as chaves `0.5`, `1` e `2` são a distância em relação ao preço médio, em porcentagem. pode estar ausente |
| aggregate.spot.bands.1 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.spot.bands.1.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.1.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.1.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.spot.bands.1.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.spot.bands.1.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.1.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.1.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.1.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.1.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.1.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| aggregate.spot.bands.2 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.spot.bands.2.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.2.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.2.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.spot.bands.2.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.spot.bands.2.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.2.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.2.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.2.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.2.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.2.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| aggregate.spot.bands.0.5 | object | — | Faixa a esta distância do preço médio, em porcentagem. pode estar ausente |
| aggregate.spot.bands.0.5.bid_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.0.5.ask_depth_usd | number | USD | Valor 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. pode estar ausente |
| aggregate.spot.bands.0.5.n_included | number | — | Linhas incluídas na soma da profundidade: atualizadas e completas para a faixa. Leia junto com o valor da profundidade. pode estar ausente |
| aggregate.spot.bands.0.5.n_fresh | number | — | Linhas atualizadas. pode estar ausente |
| aggregate.spot.bands.0.5.included_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.0.5.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete | array | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete[] | object | — | Linhas atualizadas deixadas fora da faixa porque seu snapshot não alcança a borda da faixa. pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete[].exchange | string | — | ID da corretora (em minúsculas). pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete[].symbol | string | — | Símbolo do contrato no formato de armazenamento da CoinBoss. pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete[].reach_bid_pct | number | % | Distância do preço médio até o nível de compra mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.0.5.excluded_incomplete[].reach_ask_pct | number | % | Distância do preço médio até o nível de venda mais distante do snapshot. pode estar ausente |
| aggregate.spot.bands.0.5.lower_bound_bid_usd | number | USD | Profundidade de compra incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.0.5.lower_bound_ask_usd | number | USD | Profundidade de venda incluindo a parte observada das linhas incompletas. É um piso, não uma estimativa. pode estar ausente |
| aggregate.spot.bands.0.5.uses_aggregated_buckets | boolean | — | True quando uma linha incluída usou buckets agregados por preço, o que torna a soma um limite inferior. pode estar ausente |
| coverage | object | — | 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_exchanges | array | — | Fontes cujos dados atualizados estão incluídos. |
| coverage.included_exchanges[] | string | — | Fontes cujos dados atualizados estão incluídos. |
| coverage.unavailable | array | — | 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_excluded | array | — | Linhas deixadas de fora porque sua última atualização está fora da janela de atualidade. vazio nas amostras usadas para gerar esta tabela |
| coverage.no_market | array | — | Pares corretora × mercado que são coletados, mas não têm linha para esta moeda. vazio nas amostras usadas para gerar esta tabela |
| method | object | — | Descrição em texto simples das fórmulas usadas nesta resposta, uma entrada por campo. |
| method.mid | string | — | Nota sobre a fórmula de `mid`, em texto simples. |
| method.spread_bps | string | — | Nota sobre a fórmula de `spread_bps`, em texto simples. |
| method.bid_depth_usd | string | — | Nota sobre a fórmula de `bid_depth_usd`, em texto simples. |
| method.ask_depth_usd | string | — | Nota sobre a fórmula de `ask_depth_usd`, em texto simples. |
| method.complete | string | — | Nota sobre a fórmula de `complete`, em texto simples. |
| method.reach_pct | string | — | Nota sobre a fórmula de `reach_pct`, em texto simples. |
| method.slippage_bps | string | — | Nota sobre a fórmula de `slippage_bps`, em texto simples. |
| method.agg_step_bps | string | — | Nota sobre a fórmula de `agg_step_bps`, em texto simples. |
| method.aggregate | string | — | Nota sobre a fórmula de `aggregate`, em texto simples. |
| method.fresh | string | — | Nota sobre a fórmula de `fresh`, em texto simples. |
| method.lag_ms | string | — | Nota sobre a fórmula de `lag_ms`, em texto simples. |
| method.no_market | string | — | Nota sobre a fórmula de `no_market`, em texto simples. |
| meta | object | — | Linhagem e atualidade desta resposta. |
| meta.schema | string | — | ID do esquema desta resposta. Só muda quando um campo existente muda de significado ou de tipo. |
| meta.source | array | — | 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[].exchange | string | — | ID da corretora (em minúsculas). |
| meta.source[].market | string | — | `perp` ou `spot`. |
| meta.source[].endpoint | string | — | Endpoint público da fonte que o coletor lê (exibido para fins de linhagem; os clientes nunca o chamam). |
| meta.observed_at | number | ms | Timestamp informado pela fonte para os dados. |
| meta.received_at | number | ms | Horário em que o coletor da CoinBoss recebeu os dados. |
| meta.fetched_at | number | ms | Horário em que esta resposta foi montada. |
| meta.window | string | — | Janela de tempo coberta pelos números. |
| meta.quality | string | — | FRESH, PARTIAL, STALE, BROKEN ou UNAVAILABLE, avaliado a partir dos timestamps dos dados e da cobertura. |
| meta.is_stale | boolean | — | True quando os dados são mais antigos que sua janela de atualidade. |
| meta.cache_ttl_s | number | s | Tempo de vida do cache desta resposta. |
| meta.fallback | string | — | O que o endpoint retorna quando o coletor ou uma fonte falha. |
| meta.collector_heartbeat_age_s | number | s | Segundos desde que o coletor informou pela última vez que está em execução. |
Gerada 2026-11-11 23:28 UTC a partir de 4 respostas reais.
Exemplo de resposta
/api/sd/liquidity?coin=BTC · Resposta real capturada 2026-11-13 04:02:45 UTC. Arrays e mapas longos são encurtados para exibição: venues tinha 39 itens; meta.source tinha 38 itens; coverage.included_exchanges tinha 24 itens; aggregate.perp.bands.1.included_exchanges tinha 19 itens; aggregate.perp.bands.2.included_exchanges tinha 16 itens; aggregate.spot.bands.1.included_exchanges tinha 13 itens.
- "success"true
- "schema""coinboss.sd.liquidity/1"
- "now"1794542565757
- "coin""BTC"
- "market""all"
- "venues"
- "aggregate"
- "perp"
- "spot"
- "coverage"
- "included_exchanges"
- "unavailable"
- "stale_excluded"
- "no_market"
- "method"
- "mid""(best_bid + best_ask) / 2 of the venue order book, normalised to the USD price of ONE coin (1000PEPE / kPEPE style contr…"
- "spread_bps""(best_ask - best_bid) / mid * 1e4"
- "bid_depth_usd""sum of resting bid notional with price >= mid * (1 - band%), in USD; notional = price * size * contract_value (inverse c…"
- "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;…"
- "reach_pct""distance in % between mid and the farthest price level contained in the snapshot on that side"
- "slippage_bps""market order of N USD walked through the book: buy = (avg_fill / mid - 1) * 1e4, sell = (1 - avg_fill / mid) * 1e4, meas…"
- "agg_step_bps""widest price-aggregation bucket (in bps of mid) used inside +-2% for venues whose REST only exposes a shallow raw book (…"
- "aggregate""per market and band: sum over rows that are fresh AND complete for that band; n_included / n_fresh is the denominator; l…"
- "fresh""a row is fresh when now - received_at <= max(3 * period_s, 300s); stale rows are listed in coverage.stale_excluded; rows…"
- "lag_ms""received_at - venue timestamp of the book (null when the venue gives none); Gate spot books deeper than 100 levels are v…"
- "no_market""covered venue/market pairs that are being collected but hold no row for this coin: not listed there, or the contract was…"
- "meta"
- "schema""coinboss.sd.liquidity/1"
- "source"
- "observed_at"1794542554621
- "received_at"1794542554947
- "fetched_at"1794542565757
- "window""latest"
- "quality""PARTIAL"
- "is_stale"false
- "cache_ttl_s"15
- "fallback""on collector failure the last stored row is served with is_stale=true and left out of the aggregate; rows older than 24h…"
- "collector_heartbeat_age_s"3
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 |
|---|---|---|---|
| coin=ETH&market=spot | 200 | 3 ms | Aprovado PARTIAL |
| coin=PEPE&market=perp | 200 | 4 ms | Aprovado FRESH |
| coin=SOL | 200 | 4 ms | Aprovado PARTIAL |
| — | 400 | 1 ms | Aprovado 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
- 15s
- Microcache de borda
- 10s
- Frequência de atualização
- Snapshots a cada 120 segundos para as moedas mais negociadas e a cada 600 segundos para as demais (algumas corretoras: 300 / 1200 segundos). Uma linha é considerada atualizada por três períodos de coleta, no mínimo 300 segundos.
- 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; uma linha por corretora × mercado × contrato.
- Ordenação
- Linhas de perpétuos primeiro, depois spot; dentro de cada grupo, por profundidade de ±1 % (compra + venda) decrescente.
- 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.
- Método
- mid = (best bid + best ask) ÷ 2. Depth = Σ price × size of all levels between mid and mid ± x %. Slippage = (average fill price of a market order of N USD − mid) ÷ mid, in bp; `null` with flag `insufficient_book` when the snapshot cannot fill the order (no extrapolation), flag `upper_bound` when an aggregated price bucket was used.
- 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:45 UTCHTTP 2006 msEsquema confereDado mais recente: há 11s
O endpoint reporta qualidade dos dados PARTIAL — Para as moedas mais líquidas, os snapshots públicos de várias grandes corretoras não alcançam a faixa completa, por isso essas corretoras são excluídas do agregado e o agregado subestima a profundidade total. Os campos `lower_bound_*` acrescentam a parte que foi observada. Leia sempre `n_included` junto com o valor da profundidade.
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ó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
GET
/api/sd/liquidityParcialParâmetros
string — Coin symbol, case-insensitive (for example `BTC`). Missing or malformed values return 400.
string · padrão all — Market type. Perpetual and spot books are never added together.
URL da requisição
https://www.coinboss.com/api/sd/liquidity?coin=BTCEscolha um endpoint e clique em “Enviar requisição”. A resposta, os cabeçalhos e o tempo de resposta aparecerão aqui.
Mais nesta categoria
- Profundidade do livro de ofertas e slippage /api/sd/liquidity
- Histórico da profundidade do livro de ofertas /api/sd/liquidity/history
- Moedas classificadas pela profundidade do livro de ofertas /api/sd/liquidity/rank
- Monitor de grandes ordens em espera /api/indicators/large-orderbook