HomeDocumentationAPI Reference
Log In
API Reference

Get Interest History

Method Name

private/get_interest_history

Get subaccount interest payment history.
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)

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 interest payments

result.events[]. interest  string required
Dollar interest paid (if negative) or received (if positive) by the subaccount

result.events[]. timestamp  integer required
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}