/api/sd/liquidity/history
GETPartielFRESH

Historique de la profondeur du carnet d'ordres

Série temporelle de la profondeur agrégée à l'achat (bid) et à la vente (ask) dans une bande donnée pour une crypto, sur toutes les plateformes couvertes ou sur une seule. Chaque point précise le nombre de contrats qu'il contient.

GET/api/sd/liquidity/history
Couverture partielle. La collecte a commencé le 2026-11-11 : les plages plus longues se remplissent donc progressivement. Les tranches manquantes sont absentes, non interpolées ; une variation de `n_included` entre deux points signifie que l'ensemble des contrats contributeurs a changé.

Requête

Paramètres de requête

NomTypeRequisPar défautValeurs autoriséesDescription
coinstringRequis——Symbole de la crypto, insensible à la casse (par exemple `BTC`). Une valeur absente ou mal formée renvoie 400. Exemple: BTC
marketstringOptionnelperpperp, spotType de marché. Les carnets perpétuels et spot ne sont jamais additionnés.
bandstringOptionnel10.5, 1, 2Distance au prix médian, en pourcentage.
rangestringOptionnel24h24h, 7d, 30dPlage rétrospective : 24h (points de 30 minutes), 7d (points de 2 heures) ou 30d (points de 6 heures).
exchangestringOptionnel——Identifiant d'une plateforme couverte pour ce marché (par exemple `gate`). Par défaut : toutes les plateformes. Une plateforme non couverte renvoie 400.

Exemple de requête

curl -s "https://www.coinboss.com/api/sd/liquidity/history?coin=BTC"

Champs de la réponse

Le tableau des champs est généré à partir de réponses réelles : il liste donc exactement ce que renvoie l'endpoint. Les chemins utilisent a[] pour les éléments d'un tableau et {*} pour les objets indexés par un nom dynamique, comme une crypto ou une plateforme.

ChampTypeUnitéDescription
successboolean—true lorsque la requête a abouti. En cas d'échec, le corps est `{ success: false, code, error, request_id }`.
schemastring—Identifiant de schéma de cette réponse. Il ne change que lorsqu'un champ existant change de sens ou de type.
nownumbermsHeure du serveur au moment où la réponse a été construite.
coinstring—Symbole de la crypto (en majuscules).
marketstring—`perp` ou `spot`.
band_pctnumber%Bande sélectionnée : distance au prix médian.
rangestring—Plage rétrospective appliquée.
exchangestring|null—Identifiant de la plateforme (en minuscules).
interval_snumbersEspacement des points.
pointsarray—Points de la série, du plus ancien au plus récent.
points[]object—Points de la série, du plus ancien au plus récent.
points[].tnumbermsDébut de la tranche temporelle.
points[].bid_depth_usdnumberUSDNotionnel des ordres d'achat en attente entre le prix médian et la borne inférieure de la bande. Une borne inférieure lorsque `complete` vaut false.
points[].ask_depth_usdnumberUSDNotionnel des ordres de vente en attente entre le prix médian et la borne supérieure de la bande. Une borne inférieure lorsque `complete` vaut false.
points[].n_includednumber—Lignes incluses dans la somme de profondeur : à jour et complètes pour la bande. À lire en même temps que la valeur de profondeur.
points[].n_rowsnumber—Lignes trouvées, y compris les lignes périmées.
points[].midnumberUSD(meilleur bid + meilleur ask) ÷ 2, prix d'une crypto.
points[].uses_aggregated_bucketsboolean—True lorsqu'une ligne incluse a utilisé des tranches agrégées par prix, ce qui fait de la somme une borne inférieure.
points_expectednumber—Nombre de points que contient la plage lorsqu'elle est complète.
first_tnumbermsHeure du premier point renvoyé.
last_tnumbermsHeure du dernier point renvoyé.
exchange_pointsobject—Nombre de points dans lesquels chaque plateforme apparaît (la clé est l'identifiant de la plateforme). clés dynamiques: deribit,aster,backpack,bitfinex,bitget,bitunix
exchange_points.{*}number—Nombre de points dans lesquels chaque plateforme apparaît (la clé est l'identifiant de la plateforme).
coverageobject—Ce qui est inclus ou non dans les chiffres. Comparez ces éléments avant de comparer les totaux avec une autre source.
coverage.included_exchangesarray—Sources dont les données à jour sont incluses.
coverage.included_exchanges[]string—Sources dont les données à jour sont incluses.
coverage.unavailablearray—Sources qui n'ont pas pu être incluses, chacune avec sa raison. Elles ne sont jamais comptées comme 0. vide dans les échantillons ayant servi à générer ce tableau
coverage.stale_excludedarray—Lignes écartées parce que leur dernière mise à jour est hors de la fenêtre de fraîcheur. vide dans les échantillons ayant servi à générer ce tableau
methodobject—Énoncé en texte brut des formules utilisées pour cette réponse, une entrée par champ.
method.bid_depth_usdstring—Note de formule pour `bid_depth_usd`, en texte brut.
method.ask_depth_usdstring—Note de formule pour `ask_depth_usd`, en texte brut.
method.completestring—Note de formule pour `complete`, en texte brut.
method.historystring—Note de formule pour `history`, en texte brut.
method.exchange_pointsstring—Note de formule pour `exchange_points`, en texte brut.
metaobject—Traçabilité et fraîcheur de cette réponse.
meta.schemastring—Identifiant de schéma de cette réponse. Il ne change que lorsqu'un champ existant change de sens ou de type.
meta.sourcearray—Endpoints publics amont auprès desquels les données ont été collectées.
meta.source[]object—Endpoints publics amont auprès desquels les données ont été collectées.
meta.source[].exchangestring—Identifiant de la plateforme (en minuscules).
meta.source[].marketstring—`perp` ou `spot`.
meta.source[].endpointstring—Endpoint public de la source que lit le collecteur (indiqué pour la traçabilité ; les clients ne l'appellent jamais).
meta.observed_atnull—Horodatage attribué aux données par la source.
meta.received_atnumbermsMoment où le collecteur CoinBoss a reçu les données.
meta.fetched_atnumbermsMoment où cette réponse a été assemblée.
meta.windowstring—Fenêtre temporelle couverte par les chiffres.
meta.qualitystring—FRESH, PARTIAL, STALE, BROKEN ou UNAVAILABLE, d'après les horodatages des données et la couverture.
meta.is_staleboolean—True lorsque les données sont plus anciennes que leur fenêtre de fraîcheur.
meta.cache_ttl_snumbersDurée de vie en cache de cette réponse.
meta.fallbackstring—Ce que renvoie l'endpoint lorsque le collecteur ou une source est en échec.
meta.collector_heartbeat_age_snumbersSecondes écoulées depuis le dernier signal d'activité du collecteur.

Généré à partir de 3 réponses réelles (2026-11-11 23:00 UTC).

Exemple de réponse

/api/sd/liquidity/history?coin=BTC · Réponse réelle (capture : 2026-11-13 04:02:45 UTC). Les tableaux et dictionnaires longs sont abrégés pour l'affichage : points comptait 48 éléments; meta.source comptait 19 éléments; exchange_points comptait 19 éléments; coverage.included_exchanges comptait 19 éléments.

  • {
    • "success": true,
    • "schema": "coinboss.sd.liquidity/1",
    • "now": 1794542565889,
    • "coin": "BTC",
    • "market": "perp",
    • "band_pct": 1,
    • "range": "24h",
    • "exchange": null,
    • "interval_s": 1800,
    • "points": [
      • { … 7 },
      • { … 7 }
      ],
    • "points_expected": 48,
    • "first_t": 1794457800000,
    • "last_t": 1794542400000,
    • "exchange_points": {
      • "deribit": 96,
      • "aster": 48
      },
    • "coverage": {
      • "included_exchanges": [ … 8 ],
      • "unavailable": [],
      • "stale_excluded": []
      },
    • "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…",
      • "history": "sd_book_hist keeps the first snapshot of every 15-minute bucket per contract; each returned point takes, per contract, the first stored snapshot inside the poin…",
      • "exchange_points": "number of returned points in which each exchange had a row that was complete for the band; a changing venue set moves the aggregate, so compare n_included acros…"
      },
    • "meta": {
      • "schema": "coinboss.sd.liquidity/1",
      • "source": [ … 2 ],
      • "observed_at": null,
      • "received_at": 1794542400000,
      • "fetched_at": 1794542565889,
      • "window": "24h",
      • "quality": "FRESH",
      • "is_stale": false,
      • "cache_ttl_s": 120,
      • "fallback": "history is append-only (first snapshot of each 15-minute bucket per contract, 30-day retention); buckets the collector missed are simply absent, never interpola…",
      • "collector_heartbeat_age_s": 3
      }
    }

Échantillons vérifiés

Outre l'exemple ci-dessus, la sonde appelle cet endpoint avec les paramètres suivants et vérifie le schéma à chaque fois.

ParamètresHTTPLatenceRésultat
band=2&coin=ETH&market=spot2006 msRéussi FRESH
coin=SOL&exchange=gate2002 msRéussi FRESH
band=3&coin=BTC4001 msRéussi renvoie l'erreur attendue

Vérifié : 2026-11-13 03:58:06 UTC

Détails

Authentification
Aucune. Endpoint public.
Limite de requêtes
1200 requêtes par minute et par IP
Cache serveur
2m
Micro-cache en périphérie
10s
Fréquence de mise à jour
Un instantané est stocké toutes les 15 minutes par contrat ; chaque point utilise le premier instantané de sa tranche (une valeur ponctuelle, pas une moyenne).
Fenêtre
24h / 7d / 30d.
Sources de données
Instantanés REST publics des carnets d'ordres de 24 plateformes (marchés perpétuels et spot), collectés et stockés par CoinBoss (sd_book_latest, sd_book_hist). La profondeur et le slippage sont calculés par CoinBoss à partir des niveaux de prix bruts.
Couverture des plateformes
24 plateformes, 38 couples plateforme × marché. Lorsqu'un instantané public n'atteint pas ±0.5 / 1 / 2 % autour du prix médian (plafond de niveaux de la plateforme), cette bande est marquée `complete: false`, sa valeur est une borne inférieure et elle est écartée de l'agrégat ; `n_included` / `n_fresh` donnent le dénominateur et `excluded_incomplete` liste ce qui a été écarté.
Pagination
Pas de pagination ; `range` borne le nombre de points (48 / 84 / 120).
Tri
Temps croissant.
Unités
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.
Horodatages
Millisecondes depuis l'epoch Unix (UTC), sauf indication contraire dans la description du champ
Format de réponse
json
Stabilité
Stable
Disponible depuis
2026-11-11

Statut en direct

PartielVérifié : 2026-11-13 04:02:45 UTCHTTP 20012 msSchéma conformePoint de données le plus récent : il y a 3m

La collecte a commencé le 2026-11-11 : les plages plus longues se remplissent donc progressivement. Les tranches manquantes sont absentes, non interpolées ; une variation de `n_included` entre deux points signifie que l'ensemble des contrats contributeurs a changé.

Disponibilité, 30 derniers jours

100 % des 408 contrôles réussis

Erreurs

Les appels en échec ont la même structure sur tous les endpoints. La liste complète figure sur la page des erreurs. Erreurs et limites de requêtes →

CodeHTTPSignificationQue faire
INVALID_PARAM400Un paramètre requis est manquant ou une valeur n'est pas acceptée. `param` indique le nom du paramètre lorsqu'il est connu.Ne réessayez pas à l'identique ; corrigez la requête.
UNAUTHORIZED401L'en-tête `CB-API-KEY` a été envoyé, mais la clé est inconnue ou révoquée. Les données publiques ne nécessitent aucune clé — supprimez l'en-tête ou utilisez une clé valide.Ne réessayez pas à l'identique.
FORBIDDEN403La route ne fait pas partie de l'API publique (interne ou réservée aux comptes).Ne réessayez pas.
NOT_FOUND404Route inconnue, ou la crypto / la plateforme / le fonds demandé n'existe pas.Ne réessayez pas ; vérifiez le chemin et les identifiants dans le catalogue.
RATE_LIMITED429Plus de requêtes que la limite par minute. `Retry-After` indique le nombre de secondes à attendre.Attendez la durée indiquée par `Retry-After`, puis réessayez avec backoff.
INTERNAL500Erreur serveur inattendue. Le message est volontairement générique ; citez `request_id` lorsque vous la signalez.Réessayez une fois après quelques secondes ; si l'erreur persiste, signalez-la avec l'ID de requête.
UPSTREAM_FAILED503La source de données derrière cet endpoint n'a pas répondu à temps. Aucun chiffre périmé ni de substitution n'est renvoyé à sa place.Réessayez avec backoff ; consultez la page de statut.
UNAVAILABLE501 / 503Le jeu de données n'est temporairement pas prêt (préchauffage du cache) ou l'endpoint n'a pas encore de source publique licite.Réessayez plus tard ; le catalogue signale les endpoints indisponibles par conception.
REQUEST_FAILED200Certains endpoints plus anciens répondent HTTP 200 avec `success: false`. Vérifiez toujours `success`, et pas seulement le statut HTTP.Dépend du message ; à traiter comme une requête en échec.

Essayer

GET/api/sd/liquidity/historyPartiel
Paramètres

string — Coin symbol, case-insensitive (for example `BTC`). Missing or malformed values return 400.

string · défaut perp — Market type. Perpetual and spot books are never added together.

string · défaut 1 — Distance from mid price in percent.

string · défaut 24h — Look-back range: 24h (30-minute points), 7d (2-hour points) or 30d (6-hour points).

string — One exchange id covered for this market (for example `gate`). Default: all exchanges. An exchange that is not covered returns 400.

URL de la requêtehttps://www.coinboss.com/api/sd/liquidity/history?coin=BTC
Choisissez un endpoint et cliquez sur « Envoyer la requête ». La réponse, les en-têtes et le temps de réponse s'afficheront ici.