mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-09 16:28:06 +00:00
11 lines
1.4 KiB
Markdown
11 lines
1.4 KiB
Markdown
!!! info "[ApiFundingRateRequest](/../../schemas/api_funding_rate_request)"
|
|
Lookup the historical funding rate of a perpetual future.<br><br>Pagination works as follows:<ul><li>We perform a reverse chronological lookup, starting from `end_time`. If `end_time` is not set, we start from the most recent data.</li><li>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.</li><li>If a `cursor` is provided, it will be used to fetch results from that point onwards.</li><li>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.</li></ul><br>
|
|
|
|
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|
|
|-|-|-|-|
|
|
|instrument<br>`i` |string|True|The readable instrument name:<ul><li>Perpetual: `ETH_USDT_Perp`</li><li>Future: `BTC_USDT_Fut_20Oct23`</li><li>Call: `ETH_USDT_Call_20Oct23_2800`</li><li>Put: `ETH_USDT_Put_20Oct23_2800`</li></ul>|
|
|
|start_time<br>`st` |string|False<br>`0`|Start time of funding rate in unix nanoseconds|
|
|
|end_time<br>`et` |string|False<br>`now()`|End time of funding rate in unix nanoseconds|
|
|
|limit<br>`l` |integer|False<br>`500`|The limit to query for. Defaults to 500; Max 1000|
|
|
|cursor<br>`c` |string|False<br>`''`|The cursor to indicate when to start the query from|
|