Method Name
private/get_funding_history
private/get_funding_historyGet subaccount funding history.
DB: read replica
Required minimum session key permission level is read_only
Parameters
| end_timestampinteger End timestamp of the event history in ms since Unix epoch (default current time) |
| instrument_namestring Instrument name (returns history for all perpetuals if not provided) |
| pageinteger Page number of results to return (default 1, returns last if above num_pages) |
| page_sizeinteger Number of results per page (default 100, max 1000) |
| start_timestampinteger Start timestamp of the event history in ms since Unix epoch (default 0) |
| subaccount_idinteger Subaccount id (must be set if wallet is blank) |
| walletstring Wallet address (if set, subaccount_id ignored) |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.eventsarray of objectsrequired List of funding payments |
| result.events[].fundingstringrequired Dollar funding paid (if negative) or received (if positive) by the subaccount |
| result.events[].instrument_namestringrequired Instrument name |
| result.events[].pnlstringrequired Cashflow from the perp PnL settlement |
| result.events[].subaccount_idintegerrequired Subaccount ID of the subaccount that received the funding payment |
| result.events[].timestampintegerrequired Timestamp of the funding payment (in ms since UNIX epoch) |
| result.paginationobjectrequired Pagination information |
| result.pagination.countintegerrequired Total number of items, across all pages |
| result.pagination.num_pagesintegerrequired Number of pages |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}