Le positionnement à terme : combien de capital est engagé, à quel coût, dans quel sens, et à quel prix par rapport au comptant. Toutes ces métriques sont des composites — la pondération employée est indiquée pour chacune.
L’open interest total, sommé sur toutes les places, en fenêtres d’une minute. Chaque place conserve sa dernière valeur connue quand son rafraîchissement saute une minute, et une minute n’est servie que si toutes les places y sont représentées : sans cela, le total oscillerait artificiellement.
Paramètre
Type
Défaut
Description
symbol
string
requis
L’actif.
limit
integer
30
Nombre de minutes, de 1 à 1000.
Champ
Type
Description
timestamp
string
Début de la minute.
oi_total
float
Open interest sommé. Le nom dit l’agrégat : ce n’est pas la valeur d’une place.
La variation d’open interest — l’entrée ou la sortie de capital. Le pourcentage est recalculé à partir des totaux agrégés, pour rester cohérent avec la somme.
Trois lectures du même phénomène : le dernier taux appliqué, le prochain estimé, et le cumul des dernières vingt-quatre heures. Toutes sont des composites pondérés par l’open interest — la place qui porte le plus de positions pèse le plus — et ramenés à une base de huit heures avant pondération, certaines paires réglant toutes les quatre heures ou toutes les heures.
Les liquidations individuelles, toutes places confondues. La couverture y est structurellement plus faible que sur les trades : toutes les places ne publient pas de flux public de liquidations.
Paramètre
Type
Défaut
Description
symbol
string
requis
L’actif.
limit
integer
30
Nombre d’événements, de 1 à 1000.
min_usd
float
—
Filtre optionnel sur la valeur en dollars.
Champ
Type
Description
timestamp
string
Horodatage.
side
string
long ou short — le côté de la position liquidée, pas celui de l’ordre. La convention est normalisée entre les places.
Le rapport entre les grosses liquidations — au moins 100 000 $ — et les petites. Il distingue une purge de gros comptes d’une cascade de petits porteurs.
Champ
Type
Description
big_count / big_usd
integer / float
Les liquidations d’au moins 100 000 $.
small_count / small_usd
integer / float
Celles en dessous.
ratio
float | null
big_usd divisé par small_usd. null si le dénominateur est nul.
La part des comptes positionnés à la hausse, en saveur compte global, composite sur les places qui la publient et pondérée par l’open interest. Deux places au minimum sont requises sur une fenêtre, sinon la réponse est null.
Paramètre
Type
Défaut
Description
symbol
string
requis
L’actif.
timeframe
string
requis
5m, 15m, 30m, 1h, 4h, 1d. Le pas 1m est refusé : aucune place ne publie à cette cadence.
live
boolean
false
Expose la fenêtre en cours.
limit
integer
30
Sur l’historique, de 1 à 500.
Champ
Type
Description
timestamp
string
Début de la fenêtre.
timeframe
string
Le pas demandé.
part_long
float
Part des comptes longs, strictement entre 0 et 1.
ratio
float
Longs divisés par shorts.
venue_count
integer
Nombre de places agrégées, au moins deux.
weighting
string
oi quand la pondération par l’open interest a pu s’appliquer, geomean en repli.
L’écart entre le prix à terme et le prix au comptant, moyenne pondérée par l’open interest sur les places qui portent les deux marchés. Les deux prix sont pondérés de la même façon, ce qui garantit que basis_value = futures_price − spot_price reste vrai.
Champ
Type
Description
basis_value
float
L’écart en dollars.
basis_pct
float
L’écart en pourcentage.
futures_price
float
Prix à terme composite.
spot_price
float
Prix comptant composite.
timestamp
string
Horodatage du calcul.
Fenêtre par défaut de l’historique
Sans since_ms ni until_ms, la recherche remonte limit minutes en arrière. Avec une fenêtre explicite, c’est elle qui s’applique.
La seule surface de l’API qui nomme les places de marché — un écart n’ayant aucun sens sans elles. Le modèle est une prime par place : un prix de référence cross-place, puis l’écart de chacune à cette référence. Une paire quelconque se dérive côté client, par différence de deux primes.
Paramètre
Type
Défaut
Description
symbol
string
requis
L’actif.
timeframe
string
requis
1m, 5m, 15m, 30m, 1h, 4h, 1d.
live
boolean
false
Expose la fenêtre en cours.
limit
integer
30
Sur l’historique, de 1 à 500. Pas de fenêtre datée.