Skip to main content
GET
Funding spread history and carry backtest

Authorizations

Authorization
string
header
required

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

Query Parameters

mode
enum<string>
default:spot-perp

spot-perp: one venue's spot and perp (needs venue). cross-exchange: a long perp and a short perp (needs longVenue and shortVenue).

Available options:
spot-perp,
cross-exchange
coin
string
required

Base coin, for example BTC.

Required string length: 1 - 32
venue
string

Spot-perp venue: Binance, OKX, Bybit, Bitget, Gate.io, KuCoin, MEXC, BingX or HTX. Required in the default spot-perp mode: a call without it answers 400.

Maximum string length: 32
contract
string

Spot-perp: the venue's perp contract symbol, for example BTCUSDT. Optional: without it the venue's contract for the coin with the largest current open interest is used.

Maximum string length: 64
direction
enum<string>
default:short

Spot-perp: short buys spot and shorts the perp (collects positive funding); long sells spot and longs the perp (the venue's current borrow APR is charged where it publishes one: borrowCostIncluded).

Available options:
short,
long
longVenue
string

Cross-exchange: the venue of the long perp.

Maximum string length: 32
longContract
string

Cross-exchange: the long perp's contract symbol. Optional, resolved as contract is.

Maximum string length: 64
shortVenue
string

Cross-exchange: the venue of the short perp.

Maximum string length: 32
shortContract
string

Cross-exchange: the short perp's contract symbol. Optional, resolved as contract is.

Maximum string length: 64
days
integer
default:30

Backtest window in days (1-90): the series covers it, and backtests lists it after the shorter standard windows.

Required range: 1 <= x <= 90

Response

Spread series and backtests returned successfully.

data
object
required

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

meta
object
required