Skip to main content
cURL

Query Parameters

currency
enum<string>
required

The currency symbol. Legacy wallet type: wallet currencies only. Coinbase wallet type: any portfolio currency or "all". Currency, i.e "BTC", "ETH", "USDC"

Available options:
BTC,
ETH,
USDC,
USDT,
EURR
Example:

"BTC"

type
enum<string>
required

Address book type

Available options:
transfer,
withdrawal
Example:

"transfer"

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; use network and tag to disambiguate entries sharing the same address. Address in proper format for currency

Example:

"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj"

network
string

Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present 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"

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
string
required

ok

Example:

"ok"

id
integer

The id that was sent in the request