HomeDocumentationAPI Reference
Log In
API Reference

Get Interest History

Method Name

private/get_interest_history

Get interest payment history for a subaccount or wallet.
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)
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 interest payments
result.events[].intereststringrequired
Dollar interest paid (if negative) or received (if positive) by the subaccount
result.events[].subaccount_idintegerrequired
Subaccount ID of the subaccount that received the interest payment
result.events[].timestampintegerrequired
Timestamp of the interest payment (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}