Api deposit history request

ApiDepositHistoryRequest

The request to get the historical deposits of an account
The history is returned in reverse chronological order
Both finalized and pending deposits are returned, and pending deposits are indicated by an empty confirmedTime field.

Pagination works as follows:

  • We perform a reverse chronological lookup, starting from end_time. If end_time is not set, we start from the most recent data.
  • The lookup is limited to limit records (default 500, max 1000). If more data matches, the response returns a non-empty next cursor. To read the full result set you MUST re-issue the request with cursor set to that value and keep looping until next is empty.
  • A single call silently truncates at limit and returns no error. Callers that read only the first page (or omit limit, which just applies the 500 default) will undercount whenever the account has more than limit matching records — e.g. summing deposits/transfers for a balance or PnL calculation must drain the cursor, not read one page.
  • If a cursor is provided, it will be used to fetch results from that point onwards.
  • Pagination will continue until the start_time is reached. If start_time is not set, pagination will continue as far back as our data retention policy allows.

Name
Lite		 Type Required
Default		 Description
currency
c		 [string] True The token currency to query for, if nil or empty, return all deposits. Otherwise, only entries matching the filter will be returned
start_time
st		 string False
0		 The start time to query for in unix nanoseconds
end_time
et		 string False
now()		 The end time to query for in unix nanoseconds
limit
l		 integer False
500		 The page size for a single response. Defaults to 500; Max 1000. This caps one page only — omitting it does NOT return everything, it applies the 500 default. To get the full result set, follow the next cursor until it is empty.
cursor
c1		 string False
''		 The cursor to indicate when to start the next query from
main_account_id
ma		 string False
``		 Main account ID being queried. By default, applies the requestor's main account ID.