HomeDocumentationAPI Reference
Log In
API Reference

Withdraw

Method Name

private/withdraw

Withdraw an asset to wallet.

See public/withdraw_debug for debugging invalid signature issues or go to guides in Documentation.
Required minimum session key permission level is admin

Parameters

amountstringrequired
Amount of the asset to withdraw
asset_namestringrequired
Name of asset to withdraw
nonceintegerrequired
Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_6_digits) (e.g. 1695836058725001, where 001 is the random number)
signaturestringrequired
Ethereum signature of the withdraw
signature_expiry_secintegerrequired
Unix timestamp in seconds. Expiry MUST be >5min from now
signerstringrequired
Ethereum wallet address that is signing the withdraw
subaccount_idintegerrequired
Subaccount_id
is_atomic_signingboolean
Used by vaults to determine whether the signature is an EIP-1271 signature

Response

idstring or integerrequired
resultobjectrequired
result.statusstringrequired
requested
result.transaction_idstringrequired
Transaction id of the withdrawal

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}