Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A Lean API key, sent as Authorization: Bearer <key>. A test key (lean_sk_test_...) simulates orders and fills with no money; a live key (lean_sk_live_...) trades for real within the key's limits. Every successful response says which mode answered in data.livemode.

Body

application/json
source
object
required
destination
object
required
amount
string
required

How much of the source asset to withdraw, with at most 6 decimal places. The fee comes out of this amount.

client_withdrawal_id
string
required

Your id for this withdrawal, unique per key. Sending the same request again returns the withdrawal already made instead of making another.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Response

The withdrawal

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required