Skip to main content
cURL

Query Parameters

currency
enum<string>
required

The currency symbol.

๐Ÿ“– Related Article: Using the currency Parameter

Currency, i.e "BTC", "ETH", "USDC"

Available options:
BTC,
ETH,
USDC,
USDT,
EURR
address
string

Address in currency format, it must be in address book. Required for legacy wallet type. Coinbase wallet type: required when id is not provided โ€” the on-chain address (use network and tag to disambiguate entries sharing the same address) or the CTN counterparty identifier of an existing address book entry. Address in proper format for currency

Example:

"2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz"

amount
number
required

Amount of funds to be withdrawn

network
string

Blockchain network for the wallet operation, given as a network resource name (e.g. "networks/ethereum-mainnet"). Coinbase wallet type only. The networks available for each currency are returned by public/get_currencies in the coinbase_networks field. Required for operations that target an on-chain address or a deposit address; also used to disambiguate address book entries when the same address exists on multiple networks.

Example:

"networks/ethereum-mainnet"

tag
string

Destination tag / memo for networks that support one. Coinbase wallet type only. Used together with address and network; also serves to disambiguate address book entries that share the same address.

id
string

Unique identifier (UUID7) of the address book entry, as returned in the id field of private/get_address_book results. Coinbase wallet type only. Can be used instead of address (with network and tag) to identify the entry.

Example:

"0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b"

priority
enum<string>

Withdrawal priority, optional for BTC, default: high

Available options:
insane,
extreme_high,
very_high,
high,
mid,
low,
very_low
nonce
string

Optional idempotency nonce. If provided, subsequent requests with the same nonce will return the previously created transaction instead of creating a new one. Must be 8-128 characters. The nonce is persisted on the resulting transaction and returned in the response. Nonce

Example:

"bF1_gfgcsd"

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object
required
id
integer

The id that was sent in the request