Skip to main content
POST
/
api
/
v1
/
user
/
vaults
/
withdraw
Withdraw funds
curl --request POST \
  --url https://api.ekiden.fi/api/v1/user/vaults/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addr_from": "0x1234567890abcdef...",
  "addr_to": "0x1234567890abcdef...",
  "amount": 10,
  "asset_metadata": "0x9876543210fedcba...",
  "nonce": "123456",
  "signature": "<string>",
  "timestamp": 1759745086,
  "withdraw_available": false
}
'
{
  "success": true,
  "total_withdrawn": 10
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
addr_from
string
required

Sub account address, owner of the trading account

Example:

"0x1234567890abcdef..."

​
addr_to
string
required

Sub account address, owner of the funding account

Example:

"0x1234567890abcdef..."

​
amount
integer<int64>
required

Amount to withdraw

Required range: x >= 0
Example:

10

​
asset_metadata
string
required

Asset address for the vaults, NOT part of the signed request

Example:

"0x9876543210fedcba..."

​
nonce
integer<int64>
required

Unique nonce of the request

Required range: x >= 0
Example:

"123456"

​
signature
string
required

Signature of the request, signed by the owner of the TRADING account

​
timestamp
integer<int64>
required

Timestamp of the request creation

Required range: x >= 0
Example:

1759745086

​
withdraw_available
boolean
required

If this is set to true, if the available balance if lower than the amount to withdraw, the available amount l be withdrawn instead of the requested amount.

Example:

false

Response

Withdrawn request processed successfully

​
success
boolean
required

True if withdraw successfully

Example:

true

​
total_withdrawn
integer<int64>
required

Total amount withdrawn

Required range: x >= 0
Example:

10