Method Name
private/get_funding_history
private/get_funding_history
Get subaccount funding history.
DB: read replica
Required minimum session key permission level is read_only
Parameters
subaccount_id
integer
required
Subaccount id |
end_timestamp
integer
End timestamp of the event history (default current time) |
instrument_name
string
Instrument name (returns history for all perpetuals if not provided) |
page
integer
Page number of results to return (default 1, returns last if above num_pages ) |
page_size
integer
Number of results per page (default 100, max 1000) |
start_timestamp
integer
Start timestamp of the event history (default 0) |
Response
id
string or integer
required
|
result
object
required
|
result.events
array of objects
required
List of funding payments |
result.events[].funding
string
required
Dollar funding paid (if negative) or received (if positive) by the subaccount |
result.events[].instrument_name
string
required
Instrument name |
result.events[].pnl
string
required
Cashflow from the perp PnL settlement |
result.events[].timestamp
integer
required
Timestamp of the funding payment (in ms since UNIX epoch) |
result.pagination
object
required
Pagination information |
result.pagination.count
integer
required
Total number of items, across all pages |
result.pagination.num_pages
integer
required
Number of pages |
Example
{request_example_shell}
{request_example_javascript}
{request_example_python}
The above command returns JSON structured like this:
{response_example_json}