Skip to main content
GET
List withdrawals

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

accountId
string<uuid>
required

Account ID to list withdrawals for.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Query Parameters

after
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

Minimum string length: 1
limit
integer<int64>
default:100

Maximum number of results to return per query

Required range: 1 <= x <= 1000
status
string

Filter to withdrawals with this status. See the status field of the Withdrawal schema for the meaning of each value.

quantity
string

Filter to withdrawals with this quantity, as a decimal string.

assetType
string

A string representing a type of asset, which usually corresponds to the asset's ticker symbol. Use /asset-types to list all of the supported asset types for your organization.

Response

A list of withdrawals

A list of withdrawals.

data
Withdrawal · object[]
required
page
Page · object
required

Pagination info