Skip to main content
GET
Perp versus dated futures carry scanner

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer sk_live_...

Query Parameters

coin
string

Optional base coin ticker, for example BTC, ETH, or SOL.

Minimum string length: 1
exchanges
string

Comma-separated exchange filter, for example Binance,Bybit,OKX.

minNet
number

Minimum of the board's net figure, as a fraction (0.05 is 5%): netApr on the dated basis board, netRollApy on the calendar board, netCarryApr (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, netReturn (per trip, not annualized) on the CEX transfer board.

minOiUsd
number

Minimum open interest in USD.

Required range: x >= 0
minVolumeUsd
number

Minimum 24h futures or spot volume in USD.

Required range: x >= 0
minDepthUsd
number

Minimum executable depth in USD when available.

Required range: x >= 0
marginType
enum<string>

Futures margin filter.

Available options:
linear,
inverse,
both
notional
number
default:10000

Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it.

Required range: 0 < x <= 1000000000
limit
integer
default:100

Maximum number of rows returned.

Required range: 1 <= x <= 1000
cursor
string

Opaque cursor from the previous page.

format
enum<string>
default:json

Response format. When set to "csv", the response Content-Type is text/csv instead of JSON.

Available options:
json,
csv

Response

Scanner rows returned successfully.

data
object
required

Endpoint-specific response payload. See the operation response schema.

meta
object
required