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_namestringrequired
Instrument name to return funding history for
end_timestampinteger
End timestamp of the event history in ms since Unix epoch (default current time)
periodstring
Period of the funding rate
enum 9003600144002880086400
start_timestampinteger
Start timestamp of the event history in ms since Unix epoch (default 0)

Response

idstring or integerrequired
resultobjectrequired
result.funding_rate_historyarray of objectsrequired
List of funding rates
result.funding_rate_history[].funding_ratestringrequired
Hourly funding rate value at the event time
result.funding_rate_history[].timestampintegerrequired
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}