Skip to main content
POST
Preview a withdrawal

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Wallet ID

Body

application/json
destinationChain
enum<string>
required

Target chain for the withdrawal. Use ethereum_sepolia or solana_devnet for sandbox testing.

Available options:
arbitrum,
base,
ethereum,
ethereum_sepolia,
polygon,
solana,
solana_devnet
token
enum<string>
required

Stablecoin lane used to validate, fund, rebalance, and withdraw an allocation independently from other token lanes.

Available options:
usdc,
usdt
amountUsd
number<double> | null

Gross wallet value to withdraw before execution fees. If omitted, the preview uses the maximum gross withdrawable amount.

sources
object[]

Optional exact gross source split when automatic rebalancing is disabled. Omit it to let Ground select sources automatically.

Minimum array length: 1

Response

Withdrawal preview

amountRequestedUsd
string
required

Gross wallet value evaluated by this preview. Equals the requested amount, or the resolved maximum gross withdrawable amount when amountUsd was omitted.

feeUsd
string
required

Estimated execution fee deducted from the gross requested amount, including yield source protocol exit fees.

amountToReceiveUsd
string
required

Estimated net amount to be sent to the destination after execution fees are deducted from the gross requested amount.

withdrawableUsd
string
required

Maximum gross wallet value that can safely start a new withdrawal for this destination right now.

totalUsdAfterWithdrawal
string
required

Estimated wallet total after the gross requested amount is removed.

processingEstimate
object
required