Futures positioning: how much capital is committed, at what cost, in which direction, and at what price relative to spot. All these metrics are composites, and the weighting used is stated for each one.
Total open interest, summed across all venues, in one-minute windows. Each venue keeps its last known value when its refresh skips a minute, and a minute is served only if every venue is represented in it: without that, the total would swing artificially.
Parameter
Type
Default
Description
symbol
string
required
The asset.
limit
integer
30
Number of minutes, from 1 to 1000.
Field
Type
Description
timestamp
string
Start of the minute.
oi_total
float
Summed open interest. The name says the aggregate: it is not the value of a single venue.
Three readings of the same phenomenon: the last rate applied, the next estimated one, and the cumulative total over the last twenty-four hours. All are composites weighted by open interest (the venue carrying the most positions weighs the most) and normalised to an eight-hour base before weighting, since some pairs settle every four hours or every hour.
Individual liquidations, all venues combined. Coverage here is structurally lower than on trades: not every venue publishes a public liquidation stream.
Parameter
Type
Default
Description
symbol
string
required
The asset.
limit
integer
30
Number of events, from 1 to 1000.
min_usd
float
—
Optional filter on the dollar value.
Field
Type
Description
timestamp
string
Timestamp.
side
string
long or short: the side of the liquidated position, not that of the order. The convention is normalised across venues.
The share of accounts positioned long, in the global account flavour, composited over the venues that publish it and weighted by open interest. At least two venues are required over a window, otherwise the response is null.
Parameter
Type
Default
Description
symbol
string
required
The asset.
timeframe
string
required
5m, 15m, 30m, 1h, 4h, 1d. The 1m timeframe is refused: no venue publishes at that cadence.
live
boolean
false
Exposes the window in progress.
limit
integer
30
On the history, from 1 to 500.
Field
Type
Description
timestamp
string
Start of the window.
timeframe
string
The timeframe requested.
part_long
float
Share of long accounts, strictly between 0 and 1.
ratio
float
Longs divided by shorts.
venue_count
integer
Number of venues aggregated, at least two.
weighting
string
oi when weighting by open interest could be applied, geomean as the fallback.
The gap between the futures price and the spot price, an open-interest-weighted average over the venues that carry both markets. The two prices are weighted the same way, which guarantees that basis_value = futures_price − spot_price stays true.
Field
Type
Description
basis_value
float
The gap in dollars.
basis_pct
float
The gap in percent.
futures_price
float
Composite futures price.
spot_price
float
Composite spot price.
timestamp
string
Timestamp of the computation.
Default window of the history
Without since_ms or until_ms, the search goes back limit minutes. With an explicit window, that window applies.
The only surface of the API that names the trading venues, since a spread makes no sense without them. The model is a premium per venue: a cross-venue reference price, then the gap of each venue to that reference. Any given pair is derived client-side, by the difference of two premiums.