{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "This API key lacks the scope this route needs"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "CONFLICT",
"message": "client_order_id was already used for a close with different parameters"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests for this API key"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "FEATURE_DISABLED",
"message": "Order placement is paused for this key"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
Account
Close positions
Sells each position of this key’s trading account in this key’s mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg’s error.
POST
/
positions
/
close
Error
A valid request URL is required to generate request examples
{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "This API key lacks the scope this route needs"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "CONFLICT",
"message": "client_order_id was already used for a close with different parameters"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests for this API key"
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
{
"success": false,
"error": {
"code": "FEATURE_DISABLED",
"message": "Order placement is paused for this key"
},
"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
client_order_id
string
required
Unique per API key, up to 40 characters. Each sell gets <client_order_id>-close-<hash>-<hash>, returned only in this response; replaying the id returns the sells already placed and places only those that are missing.
Maximum string length: 40
Pattern: ^[A-Za-z0-9_-]{1,40}$
max_slippage_bps
integer
required
Furthest each sell may trade below the best bid as read when it is placed, in basis points.
Required range: 0 <= x <= 10000
venue
enum<string>
Only this venue. Defaults to every venue.
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
market_id
string
Only this market. A market id from GET /markets, or a venue symbol that names one market: a Polymarket token id, a Hyperliquid book coin (#…, written %23… in a path), or a leg ticker (pm:…, hl:…, pmus:… or a Kalshi market ticker) that lists only this outcome. A symbol that names more than one market, such as a Polymarket condition id, is refused with 400; use the token id or the market id instead.
Required string length: 1 - 512
limit_price
string
Lowest price per share each sell accepts. Without it the close is a market close: ioc, each venue sell placed 1 cent below the worst price its quantity reaches in that venue's book and never below max_slippage_bps.
time_in_force
enum<string>
With limit_price: gtc rests the unfilled part, ioc cancels it. Defaults to gtc with limit_price and ioc without.
Available options:
gtc,
ioc
Response
One leg per position in scope
Option 1
Option 2
success
enum<boolean>
required
Available options:
true
data
object
required
Hide child attributes
data.outcome
enum<string>
required
What the close did overall. placed: every position that needed a sell has one. partial: some do, but a sell failed or a venue could not be read. failed: nothing that needed a sell got one. nothing_to_close: no position in scope needed a sell. A placed sell may still be filling or end unfilled; read each leg.
Available options:
placed,
partial,
failed,
nothing_to_close
data.legs
object[]
required
Hide child attributes
data.legs.venue
enum<string>
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.legs.ticker
string
required
Minimum string length: 1
data.legs.side
enum<string>
required
Available options:
yes,
no
data.legs.market_id
string | null
required
Minimum string length: 1
data.legs.client_order_id
string
required
Minimum string length: 1
data.legs.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.status
enum<string>
required
Available options:
placed,
replayed,
failed,
skipped
data.legs.order
object | null
required
Hide child attributes
data.legs.order.id
string<uuid>
required
data.legs.order.client_order_id
string
required
Minimum string length: 1
data.legs.order.market_id
string
required
The market id from GET /markets, however the request named the market.
Minimum string length: 1
data.legs.order.title
string | null
required
Minimum string length: 1
data.legs.order.outcome
string | null
required
Minimum string length: 1
data.legs.order.venue
enum<string> | null
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.legs.order.ticker
string | null
required
Minimum string length: 1
data.legs.order.side
enum<string> | null
required
Available options:
yes,
no
data.legs.order.action
enum<string>
required
Available options:
buy,
sell
data.legs.order.type
enum<string>
required
Available options:
limit,
market
data.legs.order.time_in_force
enum<string>
required
Available options:
gtc,
ioc,
fok,
gtd
data.legs.order.expires_at
string<date-time> | null
required
data.legs.order.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.filled_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.remaining_quantity
string
required
Shares still working on the venues: the unfilled size of each live venue order. Zero once the order is final, since a canceled, expired or rejected remainder no longer works.
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.limit_price
string
required
data.legs.order.avg_fill_price
string | null
required
Average price per share filled, size-weighted across the venue orders that filled, excluding fees. Null until every filled venue order has a price.
data.legs.order.notional_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.filled_notional_usd
string | null
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.status
enum<string>
required
Available options:
pending,
open,
partially_filled,
filled,
canceled,
rejected,
expired,
unconfirmed,
needs_attention,
cancel_requested
data.legs.order.venue_status
string | null
required
data.legs.order.venue_order_id
string | null
required
data.legs.order.status_reason
object | null
required
Hide child attributes
data.legs.order.status_reason.code
string
required
Minimum string length: 1
data.legs.order.status_reason.message
string
required
Minimum string length: 1
data.legs.order.legs
object[]
required
Hide child attributes
data.legs.order.legs.venue
enum<string>
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.legs.order.legs.ticker
string
required
Minimum string length: 1
data.legs.order.legs.side
enum<string>
required
Available options:
yes,
no
data.legs.order.legs.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.legs.filled_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.order.legs.limit_price
string
required
data.legs.order.legs.avg_fill_price
string | null
required
data.legs.order.legs.status
enum<string>
required
Available options:
pending,
open,
partially_filled,
filled,
canceled,
rejected,
expired,
unconfirmed,
needs_attention,
cancel_requested
data.legs.order.legs.venue_status
string | null
required
data.legs.order.legs.venue_order_id
string | null
required
data.legs.order.legs.cancel_requested_at
string<date-time> | null
required
data.legs.order.legs.status_reason
object | null
required
Hide child attributes
data.legs.order.legs.status_reason.code
string
required
Minimum string length: 1
data.legs.order.legs.status_reason.message
string
required
Minimum string length: 1
data.legs.order.post_only
boolean
required
data.legs.order.replaces_order_id
string<uuid> | null
required
data.legs.order.replaced_by_order_id
string<uuid> | null
required
data.legs.order.created_at
string<date-time>
required
data.legs.order.updated_at
string<date-time>
required
data.legs.order.livemode
boolean
required
data.legs.error
object | null
required
Hide child attributes
data.legs.error.code
string
required
Minimum string length: 1
data.legs.error.message
string
required
Minimum string length: 1
data.legs.error.details
unknown
data.unavailable_venues
enum<string>[]
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
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/account/close-positions","slug":"/api-reference/account/close-positions","pageMetadata":{"title":"Close positions","openapi":"api-reference/openapi.json POST /positions/close","description":"Sells each position of this key's trading account in this key's mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg's error.","href":"/api-reference/account/close-positions"},"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: \"Sells each position of this key’s trading account in this key’s mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg’s error.\"\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":"Close positions","openapi":"api-reference/openapi.json POST /positions/close","description":"Sells each position of this key's trading account in this key's mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg's error.","href":"/api-reference/account/close-positions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"closePositions","summary":"Close positions","description":"Sells each position of this key's trading account in this key's mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg's error.","tags":["Account"],"requestBody":"eb100c63-e3e0-459b-85ae-56bfec92af62","responses":{"200":"0cd60978-9471-459c-b559-38f7095ac37d","400":"452a2e9b-d585-4c58-a2f2-7e78d7e2c1ec","401":"f2940b6e-96be-41a8-b964-0e4ed7cb4f16","403":"d572c32b-d121-490a-aa59-c9f47c26cf0f","409":"6be3c7d2-cd6c-4bfd-84bc-d4d494c7f1ef","429":"451f7355-b1ed-40e3-87c7-19858046f56f","500":"89c686e6-47a4-4f4e-9260-9e221c6b2fed","503":"2eea4bae-774e-42b5-a014-523111746e62"},"method":"post","type":"path","servers":["b9d200f3-058d-4de6-ac62-d3daef380488"],"security":["c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd"],"path":"/positions/close","baseUrlOptions":["{baseUrl}/v1"],"title":"Close positions","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.client_order_id":"flatten-0001","body.max_slippage_bps":200}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"client_order_id":{"type":"string","maxLength":40,"pattern":"^[A-Za-z0-9_-]{1,40}$","description":"Unique per API key, up to 40 characters. Each sell gets `\u003cclient_order_id>-close-\u003chash>-\u003chash>`, returned only in this response; replaying the id returns the sells already placed and places only those that are missing.","isRequired":true,"uniqueKey":"client_order_id","typeLabel":"string"},"max_slippage_bps":{"type":"integer","minimum":0,"maximum":10000,"description":"Furthest each sell may trade below the best bid as read when it is placed, in basis points.","isRequired":true,"uniqueKey":"max_slippage_bps","typeLabel":"integer"},"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"description":"Only this venue. Defaults to every venue.","uniqueKey":"venue","typeLabel":"enum\u003cstring>"},"market_id":{"type":"string","minLength":1,"maxLength":512,"description":"Only this market. A market id from GET /markets, or a venue symbol that names one market: a Polymarket token id, a Hyperliquid book coin (`#…`, written `%23…` in a path), or a leg `ticker` (`pm:…`, `hl:…`, `pmus:…` or a Kalshi market ticker) that lists only this outcome. A symbol that names more than one market, such as a Polymarket condition id, is refused with 400; use the token id or the market id instead.","uniqueKey":"market_id","typeLabel":"string"},"limit_price":{"type":"string","description":"Lowest price per share each sell accepts. Without it the close is a market close: ioc, each venue sell placed 1 cent below the worst price its quantity reaches in that venue's book and never below max_slippage_bps.","uniqueKey":"limit_price","typeLabel":"string"},"time_in_force":{"type":"string","enum":["gtc","ioc"],"description":"With limit_price: gtc rests the unfilled part, ioc cancels it. Defaults to gtc with limit_price and ioc without.","uniqueKey":"time_in_force","typeLabel":"enum\u003cstring>"}},"required":["client_order_id","max_slippage_bps"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"client_order_id":"flatten-0001","max_slippage_bps":200},"examples":{"Example":{"title":"Example","value":{"client_order_id":"flatten-0001","max_slippage_bps":200}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"0cd60978-9471-459c-b559-38f7095ac37d":{"description":"One leg per position in scope","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":{"outcome":{"type":"string","enum":["placed","partial","failed","nothing_to_close"],"description":"What the close did overall. placed: every position that needed a sell has one. partial: some do, but a sell failed or a venue could not be read. failed: nothing that needed a sell got one. nothing_to_close: no position in scope needed a sell. A placed sell may still be filling or end unfilled; read each leg.","isRequired":true,"uniqueKey":"oneOf.0.data.outcome","typeLabel":"enum\u003cstring>"},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue","typeLabel":"enum\u003cstring>"},"ticker":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].ticker","typeLabel":"string"},"side":{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"market_id":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].market_id.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].market_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].market_id","typeLabel":"string | null"},"client_order_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].client_order_id","typeLabel":"string"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].quantity","typeLabel":"string"},"status":{"type":"string","enum":["placed","replayed","failed","skipped"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"order":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.id","typeLabel":"string\u003cuuid>"},"client_order_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.client_order_id","typeLabel":"string"},"market_id":{"type":"string","minLength":1,"description":"The market id from GET /markets, however the request named the market.","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.market_id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.title","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.outcome.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.outcome.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.outcome","typeLabel":"string | null"},"venue":{"oneOf":[{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue","typeLabel":"enum\u003cstring> | null"},"ticker":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.ticker.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.ticker.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.ticker","typeLabel":"string | null"},"side":{"oneOf":[{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.side.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.side.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.side","typeLabel":"enum\u003cstring> | null"},"action":{"type":"string","enum":["buy","sell"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.action","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["limit","market"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.type","typeLabel":"enum\u003cstring>"},"time_in_force":{"type":"string","enum":["gtc","ioc","fok","gtd"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.time_in_force","typeLabel":"enum\u003cstring>"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.quantity","typeLabel":"string"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.filled_quantity","typeLabel":"string"},"remaining_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","description":"Shares still working on the venues: the unfilled size of each live venue order. Zero once the order is final, since a canceled, expired or rejected remainder no longer works.","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.remaining_quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.limit_price","typeLabel":"string"},"avg_fill_price":{"oneOf":[{"type":"string","description":"Average price per share filled, size-weighted across the venue orders that filled, excluding fees. Null until every filled venue order has a price.","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.avg_fill_price.oneOf.0","typeLabel":"string"},{"type":"null","description":"Average price per share filled, size-weighted across the venue orders that filled, excluding fees. Null until every filled venue order has a price.","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.avg_fill_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.avg_fill_price","typeLabel":"string | null"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.notional_usd","typeLabel":"string"},"filled_notional_usd":{"oneOf":[{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.filled_notional_usd.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.filled_notional_usd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.filled_notional_usd","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","open","partially_filled","filled","canceled","rejected","expired","unconfirmed","needs_attention","cancel_requested"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status","typeLabel":"enum\u003cstring>"},"venue_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_status","typeLabel":"string | null"},"venue_order_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_order_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.venue_order_id","typeLabel":"string | null"},"status_reason":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status_reason.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status_reason.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status_reason.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.status_reason","typeLabel":"object | null"},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue","typeLabel":"enum\u003cstring>"},"ticker":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].ticker","typeLabel":"string"},"side":{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].quantity","typeLabel":"string"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].filled_quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].limit_price","typeLabel":"string"},"avg_fill_price":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].avg_fill_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].avg_fill_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].avg_fill_price","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","open","partially_filled","filled","canceled","rejected","expired","unconfirmed","needs_attention","cancel_requested"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"venue_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_status","typeLabel":"string | null"},"venue_order_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_order_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].venue_order_id","typeLabel":"string | null"},"cancel_requested_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].cancel_requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].cancel_requested_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].cancel_requested_at","typeLabel":"string\u003cdate-time> | null"},"status_reason":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status_reason.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status_reason.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status_reason.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX].status_reason","typeLabel":"object | null"}},"required":["venue","ticker","side","quantity","filled_quantity","limit_price","avg_fill_price","status","venue_status","venue_order_id","cancel_requested_at","status_reason"],"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.legs","typeLabel":"object[]"},"post_only":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.post_only","typeLabel":"boolean"},"replaces_order_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaces_order_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaces_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaces_order_id","typeLabel":"string\u003cuuid> | null"},"replaced_by_order_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaced_by_order_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaced_by_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.replaced_by_order_id","typeLabel":"string\u003cuuid> | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0.livemode","typeLabel":"boolean"}},"required":["id","client_order_id","market_id","title","outcome","venue","ticker","side","action","type","time_in_force","expires_at","quantity","filled_quantity","remaining_quantity","limit_price","avg_fill_price","notional_usd","filled_notional_usd","status","venue_status","venue_order_id","status_reason","legs","post_only","replaces_order_id","replaced_by_order_id","created_at","updated_at","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid"},"client_order_id":{"type":"string","minLength":1},"market_id":{"type":"string","minLength":1,"description":"The market id from GET /markets, however the request named the market."},"title":{"oneOf":[{"type":"string","minLength":1},{"type":"null","minLength":1}]},"outcome":{"oneOf":[{"type":"string","minLength":1},{"type":"null","minLength":1}]},"venue":{"oneOf":[{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]},{"type":"null","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]}]},"ticker":{"oneOf":[{"type":"string","minLength":1},{"type":"null","minLength":1}]},"side":{"oneOf":[{"type":"string","enum":["yes","no"]},{"type":"null","enum":["yes","no"]}]},"action":{"type":"string","enum":["buy","sell"]},"type":{"type":"string","enum":["limit","market"]},"time_in_force":{"type":"string","enum":["gtc","ioc","fok","gtd"]},"expires_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"remaining_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","description":"Shares still working on the venues: the unfilled size of each live venue order. Zero once the order is final, since a canceled, expired or rejected remainder no longer works."},"limit_price":{"type":"string"},"avg_fill_price":{"oneOf":[{"type":"string","description":"Average price per share filled, size-weighted across the venue orders that filled, excluding fees. Null until every filled venue order has a price."},{"type":"null","description":"Average price per share filled, size-weighted across the venue orders that filled, excluding fees. Null until every filled venue order has a price."}]},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"filled_notional_usd":{"oneOf":[{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},{"type":"null","pattern":"^\\d+(?:\\.\\d+)?$"}]},"status":{"type":"string","enum":["pending","open","partially_filled","filled","canceled","rejected","expired","unconfirmed","needs_attention","cancel_requested"]},"venue_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"venue_order_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"status_reason":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"]},{"type":"null","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"]}]},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]},"ticker":{"type":"string","minLength":1},"side":{"type":"string","enum":["yes","no"]},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"limit_price":{"type":"string"},"avg_fill_price":{"oneOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["pending","open","partially_filled","filled","canceled","rejected","expired","unconfirmed","needs_attention","cancel_requested"]},"venue_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"venue_order_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"cancel_requested_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"status_reason":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"]},{"type":"null","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1}},"required":["code","message"]}]}},"required":["venue","ticker","side","quantity","filled_quantity","limit_price","avg_fill_price","status","venue_status","venue_order_id","cancel_requested_at","status_reason"]}},"post_only":{"type":"boolean"},"replaces_order_id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]},"replaced_by_order_id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"}},"required":["id","client_order_id","market_id","title","outcome","venue","ticker","side","action","type","time_in_force","expires_at","quantity","filled_quantity","remaining_quantity","limit_price","avg_fill_price","notional_usd","filled_notional_usd","status","venue_status","venue_order_id","status_reason","legs","post_only","replaces_order_id","replaced_by_order_id","created_at","updated_at","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].order","typeLabel":"object | null"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.0.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.0.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.0.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string","minLength":1},"message":{"type":"string","minLength":1},"details":{"oneOf":[{},{"type":"null"}]}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].error","typeLabel":"object | null"}},"required":["venue","ticker","side","market_id","client_order_id","quantity","status","order","error"],"uniqueKey":"oneOf.0.data.legs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.legs","typeLabel":"object[]"},"unavailable_venues":{"type":"array","items":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"uniqueKey":"oneOf.0.data.unavailable_venues.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"oneOf.0.data.unavailable_venues","typeLabel":"enum\u003cstring>[]"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.livemode","typeLabel":"boolean"}},"required":["outcome","legs","unavailable_venues","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":{"outcome":"placed","legs":[{"venue":"hyperliquid","ticker":"hl:9999","side":"yes","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","client_order_id":"flatten-0001-close-9c1e4a7b-3f20d8e6","quantity":"10","status":"placed","order":{"id":"5d9b2f71-0c3e-4a86-b7d4-1e6f8a2c9b05","client_order_id":"flatten-0001-close-9c1e4a7b-3f20d8e6","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","title":"Denver Broncos at Los Angeles Chargers: DEN -3.5, Denver Broncos -3.5","outcome":"DEN","venue":null,"ticker":null,"side":null,"action":"sell","type":"limit","time_in_force":"ioc","expires_at":null,"quantity":"10","filled_quantity":"10","remaining_quantity":"0","limit_price":"0.53","avg_fill_price":"0.54","notional_usd":"5.4","filled_notional_usd":"5.4","status":"filled","venue_status":null,"venue_order_id":null,"status_reason":null,"legs":[],"post_only":false,"replaces_order_id":null,"replaced_by_order_id":null,"created_at":"2026-10-29T18:00:00.000Z","updated_at":"2026-10-29T18:00:00.000Z","livemode":false},"error":null}],"unavailable_venues":[],"livemode":false},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"outcome":"placed","legs":[{"venue":"hyperliquid","ticker":"hl:9999","side":"yes","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","client_order_id":"flatten-0001-close-9c1e4a7b-3f20d8e6","quantity":"10","status":"placed","order":{"id":"5d9b2f71-0c3e-4a86-b7d4-1e6f8a2c9b05","client_order_id":"flatten-0001-close-9c1e4a7b-3f20d8e6","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","title":"Denver Broncos at Los Angeles Chargers: DEN -3.5, Denver Broncos -3.5","outcome":"DEN","venue":null,"ticker":null,"side":null,"action":"sell","type":"limit","time_in_force":"ioc","expires_at":null,"quantity":"10","filled_quantity":"10","remaining_quantity":"0","limit_price":"0.53","avg_fill_price":"0.54","notional_usd":"5.4","filled_notional_usd":"5.4","status":"filled","venue_status":null,"venue_order_id":null,"status_reason":null,"legs":[],"post_only":false,"replaces_order_id":null,"replaced_by_order_id":null,"created_at":"2026-10-29T18:00:00.000Z","updated_at":"2026-10-29T18:00:00.000Z","livemode":false},"error":null}],"unavailable_venues":[],"livemode":false},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"452a2e9b-d585-4c58-a2f2-7e78d7e2c1ec":{"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":"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"},"f2940b6e-96be-41a8-b964-0e4ed7cb4f16":{"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"},"d572c32b-d121-490a-aa59-c9f47c26cf0f":{"description":"The key lacks the scope this route needs","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"},"6be3c7d2-cd6c-4bfd-84bc-d4d494c7f1ef":{"description":"client_order_id was already used for a close with different parameters","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":"client_order_id was already used for a close with different parameters"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"CONFLICT","message":"client_order_id was already used for a close with different parameters"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"451f7355-b1ed-40e3-87c7-19858046f56f":{"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"},"89c686e6-47a4-4f4e-9260-9e221c6b2fed":{"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"},"2eea4bae-774e-42b5-a014-523111746e62":{"description":"Order placement is paused for this 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":"FEATURE_DISABLED","message":"Order placement is paused for this key"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"FEATURE_DISABLED","message":"Order placement is paused for this key"},"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":"Close positions - Lean API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T00:52:29.974Z","originalFileLocation":"api-reference/account/close-positions.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=\"Sells each position of this key\u0026#x27;s trading account in this key\u0026#x27;s mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg\u0026#x27;s error.\">\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=\"Close positions - Lean API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sells each position of this key\u0026#x27;s trading account in this key\u0026#x27;s mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg\u0026#x27;s error.\">\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/account/close-positions\">\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=Account\u0026amp;title=Close+positions\u0026amp;description=Sells+each+position+of+this+key%27s+trading+account+in+this+key%27s+mode%2C+optionally+only+on+one+venue+or+market%2C+through+the+same+checks+and+limits+as+POST+%2Fv1%2Ford\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=4a7fb530759e53bda65e16f818d73b3abd5cf359367babf0c0989abbee6624e8\">\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=\"Close positions - Lean API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sells each position of this key\u0026#x27;s trading account in this key\u0026#x27;s mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg\u0026#x27;s error.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lean.mintlify.site/_mintlify/api/og/v2?division=Account\u0026amp;title=Close+positions\u0026amp;description=Sells+each+position+of+this+key%27s+trading+account+in+this+key%27s+mode%2C+optionally+only+on+one+venue+or+market%2C+through+the+same+checks+and+limits+as+POST+%2Fv1%2Ford\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=4a7fb530759e53bda65e16f818d73b3abd5cf359367babf0c0989abbee6624e8\">\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/account/close-positions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/account/close-positions.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/account/close-positions#webpage\",\"url\":\"https://lean.mintlify.app/api-reference/account/close-positions\",\"name\":\"Close positions\",\"description\":\"Sells each position of this key's trading account in this key's mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg's error.\",\"dateModified\":\"2026-11-17T00:52:29.974Z\",\"isPartOf\":{\"@id\":\"https://lean.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://lean.mintlify.app/api-reference/account/close-positions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://lean.mintlify.app/api-reference/account/close-positions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account\",\"item\":\"https://lean.mintlify.app/api-reference/account/list-positions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Close positions\",\"item\":\"https://lean.mintlify.app/api-reference/account/close-positions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://lean.mintlify.app/api-reference/account/close-positions#apireference\",\"headline\":\"Close positions\",\"name\":\"Close positions\",\"description\":\"Sells each position of this key's trading account in this key's mode, optionally only on one venue or market, through the same checks and limits as POST /v1/orders. Each sell sells only what is held less what open sells already offer, on the venue that holds it, so a close never sells more than the account holds. Each placed sell is read back before the response, so one the venue matched at once reads filled with its filled quantity and average price. Cancel open orders first to close everything. A close answers 200 even when a sell fails: read outcome, which is failed or partial while positions are left unsold, and each failed leg's error.\",\"url\":\"https://lean.mintlify.app/api-reference/account/close-positions\",\"mainEntityOfPage\":{\"@id\":\"https://lean.mintlify.app/api-reference/account/close-positions#webpage\"},\"dateModified\":\"2026-11-17T00:52:29.974Z\",\"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/account/close-positions.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","description":"Shares held by this key’s trading account on each venue, with average price, mark price and unrealized profit and loss. Each holding names its `market_id`, `title` and `outcome`, or null when no market is listed for it. Filter by venue, market or text in the market title. Kalshi and Polymarket US accounts belong to the user rather than one trading account, so every trading account of the user lists the same holdings there. A venue that could not be read is listed in `unavailable`.","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","description":"Cash held by this key’s trading account on each venue, in the collateral the venue trades in. Kalshi and Polymarket US cash belongs to the user, so every trading account of the user reads the same balance there. A venue that could not be read is listed in `unavailable`.","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","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","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":"Close positions - 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"]}