private/get-deposit-history

POST 
/private/get-deposit-history

Fetches deposit history. If you do not see the option when viewing your API Keys, this feature is not yet available for you.

Request

Body

required

id int64required

Request id (echoed in response)

method stringrequired

Must be "private/get-deposit-history"

api_key stringrequired

Your API key (only required for private REST)

sig stringrequired

HMAC-SHA256 signature in hex (only required for private REST)

nonce int64required

Current timestamp in milliseconds, e.g. "1771761038000".

params objectrequired
currency string
E.g. BTC, CRO.
start_ts int64
Start time (ms), e.g. "1771761038000". Default is 90 days from current timestamp.
end_ts int64
End time (ms), e.g. "1771761038000". Default is current timestamp.
page_size int32
Page size (Default: 20, Max: 200).
page int32
Page number (0-based).
status DepositStatus (string)
Possible values: [0, 1, 2, 3]
Deposit status. Used in private/get-deposit-history request (filter) and response (deposit_list[].status).
• ➖ 0: Not Arrived
• ➖ 1: Arrived
• ➖ 2: Failed
• ➖ 3: Pending

Success.

Schema

id int64

Echoed request id

method string

Method invoked

code int32

0 = success; non-zero indicates error (reason code).

result object
Present when code === 0. deposit_list (currency, fee, create_time, id, update_time, amount, address, status).
deposit_list object[]
List of deposits.
Array [
id string
Newly created deposit ID.
currency string
E.g. BTC, CRO.
amount decimal
Deposit amount.
fee decimal
Deposit fee.
address string
Address with Address Tag (if any).
create_time int64
Creation time (ms).
update_time int64
Last update time (ms).
status DepositStatus (string)
Possible values: [0, 1, 2, 3]
Deposit status. Used in private/get-deposit-history request (filter) and response (deposit_list[].status).
• ➖ 0: Not Arrived
• ➖ 1: Arrived
• ➖ 2: Failed
• ➖ 3: Pending
]
message string

Response message. Contains additional reason when code !== 0.

original string

Present when code !== 0.