HomeDocumentationAPI Reference
Log In
API Reference

Get Funding Rate History

Method Name

public/get_funding_rate_history

Get funding rate history. Start timestamp is restricted to at most 30 days ago.
End timestamp greater than current time will be truncated to current time.
Zero start timestamp is allowed and will default to 30 days from the end timestamp.

DB: read replica

Parameters

instrument_name  string required
Instrument name to return funding history for

end_timestamp  integer
End timestamp of the event history (default current time)

period  string
Period of the funding rate
enum 900 3600 14400 28800 86400

start_timestamp  integer
Start timestamp of the event history (default 0)

Response

id  string or integer required

result  object required

result. funding_rate_history  array of objects required
List of funding rates

result.funding_rate_history[]. funding_rate  string required
Hourly funding rate value at the event time

result.funding_rate_history[]. timestamp  integer required
Timestamp of the funding rate update (in ms since UNIX epoch)

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}