Api funding rate request

ApiFundingRateRequest

Lookup the historical funding rate of a perpetual future.

Pagination works as follows:

  • We perform a reverse chronological lookup, starting from end_time. If end_time is not set, we start from the most recent data.
  • The lookup is limited to limit records. If more data is requested, the response will contain a next cursor for you to query the next page.
  • If a cursor is provided, it will be used to fetch results from that point onwards.
  • Pagination will continue until the start_time is reached. If start_time is not set, pagination will continue as far back as our data retention policy allows.

Name
Lite		 Type Required
Default		 Description
instrument
i		 string True The readable instrument name:
  • Perpetual: ETH_USDT_Perp
  • Future: BTC_USDT_Fut_20Oct23
  • Call: ETH_USDT_Call_20Oct23_2800
  • Put: ETH_USDT_Put_20Oct23_2800
start_time
st		 string False
0		 Start time of funding rate in unix nanoseconds
end_time
et		 string False
now()		 End time of funding rate in unix nanoseconds
limit
l		 integer False
500		 The limit to query for. Defaults to 500; Max 1000
cursor
c		 string False
''		 The cursor to indicate when to start the query from
agg_type
at		 FundingRateAggregationType False
'FUNDING_INTERVAL'		 Aggregation method for historical funding rate observations. Defaults to using the instrument-specific funding interval.
FundingRateAggregationType

Specifies different methods of aggregating historical funding rates

Value Description
FUNDING_INTERVAL = 1 Default value -- one record returned per funding interval. Query instruments endpoint to learn funding interval of each instrument.
ONE_HOURLY = 2 Returns one record per hour -- normalizes all funding rates to 1h durations, so fundingRate value is cumulative and can exceed a funding interval's configured cap / floor.
FOUR_HOURLY = 3 Returns one record per 4 hours -- normalizes all funding rates to 4h durations, so fundingRate value is cumulative and can exceed a funding interval's configured cap / floor.
EIGHT_HOURLY = 4 Returns one record for eight hours -- normalizes all funding rates to 8h durations, so fundingRate value is cumulative and can exceed a funding interval's configured cap / floor.