HomeDocumentationAPI Reference
Log In
API Reference

Get Withdrawal History

Method Name

private/get_withdrawal_history

Get subaccount withdrawal history.
Required minimum session key permission level is read_only

Parameters

subaccount_idintegerrequired
Subaccount id
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)

Response

idstring or integerrequired
resultobjectrequired
result.eventsarray of objectsrequired
List of withdrawals
result.events[].amountstringrequired
Amount withdrawn by the subaccount
result.events[].assetstringrequired
Asset withdrawn
result.events[].error_logobject or nullrequired
If failed, error log for reason
result.events[].timestampintegerrequired
Timestamp of the withdrawal (in ms since UNIX epoch)
result.events[].tx_hashstringrequired
Hash of the transaction that withdrew the funds
result.events[].tx_statusstringrequired
Status of the transaction that deposited the funds
enum requestedpendingsettledrevertedignoredtimed_out

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}