List Deposits

get

https://{region}-api.upbit.com/v1/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.

Revision History

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

currency

string

Currency code to filter deposit history.
A filter parameter used to narrow down results by currency code.
if not provided, returns the latest deposits across all currencies.

state

string

enum

Deposit status to be queried.
A filter parameter used to limit the query target by deposit status. Only deposit information with the specified status will be returned in the response.

The available values are as follows:

PROCESSING: Processing
ACCEPTED: Completed
CANCELLED: Cancelled
REJECTED: Rejected
TRAVEL_RULE_SUSPECTED: Waiting for additional Travel Rule verification
REFUNDING: Refund in progress
REFUNDED: Refund completed

Allowed:

uuids[]

array of strings

List of UUIDs to query deposit information.
Only the deposit information corresponding to the specified UUIDs will be returned.

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

uuids[]

txids[]

array of strings

List of transaction IDs to query deposit information.
Only the deposit information corresponding to the specified txids will be returned.

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

txids[]

limit

integer

Defaults to 100

Number of items per page.
A parameter for pagination that allows you to specify the number of items per page to retrieve.
Up to 100 items can be retrieved at a time, and if not specified, the default value is 100.

page

integer

Defaults to 1

Page number for pagination.
A parameter for pagination that allows you to specify the page to retrieve.
If not specified, the default value is 1.

order_by

string

enum

Defaults to desc

Sorting method for query results.
Returns a list of orders sorted according to the specified method based on the order creation time.
The available values are "desc" (descending, latest orders first) or "asc" (ascending, oldest orders first).
The default value is "desc".

Allowed:

from

string

Cursor for pagination.
By entering the "uuid" value included in the response into this field, you can continue retrieving up to "limit" deposit records made after the specified deposit time.

string

Cursor for pagination.
By entering the "uuid" value included in the response into this field, you can retrieve up to "limit" deposit records made before the specified deposit time.

Responses

200List of deposits

400error object

401error object