List Withdrawals

Retrieves latest withdrawal list.

Check the proper endpoint based on 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 parameters to retrieve a filtered list of withdrawals that meet the specified conditions. Currency, withdrawal status, UUID list, or TXID list can be used as filter parameters. If no conditions are specified, the API returns the most recent 100 withdrawal records.


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 and an API Key with [View Withdrawals] permission.
If you receive an out_of_scope permission error, please verify your API Key permissions in the API Key Management page.
Query Params
string

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

string

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

The available values are as follows:

  • WAITING: Waiting
  • PROCESSING: Processing
  • DONE: Completed
  • FAILED: Failed
  • CANCELLED: Cancelled
  • REJECTED: Rejected
uuids[]
array of strings

List of UUIDs to query withdrawal information.
Only the deposit/withdrawal information corresponding to the specified UUIDs will be returned. Up to 100 UUIDs can be specified.

The uuids and txids parameters cannot be used simultaneously.

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

uuids[]
txids[]
array of strings

List of transaction IDs to query withdrawal information.
Only the deposit/withdrawal information corresponding to the specified txids will be returned. Up to 100 txids can be specified.

The uuids and txids parameters cannot be used simultaneously.

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

txids[]
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.

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.

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:
string

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

string

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

Responses

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