List Deposits

Retrieves the latest deposit list.

Check the proper endpoint based on your region.
The examples in this page is written using Singapore fiat code(SGD). Set the quote currency to match your region. The base_url differs by country/region. Make sure to specify the correct region value for your environment.

- Singapore (sg): https://sg-api.upbit.com
- Indonesia (id): https://id-api.upbit.com
- Thailand (th): https://th-api.upbit.com

You can set query conditions to retrieve only the deposit records that meet those conditions. Currency, deposit status, UUID list, or TXID list can be used as filter parameters. If no conditions are specified, the most recent 100 deposit records will be returned.


Version Date Changes
v1.0.7 2023-05-23 Addition of net_type field
Rate Limit
Up to 30 calls per second are allowed. This is measured on an account basis and request counts are shared within the exchange 'default' group.

API Key Permission
This API requires authentication with an API Key granted [View Deposits] permission.
If you receive an out_of_scope error, please verify the permission settings in the API Key Management page.

Query Params
string

Currency code filter.
If not specified, the latest deposits are returned.

string
enum

Deposit state filter.

  • PROCESSING: Processing
  • ACCEPTED: Completed
  • CANCELLED: Cancelled
  • REJECTED: Rejected
  • TRAVEL_RULE_SUSPECTED: Pending Travel Rule verification
  • REFUNDING: Refund in progress
  • REFUNDED: Refunded
Allowed:
uuids[]
array of strings

List of UUIDs to query.

[Example] uuids[]=uuid1&uuids[]=uuid2

uuids[]
txids[]
array of strings

List of transaction IDs to query.

[Example] txids[]=txid1&txids[]=txid2

txids[]
integer
Defaults to 100

Number of results per request (default: 100, max: 100).

integer
Defaults to 1

Page number for pagination. Default is 1.

string
enum
Defaults to desc

Sort order. "desc" (newest first) or "asc" (oldest first). Default is "desc".

Allowed:
string

Cursor for pagination.
Enter a "uuid" from the response to retrieve "limit" deposits after that timestamp.

string

Cursor for pagination.
Enter a "uuid" from the response to retrieve "limit" deposits before that timestamp.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json