{
"success": false,
"error": {
"code": "FEATURE_DISABLED",
"message": "A required service is temporarily unavailable."
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
Withdrawals
Withdraw cash
Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.
POST
/
withdrawals
Error
A valid request URL is required to generate request examples
{
"success": false,
"error": {
"code": "FEATURE_DISABLED",
"message": "A required service is temporarily unavailable."
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
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
Hide child attributes
source.venue
enum<string>
required
The venue whose cash is withdrawn.
Available options:
polymarket,
hyperliquid
source.asset
enum<string>
required
The asset the venue holds the cash in: pusd on Polymarket, usdc on Hyperliquid.
Available options:
pusd,
usdc
destination
object
required
Hide child attributes
destination.chain
enum<string>
required
The chain the cash is paid out on. Every venue pays out on each of these chains.
Available options:
polygon,
arbitrum,
base,
optimism,
ethereum,
bsc,
solana
destination.asset
enum<string>
required
The asset the destination receives.
Available options:
pusd,
usdc
destination.address
string
required
The address that receives the cash: a Solana address on solana, a 0x address on any other chain.
Maximum string length: 44
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
Option 1
Option 2
success
enum<boolean>
required
Available options:
true
data
object
required
Hide child attributes
data.id
string<uuid>
required
data.source
object
required
Hide child attributes
data.source.venue
enum<string>
required
The venue whose cash is withdrawn.
Available options:
polymarket,
hyperliquid
data.source.asset
enum<string>
required
The asset the venue holds the cash in: pusd on Polymarket, usdc on Hyperliquid.
Available options:
pusd,
usdc
data.destination
object
required
Hide child attributes
data.destination.chain
enum<string>
required
The chain the cash is paid out on. Every venue pays out on each of these chains.
Available options:
polygon,
arbitrum,
base,
optimism,
ethereum,
bsc,
solana
data.destination.asset
enum<string>
required
The asset the destination receives.
Available options:
pusd,
usdc
data.destination.address
string
required
The address that receives the cash: a Solana address on solana, a 0x address on any other chain.
Maximum string length: 44
data.amount
string
required
How much of the source asset was withdrawn.
Minimum string length: 1
data.fee
string
required
What the venue's payout quote took from the amount when the withdrawal was made. Zero for a test withdrawal.
Minimum string length: 1
data.net_amount
string
required
What the destination was quoted to receive: the amount less the fee, in the destination asset.
Minimum string length: 1
data.status
enum<string>
required
pending until the venue settles the payment, then completed, or failed when nothing was paid out. A test withdrawal is completed at once.
Available options:
pending,
completed,
failed
data.failure_reason
string | null
required
Why a failed withdrawal did not pay out. Null unless status is failed.
data.client_withdrawal_id
string
required
Minimum string length: 1
data.created_at
string<date-time>
required
data.livemode
boolean
required
meta
object
required
Hide child attributes
meta.timestampMs
integer
required
Required range: x >= 0
meta.requestId
string
required
Minimum string length: 1
meta.traceId
string
Minimum string length: 1
meta.cachedAtMs
integer
Required range: x >= 0
meta.source
enum<string>
Available options:
cache,
database,
clickhouse,
upstream,
fallback,
internal
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lean API","colors":{"primary":"#2F5BFF","light":"#8EA6FF","dark":"#3D66FF"},"logo":{"light":"https://mintcdn.com/lean/aK_dPkAAQjEsgndO/logo/light.svg?fit=max\u0026auto=format\u0026n=aK_dPkAAQjEsgndO\u0026q=85\u0026s=6f5d064937ce6cfedc8198e9ba927287","dark":"https://mintcdn.com/lean/aK_dPkAAQjEsgndO/logo/dark.svg?fit=max\u0026auto=format\u0026n=aK_dPkAAQjEsgndO\u0026q=85\u0026s=6d4c29348beb6f1c14aa1aecb4003afd","href":"/"},"api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript"],"prefill":true}},"appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#0C0F17"}},"navbar":{"links":[{"href":"https://lean.mintlify.site/api-reference/openapi.json","label":"OpenAPI spec"}],"primary":{"type":"button","label":"Quickstart","href":"/quickstart"}},"footer":{"links":[{"header":"Lean API v0.1","items":[{"label":"Limitations","href":"/"},{"label":"Changelog","href":"/changelog"},{"label":"OpenAPI spec","href":"https://lean.mintlify.site/api-reference/openapi.json"}]}]},"fonts":{"family":"Geist"},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lean","hasAudioNarration":false,"actualSubdomain":"lean","customDomains":[],"gitSource":{"type":"github","owner":"nivasaurus","repo":"lean-api-docs-demo","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae2d9189e92e136d8b49833"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afba544821a1e85a5162553","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":62},{"language":"default","tag":"Guides","count":32},{"language":"default","tag":"Orders","count":13},{"language":"default","tag":"Use cases","count":13},{"language":"default","tag":"API keys","count":11},{"language":"default","tag":"Account","count":9},{"language":"default","tag":"Markets","count":7},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Transfers","count":5},{"language":"default","tag":"Limit chases","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--lean-ink: #09090b;--lean-ink-2: #2b2d34;--lean-slate: #5d6270;--lean-faint: #8a8f9c;--lean-line: #e7e8ec;--lean-line-2: #f0f1f4;--lean-mist: #f7f8fa;--lean-cobalt: #2f5bff;--lean-cobalt-ink: #1f43d6;--lean-night: #0c0f17;--lean-night-2: #131826;--lean-night-line: #1f2536}code,pre,kbd{font-family:'Geist Mono', ui-monospace, 'SF Mono', Menlo, monospace}.prose h1,.prose h2,.prose h3{letter-spacing:-0.025em;font-weight:600}.prose h2{padding-top:28px;border-top:1px solid var(--lean-line)}.dark .prose h2{border-top-color:#ffffff14}.prose :not(pre)>code{font-size:.86em;background:var(--lean-mist);border:1px solid var(--lean-line-2);padding:1px 5px;border-radius:5px;color:var(--lean-ink-2)}.dark .prose :not(pre)>code{background:#ffffff0d;border-color:#ffffff14;color:#e6e9f2}.prose table{font-size:14px}.prose thead th{font-weight:500;font-size:13px;color:var(--lean-faint);border-bottom:1px solid var(--lean-ink)}.prose tbody td{border-bottom:1px solid var(--lean-line-2);vertical-align:top}.dark .prose thead th{border-bottom-color:#ffffff55}.dark .prose tbody td{border-bottom-color:#ffffff12}#content-area:has(.lean-hero)>#header{display:none}#content-area:has(.lean-hero)>#content{margin-top:0}.lean-hero{background:var(--lean-night);color:#fff;border-radius:18px;padding:56px 48px;margin:8px 0 56px;border:1px solid var(--lean-night-line);background-image:radial-gradient(1200px 400px at 85% -10%, #2f5bff33, transparent 60%)}.lean-kicker{display:inline-flex;align-items:center;gap:10px;font-size:13px;color:#b9c1d4;border:1px solid #ffffff1f;background:#ffffff08;border-radius:999px;padding:5px 14px 5px 6px;margin-bottom:24px}.lean-kicker b{font:500 11.5px/1 'Geist Mono', monospace;color:#fff;background:var(--lean-cobalt);border-radius:999px;padding:5px 8px}.lean-hero h1.lean-title{font-size:clamp(36px, 4.6vw, 56px);line-height:1.04;letter-spacing:-0.045em;font-weight:600;margin:0 0 20px;max-width:14ch;color:#fff;border:0;padding:0}.lean-lede{font-size:18px;line-height:1.6;color:#aeb6c8;max-width:48ch;margin:0 0 32px}.lean-cta{display:flex;gap:12px;flex-wrap:wrap}.lean-btn{display:inline-flex;align-items:center;height:40px;padding:0 18px;border-radius:10px;font-size:14.5px;font-weight:500;text-decoration:none!important;border:1px solid transparent}.lean-btn-primary{background:var(--lean-cobalt);color:#fff!important}.lean-btn-primary:hover{background:var(--lean-cobalt-ink)}.lean-btn-ghost{color:#fff!important;border-color:#ffffff2e;background:#ffffff08}.lean-btn-ghost:hover{background:#ffffff14;border-color:#ffffff44}.lean-facts{display:flex;flex-wrap:wrap;gap:20px 36px;margin-top:44px;padding-top:24px;border-top:1px solid #ffffff14;color:#8d95a8;font-size:13.5px}.lean-facts strong{display:block;color:#fff;font-weight:500;font-size:15px;margin-bottom:2px}.lean-steps{list-style:none;margin:24px 0 8px;padding:0!important;display:grid;grid-template-columns:repeat(5, minmax(0, 1fr));border-top:1px solid var(--lean-ink)}.dark .lean-steps{border-top-color:#ffffff55}.lean-steps li{padding:20px 20px 4px 0;margin:0!important}.lean-steps li+li{padding-left:20px;border-left:1px solid var(--lean-line)}.dark .lean-steps li+li{border-left-color:#ffffff14}.lean-steps li::marker{content:none}.lean-step-n{font:500 13px/1 'Geist Mono', monospace;color:var(--lean-faint);display:block;margin-bottom:28px}.lean-steps h3{font-size:16px;margin:0 0 6px;border:0;padding:0}.lean-steps p{margin:0 0 14px;color:var(--lean-slate);font-size:14px;line-height:1.6}.dark .lean-steps p{color:#9aa2b5}.lean-chip{display:inline-flex;flex-wrap:wrap;gap:8px;align-items:center;max-width:100%;padding:7px 10px;border-radius:8px;background:var(--lean-mist);border:1px solid var(--lean-line);font:500 12.5px/1.2 'Geist Mono', monospace;color:var(--lean-ink-2)!important;text-decoration:none!important;border-bottom-width:1px!important}.lean-chip:hover{border-color:#cfd3dc;color:var(--lean-ink)!important}.lean-chip code{background:none!important;border:0!important;padding:0!important;font:inherit!important;color:inherit!important}.dark .lean-chip{background:var(--lean-night-2);border-color:var(--lean-night-line);color:#d5dae6!important}.dark .lean-chip:hover{border-color:#3a4258;color:#fff!important}.lean-verb{font:600 10.5px/1 'Geist Mono', monospace;letter-spacing:.02em;padding:3px 5px;border-radius:4px}.lean-verb-get{color:#0f8a5f;background:#e7f6ef}.lean-verb-post{color:#2f5bff;background:#eef2ff}.dark .lean-verb-get{color:#4fd1a0;background:#0f8a5f26}.dark .lean-verb-post{color:#8ea6ff;background:#2f5bff26}@media (max-width: 1279px){.lean-steps{grid-template-columns:repeat(2, minmax(0, 1fr))}.lean-steps li,.lean-steps li+li{padding:20px 20px 16px 0;border-left:0;border-bottom:1px solid var(--lean-line)}.dark .lean-steps li,.dark .lean-steps li+li{border-bottom-color:#ffffff14}.lean-step-n{margin-bottom:14px}}@media (max-width: 700px){.lean-hero{padding:40px 24px}.lean-steps{grid-template-columns:1fr}}body,body *{-webkit-hyphens:none!important;hyphens:none!important}"}],"page":{"pagePath":"api-reference/withdrawals/create-withdrawal","slug":"/api-reference/withdrawals/create-withdrawal","pageMetadata":{"title":"Withdraw cash","openapi":"api-reference/openapi.json POST /withdrawals","description":"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.","href":"/api-reference/withdrawals/create-withdrawal"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Withdraw cash","openapi":"api-reference/openapi.json POST /withdrawals","description":"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.","href":"/api-reference/withdrawals/create-withdrawal"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createWithdrawal","summary":"Withdraw cash","description":"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.","tags":["Withdrawals"],"requestBody":"a43288c0-8f20-4bff-bd6a-9d0fb4fe1bda","responses":{"200":"b9efcc81-d9c5-4b2e-8f4b-4f100668a91e","400":"a3af3fce-b15e-45a4-b9cf-cae73f748071","401":"07d2c92c-8394-4546-8c9a-b62cacaf27e9","403":"c587a430-020b-44ff-a831-4f3b308b083e","409":"a65d81e6-5a02-48e0-9f8c-cd6c161a4443","422":"279ec24f-42fe-43ae-b5ac-2041ec1c9b7a","429":"1f67e353-4df6-44d0-b290-c83d47eb5b54","500":"03a5c877-6002-413b-8ba9-533302486c1b","503":"c03ae852-c546-482a-a154-600f4104b5bf"},"method":"post","type":"path","servers":["b9d200f3-058d-4de6-ac62-d3daef380488"],"security":["c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd"],"path":"/withdrawals","baseUrlOptions":["{baseUrl}/v1"],"title":"Withdraw cash","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.source.venue":"polymarket","body.source.asset":"pusd","body.destination.chain":"polygon","body.destination.asset":"usdc","body.destination.address":"0x00000000000000000000000000000000000000a1","body.amount":"25","body.client_withdrawal_id":"payout-0001"}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"object","properties":{"venue":{"type":"string","enum":["polymarket","hyperliquid"],"description":"The venue whose cash is withdrawn.","isRequired":true,"uniqueKey":"source.venue","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["pusd","usdc"],"description":"The asset the venue holds the cash in: pusd on Polymarket, usdc on Hyperliquid.","isRequired":true,"uniqueKey":"source.asset","typeLabel":"enum\u003cstring>"}},"required":["venue","asset"],"additionalProperties":false,"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"destination":{"type":"object","properties":{"chain":{"type":"string","enum":["polygon","arbitrum","base","optimism","ethereum","bsc","solana"],"description":"The chain the cash is paid out on. Every venue pays out on each of these chains.","isRequired":true,"uniqueKey":"destination.chain","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["pusd","usdc"],"description":"The asset the destination receives.","isRequired":true,"uniqueKey":"destination.asset","typeLabel":"enum\u003cstring>"},"address":{"type":"string","maxLength":44,"description":"The address that receives the cash: a Solana address on solana, a 0x address on any other chain.","isRequired":true,"uniqueKey":"destination.address","typeLabel":"string"}},"required":["chain","asset","address"],"additionalProperties":false,"isRequired":true,"uniqueKey":"destination","typeLabel":"object"},"amount":{"type":"string","description":"How much of the source asset to withdraw, with at most 6 decimal places. The fee comes out of this amount.","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"client_withdrawal_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","description":"Your id for this withdrawal, unique per key. Sending the same request again returns the withdrawal already made instead of making another.","isRequired":true,"uniqueKey":"client_withdrawal_id","typeLabel":"string"}},"required":["source","destination","amount","client_withdrawal_id"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"source":{"venue":"polymarket","asset":"pusd"},"destination":{"chain":"polygon","asset":"usdc","address":"0x00000000000000000000000000000000000000a1"},"amount":"25","client_withdrawal_id":"payout-0001"},"examples":{"Example":{"title":"Example","value":{"source":{"venue":"polymarket","asset":"pusd"},"destination":{"chain":"polygon","asset":"usdc","address":"0x00000000000000000000000000000000000000a1"},"amount":"25","client_withdrawal_id":"payout-0001"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b9efcc81-d9c5-4b2e-8f4b-4f100668a91e":{"description":"The withdrawal","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["success","data","meta"],"properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"oneOf.0.success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.id","typeLabel":"string\u003cuuid>"},"source":{"type":"object","properties":{"venue":{"type":"string","enum":["polymarket","hyperliquid"],"description":"The venue whose cash is withdrawn.","isRequired":true,"uniqueKey":"oneOf.0.data.source.venue","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["pusd","usdc"],"description":"The asset the venue holds the cash in: pusd on Polymarket, usdc on Hyperliquid.","isRequired":true,"uniqueKey":"oneOf.0.data.source.asset","typeLabel":"enum\u003cstring>"}},"required":["venue","asset"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.source","typeLabel":"object"},"destination":{"type":"object","properties":{"chain":{"type":"string","enum":["polygon","arbitrum","base","optimism","ethereum","bsc","solana"],"description":"The chain the cash is paid out on. Every venue pays out on each of these chains.","isRequired":true,"uniqueKey":"oneOf.0.data.destination.chain","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["pusd","usdc"],"description":"The asset the destination receives.","isRequired":true,"uniqueKey":"oneOf.0.data.destination.asset","typeLabel":"enum\u003cstring>"},"address":{"type":"string","maxLength":44,"description":"The address that receives the cash: a Solana address on solana, a 0x address on any other chain.","isRequired":true,"uniqueKey":"oneOf.0.data.destination.address","typeLabel":"string"}},"required":["chain","asset","address"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.destination","typeLabel":"object"},"amount":{"type":"string","minLength":1,"description":"How much of the source asset was withdrawn.","isRequired":true,"uniqueKey":"oneOf.0.data.amount","typeLabel":"string"},"fee":{"type":"string","minLength":1,"description":"What the venue's payout quote took from the amount when the withdrawal was made. Zero for a test withdrawal.","isRequired":true,"uniqueKey":"oneOf.0.data.fee","typeLabel":"string"},"net_amount":{"type":"string","minLength":1,"description":"What the destination was quoted to receive: the amount less the fee, in the destination asset.","isRequired":true,"uniqueKey":"oneOf.0.data.net_amount","typeLabel":"string"},"status":{"type":"string","enum":["pending","completed","failed"],"description":"pending until the venue settles the payment, then completed, or failed when nothing was paid out. A test withdrawal is completed at once.","isRequired":true,"uniqueKey":"oneOf.0.data.status","typeLabel":"enum\u003cstring>"},"failure_reason":{"oneOf":[{"type":"string","description":"Why a failed withdrawal did not pay out. Null unless status is failed.","isRequired":true,"uniqueKey":"oneOf.0.data.failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why a failed withdrawal did not pay out. Null unless status is failed.","isRequired":true,"uniqueKey":"oneOf.0.data.failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.failure_reason","typeLabel":"string | null"},"client_withdrawal_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.client_withdrawal_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.created_at","typeLabel":"string\u003cdate-time>"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.livemode","typeLabel":"boolean"}},"required":["id","source","destination","amount","fee","net_amount","status","failure_reason","client_withdrawal_id","created_at","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.0.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.0.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.0.meta","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["success","error","meta"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"oneOf.1.success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"oneOf.1.error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.1.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.1.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.1.meta","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"id":"8f14e45f-ceea-4672-a5b0-6f1c9d2b7a31","source":{"venue":"polymarket","asset":"pusd"},"destination":{"chain":"polygon","asset":"usdc","address":"0x00000000000000000000000000000000000000a1"},"amount":"25","fee":"0.12","net_amount":"24.88","status":"completed","failure_reason":null,"client_withdrawal_id":"payout-0001","created_at":"2026-11-10T15:00:00.000Z","livemode":true},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"8f14e45f-ceea-4672-a5b0-6f1c9d2b7a31","source":{"venue":"polymarket","asset":"pusd"},"destination":{"chain":"polygon","asset":"usdc","address":"0x00000000000000000000000000000000000000a1"},"amount":"25","fee":"0.12","net_amount":"24.88","status":"completed","failure_reason":null,"client_withdrawal_id":"payout-0001","created_at":"2026-11-10T15:00:00.000Z","livemode":true},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a3af3fce-b15e-45a4-b9cf-cae73f748071":{"description":"The request is invalid, names an unsupported source and destination pair, or the venue cannot pay this withdrawal out","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Invalid request"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Invalid request"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"07d2c92c-8394-4546-8c9a-b62cacaf27e9":{"description":"Missing, invalid, expired or revoked API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Invalid, expired or revoked API key"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Invalid, expired or revoked API key"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c587a430-020b-44ff-a831-4f3b308b083e":{"description":"The key lacks the withdraw scope, or details.reason is ACCOUNT_NOT_DELEGATED","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"FORBIDDEN","message":"This API key lacks the scope this route needs"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"FORBIDDEN","message":"This API key lacks the scope this route needs"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a65d81e6-5a02-48e0-9f8c-cd6c161a4443":{"description":"client_withdrawal_id was already used with a different request, the venue wallet is not set up, or details.reason is WITHDRAWAL_IN_PROGRESS","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"CONFLICT","message":"The request conflicts with the current state"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"CONFLICT","message":"The request conflicts with the current state"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"279ec24f-42fe-43ae-b5ac-2041ec1c9b7a":{"description":"details.reason is WITHDRAWAL_LIMIT_EXCEEDED, DAILY_WITHDRAWAL_LIMIT_EXCEEDED or INSUFFICIENT_BALANCE","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Refused by a limit; nothing was changed"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Refused by a limit; nothing was changed"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1f67e353-4df6-44d0-b290-c83d47eb5b54":{"description":"API error","headers":{"Retry-After":{"description":"Seconds remaining in the upstream read cooldown, when available","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"RATE_LIMITED","message":"Too many requests for this API key"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"RATE_LIMITED","message":"Too many requests for this API key"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"03a5c877-6002-413b-8ba9-533302486c1b":{"description":"API error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"INTERNAL_ERROR","message":"An internal error occurred."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INTERNAL_ERROR","message":"An internal error occurred."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c03ae852-c546-482a-a154-600f4104b5bf":{"description":"Trading is paused for this key or its trading account, or the venue is unavailable and nothing was paid","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"FEATURE_DISABLED","message":"A required service is temporarily unavailable."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"FEATURE_DISABLED","message":"A required service is temporarily unavailable."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd":{"apiKey":{"type":"http","scheme":"bearer","description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. 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`.","scopes":[],"schemeName":"apiKey"}}},"servers":{"b9d200f3-058d-4de6-ac62-d3daef380488":{"url":"{baseUrl}/v1","description":"Lean API","variables":{"baseUrl":{"default":"https://api.lean.xyz","description":"The Lean API base URL, without /v1. Same value as LEAN_API_URL in the guides."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. 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`.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. 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`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"lean","siteName":"Lean API","title":"Withdraw cash - Lean API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T23:47:19.418Z","originalFileLocation":"api-reference/withdrawals/create-withdrawal.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lean API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lean/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lean/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lean/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lean/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Withdraw cash - Lean API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lean API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lean.mintlify.site/_mintlify/api/og/v2?division=Withdrawals\u0026amp;title=Withdraw+cash\u0026amp;description=Withdraws+cash+from+one+venue+of+this+key%E2%80%99s+trading+account+to+the+address+the+request+names.+The+request+names+the+source+venue+and+the+asset+it+holds%2C+the+des\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=a4e6a56ed9d6073c7e609d960e5ba6bd9ba2fabfd20f4ac82b232faeb13fc549\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Withdraw cash - Lean API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lean.mintlify.site/_mintlify/api/og/v2?division=Withdrawals\u0026amp;title=Withdraw+cash\u0026amp;description=Withdraws+cash+from+one+venue+of+this+key%E2%80%99s+trading+account+to+the+address+the+request+names.+The+request+names+the+source+venue+and+the+asset+it+holds%2C+the+des\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=a4e6a56ed9d6073c7e609d960e5ba6bd9ba2fabfd20f4ac82b232faeb13fc549\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/lean/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lean API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2F5BFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/withdrawals/create-withdrawal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://lean.mintlify.app/#organization\",\"name\":\"Lean API\",\"url\":\"https://lean.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lean/aK_dPkAAQjEsgndO/logo/light.svg?fit=max\u0026auto=format\u0026n=aK_dPkAAQjEsgndO\u0026q=85\u0026s=6f5d064937ce6cfedc8198e9ba927287\"}},{\"@type\":\"WebSite\",\"@id\":\"https://lean.mintlify.app#website\",\"name\":\"Lean API\",\"url\":\"https://lean.mintlify.app\",\"publisher\":{\"@id\":\"https://lean.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal#webpage\",\"url\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal\",\"name\":\"Withdraw cash\",\"description\":\"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\",\"dateModified\":\"2026-11-12T23:47:19.418Z\",\"isPartOf\":{\"@id\":\"https://lean.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lean API\",\"item\":\"https://lean.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Withdraw cash\",\"item\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal#apireference\",\"headline\":\"Withdraw cash\",\"name\":\"Withdraw cash\",\"description\":\"Withdraws cash from one venue of this key’s trading account to the address the request names. The request names the source venue and the asset it holds, the destination chain, asset and address, and the amount of the source asset. Each venue pays out one asset as usdc, on any chain that destination.chain lists: pusd on Polymarket and usdc on Hyperliquid. Any other pair of assets is refused with a 400. The key needs the withdraw scope, and each withdrawal must fit the key’s optional per withdrawal limit, its optional limit across the last 24 hours and the venue’s available cash. The venue’s fee comes out of the amount: the response gives the fee and the net amount the destination is quoted to receive. A live withdrawal needs trading enabled for the account in the Lean app and is submitted once: it starts pending and becomes completed or failed as the venue settles it, with failure_reason saying why a failed one paid nothing. A Polymarket withdrawal is completed once the funds leave the account for Polymarket’s bridge, which then pays the USDC on the destination chain; a Hyperliquid withdrawal is completed once the USDC arrives on the destination chain. A test withdrawal moves nothing, charges no fee, completes at once and lowers the simulated cash on that venue until test mode is reset. Sending the same client_withdrawal_id again returns the withdrawal already made.\",\"url\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal\",\"mainEntityOfPage\":{\"@id\":\"https://lean.mintlify.app/api-reference/withdrawals/create-withdrawal#webpage\"},\"dateModified\":\"2026-11-12T23:47:19.418Z\",\"publisher\":{\"@id\":\"https://lean.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://lean.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lean API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Lean API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/withdrawals/create-withdrawal.md","siteName":"Lean API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases"}]},{"tab":"API reference","groups":[{"group":"Markets","pages":[{"title":"List markets","openapi":"api-reference/openapi.json GET /markets","href":"/api-reference/markets/list-markets"},{"title":"Get a market","openapi":"api-reference/openapi.json GET /markets/{id}","href":"/api-reference/markets/retrieve-market"},{"title":"Quote a market","openapi":"api-reference/openapi.json GET /markets/{id}/quote","href":"/api-reference/markets/quote-market"},{"title":"Get a market orderbook","openapi":"api-reference/openapi.json GET /markets/{id}/book","href":"/api-reference/markets/retrieve-market-book"},{"title":"Get recent trades","openapi":"api-reference/openapi.json GET /markets/{id}/trades","href":"/api-reference/markets/list-market-trades"},{"title":"Get price candles","openapi":"api-reference/openapi.json GET /markets/{id}/candles","href":"/api-reference/markets/get-market-candles"},{"title":"Get prices","openapi":"api-reference/openapi.json GET /prices","href":"/api-reference/markets/list-prices"}]},{"group":"Orders","pages":[{"title":"Preview an order","openapi":"api-reference/openapi.json POST /orders/preview","href":"/api-reference/orders/preview-order"},{"title":"Preview several orders","openapi":"api-reference/openapi.json POST /orders/preview-batch","href":"/api-reference/orders/preview-orders-batch"},{"title":"Create an order","openapi":"api-reference/openapi.json POST /orders","href":"/api-reference/orders/create-order"},{"title":"List orders","openapi":"api-reference/openapi.json GET /orders","href":"/api-reference/orders/list-orders"},{"title":"Retrieve an order","openapi":"api-reference/openapi.json GET /orders/{id}","href":"/api-reference/orders/retrieve-order"},{"title":"Amend an order","openapi":"api-reference/openapi.json PATCH /orders/{id}","href":"/api-reference/orders/amend-order"},{"title":"Cancel an order","openapi":"api-reference/openapi.json POST /orders/{id}/cancel","href":"/api-reference/orders/cancel-order"},{"title":"Cancel every open order","openapi":"api-reference/openapi.json POST /orders/cancel-all","href":"/api-reference/orders/cancel-all-orders"},{"title":"Set a cancel timer","openapi":"api-reference/openapi.json POST /orders/cancel-after","href":"/api-reference/orders/set-cancel-after"},{"title":"Cancel several orders","openapi":"api-reference/openapi.json POST /orders/cancel-batch","href":"/api-reference/orders/cancel-orders-batch"},{"title":"List fills","openapi":"api-reference/openapi.json GET /fills","href":"/api-reference/orders/list-fills"},{"title":"Place a routed order","openapi":"api-reference/openapi.json POST /routed-orders","href":"/api-reference/orders/create-routed-order"},{"title":"Execute a routed order","openapi":"api-reference/openapi.json POST /routed-orders/{id}/execute","href":"/api-reference/orders/execute-routed-order"}]},{"group":"Stop losses","pages":[{"title":"Create a stop loss or take profit","openapi":"api-reference/openapi.json POST /stop-losses","href":"/api-reference/stop-losses/create-stop-loss"},{"title":"List stop losses","openapi":"api-reference/openapi.json GET /stop-losses","href":"/api-reference/stop-losses/list-stop-losses"},{"title":"Get a stop loss","openapi":"api-reference/openapi.json GET /stop-losses/{id}","href":"/api-reference/stop-losses/retrieve-stop-loss"},{"title":"Cancel a stop loss","openapi":"api-reference/openapi.json DELETE /stop-losses/{id}","href":"/api-reference/stop-losses/cancel-stop-loss"}]},{"group":"Limit chases","pages":[{"title":"Create a limit chase","openapi":"api-reference/openapi.json POST /limit-chases","href":"/api-reference/limit-chases/create-limit-chase"},{"title":"List limit chases","openapi":"api-reference/openapi.json GET /limit-chases","href":"/api-reference/limit-chases/list-limit-chases"},{"title":"Get a limit chase","openapi":"api-reference/openapi.json GET /limit-chases/{id}","href":"/api-reference/limit-chases/retrieve-limit-chase"},{"title":"Cancel a limit chase","openapi":"api-reference/openapi.json DELETE /limit-chases/{id}","href":"/api-reference/limit-chases/cancel-limit-chase"}]},{"group":"Account","pages":[{"title":"List positions","openapi":"api-reference/openapi.json GET /positions","href":"/api-reference/account/list-positions"},{"title":"Close positions","openapi":"api-reference/openapi.json POST /positions/close","href":"/api-reference/account/close-positions"},{"title":"List balances","openapi":"api-reference/openapi.json GET /balances","href":"/api-reference/account/list-balances"},{"title":"Get profit and loss","openapi":"api-reference/openapi.json GET /pnl","href":"/api-reference/account/get-pnl"},{"title":"Get profit and loss history","openapi":"api-reference/openapi.json GET /pnl/history","href":"/api-reference/account/get-pnl-history"},{"title":"Get risk","openapi":"api-reference/openapi.json GET /risk","href":"/api-reference/account/get-risk"},{"title":"Get account configuration","openapi":"api-reference/openapi.json GET /account/config","href":"/api-reference/account/retrieve-account-config"},{"title":"Lower this key's limits","openapi":"api-reference/openapi.json POST /account/limits","href":"/api-reference/account/lower-key-limits"},{"title":"Pause order placement","openapi":"api-reference/openapi.json POST /account/pause","href":"/api-reference/account/pause-trading"}]},{"group":"Deposits","pages":[{"title":"List deposit assets","openapi":"api-reference/openapi.json GET /deposits/assets","href":"/api-reference/deposits/list-deposit-assets"},{"title":"Get deposit addresses","openapi":"api-reference/openapi.json GET /deposits/addresses","href":"/api-reference/deposits/list-deposit-addresses"},{"title":"Create deposit addresses","openapi":"api-reference/openapi.json POST /deposits/addresses","description":"Only needed if you haven’t already created a deposit address in the Lean app. Creates every deposit address the key’s trading account is missing on one venue and returns all of them. An address the provider cannot open right now is listed in missing while the others are still created and returned; call again later for it. Repeating it returns the same addresses and creates no others. It moves no money. Send only an asset GET /deposits/assets lists for the same venue, provider and address type. Hyperliquid addresses come only from Relay and credit Hyperliquid spot USDC. Do not use Hyperliquid’s own bridge: sending to Hyperliquid’s own bridge lands in perps, not in the spot balance these addresses fund. A test key gets placeholders that are not addresses on any chain.","href":"/api-reference/deposits/create-deposit-addresses"}]},{"group":"Withdrawals","pages":[{"title":"Withdraw cash","openapi":"api-reference/openapi.json POST /withdrawals","href":"/api-reference/withdrawals/create-withdrawal"},{"title":"List withdrawals","openapi":"api-reference/openapi.json GET /withdrawals","description":"Withdrawals this key’s trading account made in this key’s mode, newest first.","href":"/api-reference/withdrawals/list-withdrawals"},{"title":"Get a withdrawal","openapi":"api-reference/openapi.json GET /withdrawals/{id}","href":"/api-reference/withdrawals/retrieve-withdrawal"}]},{"group":"Transfers","pages":[{"title":"Quote a transfer","openapi":"api-reference/openapi.json POST /transfers/quote","href":"/api-reference/transfers/quote-transfer"},{"title":"Create a transfer","openapi":"api-reference/openapi.json POST /transfers","href":"/api-reference/transfers/create-transfer"},{"title":"Execute a transfer","openapi":"api-reference/openapi.json POST /transfers/{id}/execute","href":"/api-reference/transfers/execute-transfer"},{"title":"List transfers","openapi":"api-reference/openapi.json GET /transfers","href":"/api-reference/transfers/list-transfers"},{"title":"Get a transfer","openapi":"api-reference/openapi.json GET /transfers/{id}","href":"/api-reference/transfers/retrieve-transfer"}]},{"group":"Streaming","pages":[{"title":"Create a stream ticket","openapi":"api-reference/openapi.json POST /ws/token","href":"/api-reference/streaming/create-stream-ticket"},{"title":"WebSocket","href":"/api-reference/streaming/websocket"}]},{"group":"Test mode","pages":[{"title":"Reset test mode","openapi":"api-reference/openapi.json POST /test/reset","href":"/api-reference/test-mode/reset-test-mode"}]},{"group":"API keys","pages":[{"title":"Create an API key","openapi":"api-reference/openapi.json POST /api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"List API keys","openapi":"api-reference/openapi.json GET /api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Revoke an API key","openapi":"api-reference/openapi.json DELETE /api-keys/{id}","href":"/api-reference/api-keys/revoke-api-key"},{"title":"Change an API key's limits","openapi":"api-reference/openapi.json PATCH /api-keys/{id}/limits","href":"/api-reference/api-keys/update-api-key-limits"},{"title":"Pause an API key","openapi":"api-reference/openapi.json PUT /api-keys/{id}/suspension","href":"/api-reference/api-keys/pause-api-key"},{"title":"Resume an API key","openapi":"api-reference/openapi.json DELETE /api-keys/{id}/suspension","href":"/api-reference/api-keys/resume-api-key"},{"title":"Get a trading account's API limits","openapi":"api-reference/openapi.json GET /api-keys/accounts/{tradingAccountId}/limits","href":"/api-reference/api-keys/retrieve-account-limits"},{"title":"Set a trading account's API limits","openapi":"api-reference/openapi.json PUT /api-keys/accounts/{tradingAccountId}/limits","href":"/api-reference/api-keys/update-account-limits"},{"title":"List trading pauses","openapi":"api-reference/openapi.json GET /api-keys/suspensions","href":"/api-reference/api-keys/list-trading-pauses"},{"title":"Pause API trading on a trading account","openapi":"api-reference/openapi.json PUT /api-keys/accounts/{tradingAccountId}/suspension","href":"/api-reference/api-keys/pause-account-api-trading"},{"title":"Resume API trading on a trading account","openapi":"api-reference/openapi.json DELETE /api-keys/accounts/{tradingAccountId}/suspension","href":"/api-reference/api-keys/resume-account-api-trading"}]}]}]},"basePath":"","title":"Withdraw cash - Lean API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}