Get Withdrawal Addresses

POST 
/private/WithdrawAddresses

Retrieve a list of withdrawal addresses available for the user.

API Key Permissions Required: Funds permissions - Query and Funds permissions - Withdraw

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

asset string

Filter addresses for specific asset

aclass string

Default value: currency

Filter addresses for specific asset class

method string

Filter addresses for specific method

key string

Find address for by withdrawal key name, as set up on your account

verified boolean

Filter by verification status of the withdrawal address. Withdrawal addresses successfully completing email confirmation will have a verification status of true.

Responses

200

Withdrawal addresses retrieved.

application/json

Schema

Schema

result object[]
Withdrawal Addresses
Array [
address string
Withdrawal address
asset string
Name of asset being withdrawn
method string
Name of the withdrawal method
key string
Withdrawal key name, as set up on your account
tag string
Contains tags for XRP deposit addresses and memos for STX, XLM, and EOS deposit addresses
verified boolean
Verification status of withdrawal address
]
error string[]

Example (from schema)

{
  "error": [],
  "result": [
    {
      "address": "bc1qxdsh4sdd29h6ldehz0se5c61asq8cgwyjf2y3z",
      "asset": "XBT",
      "method": "Bitcoin",
      "key": "btc-wallet-1",
      "verified": true
    }
  ]
}

Loading...