Skip to main content
POST
Withdraw an asset

Authorizations

Authorization
string
header
required

API key issued via POST /api/public/v1/api-keys.

Body

application/json

The asset, destination, and amount to withdraw.

withdrawAddress
string
required

Destination address that receives the withdrawn asset.

Example:

"0x1234567890123456789012345678901234567890"

tokenAddress
string
required

ERC-20 contract address, or the native-ETH sentinel 0xEeee…EEeE.

Example:

"0x1234567890123456789012345678901234567890"

amount
string
required

Decimal amount to withdraw, e.g. "12.5", or "max" to withdraw the entire on-chain balance of the asset.

Minimum string length: 1
Example:

"12.5"

chain
enum<string>
default:base

Chain to withdraw from. Defaults to base when omitted.

Available options:
base,
robinhood
Example:

"base"

Response

The withdrawal was confirmed on-chain.

txHash
string
required

Hash of the confirmed on-chain transaction.

Example:

"0xa3f5c9e1b7d2048fa3f5c9e1b7d2048fa3f5c9e1b7d2048fa3f5c9e1b7d2048f"

chain
enum<string>
required

Chain the withdrawal was executed on.

Available options:
base,
robinhood
Example:

"base"

tokenAddress
string
required
Example:

"0x1234567890123456789012345678901234567890"

withdrawAddress
string
required
Example:

"0x1234567890123456789012345678901234567890"

amount
string
required

Atomic units actually transferred, base-10 string.

Example:

"12500000"