{
"success": false,
"error": {
"code": "UPSTREAM_ERROR",
"message": "A required service is temporarily unavailable."
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
Orders
Amend an order
Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.
PATCH
/
orders
/
{id}
Error
A valid request URL is required to generate request examples
{
"success": false,
"error": {
"code": "UPSTREAM_ERROR",
"message": "A required service is temporarily unavailable."
},
"meta": {
"timestampMs": 1792771200000,
"requestId": "7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"
}
}
Authorizations
Authorization
string
header
required
A Lean API key, sent as Authorization: Bearer <key>. A test key (lean_sk_test_...) simulates orders and fills with no money; a live key (lean_sk_live_...) trades for real within the key's limits. Every successful response says which mode answered in data.livemode.
Path Parameters
id
string<uuid>
required
Example:
"8a1e5c07-4b3f-4d62-9f18-2c7e0a95d4b1"
Body
application/json
limit_price
string
The new worst price per share, in dollars. Omit to keep the current one.
quantity
string
The new total size in shares, counting what already filled. Omit to keep the current one.
Pattern: ^\d+(?:\.\d+)?$
client_order_id
string
The client_order_id of the new order that replaces this one. Omit and Lean picks one.
Pattern: ^[A-Za-z0-9_-]{1,64}$
Response
The order that replaced it
Option 1
Option 2
success
enum<boolean>
required
Available options:
true
data
object
required
Hide child attributes
data.id
string<uuid>
required
data.client_order_id
string
required
Minimum string length: 1
data.market_id
string
required
The market id from GET /markets, however the request named the market.
Minimum string length: 1
data.title
string | null
required
Minimum string length: 1
data.outcome
string | null
required
Minimum string length: 1
data.venue
enum<string> | null
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.ticker
string | null
required
Minimum string length: 1
data.side
enum<string> | null
required
Available options:
yes,
no
data.action
enum<string>
required
Available options:
buy,
sell
data.type
enum<string>
required
Available options:
limit,
market
data.time_in_force
enum<string>
required
Available options:
gtc,
ioc,
fok,
gtd
data.expires_at
string<date-time> | null
required
data.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.filled_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.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.limit_price
string
required
data.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.notional_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.filled_notional_usd
string | null
required
Pattern: ^\d+(?:\.\d+)?$
data.status
enum<string>
required
Available options:
pending,
open,
partially_filled,
filled,
canceled,
rejected,
expired,
unconfirmed,
needs_attention,
cancel_requested
data.venue_status
string | null
required
data.venue_order_id
string | null
required
data.status_reason
object | null
required
Hide child attributes
data.status_reason.code
string
required
Minimum string length: 1
data.status_reason.message
string
required
Minimum string length: 1
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.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.filled_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.legs.limit_price
string
required
data.legs.avg_fill_price
string | null
required
data.legs.status
enum<string>
required
Available options:
pending,
open,
partially_filled,
filled,
canceled,
rejected,
expired,
unconfirmed,
needs_attention,
cancel_requested
data.legs.venue_status
string | null
required
data.legs.venue_order_id
string | null
required
data.legs.cancel_requested_at
string<date-time> | null
required
data.legs.status_reason
object | null
required
Hide child attributes
data.legs.status_reason.code
string
required
Minimum string length: 1
data.legs.status_reason.message
string
required
Minimum string length: 1
data.post_only
boolean
required
data.replaces_order_id
string<uuid> | null
required
data.replaced_by_order_id
string<uuid> | null
required
data.created_at
string<date-time>
required
data.updated_at
string<date-time>
required
data.livemode
boolean
required
data.route
object | null
required
Hide child attributes
data.route.funding_venue
enum<string>
required
Available options:
polymarket,
hyperliquid
data.route.execution_venue
enum<string>
required
Available options:
polymarket,
hyperliquid
data.route.notional_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route.costs
object
required
Hide child attributes
data.route.costs.rebalance_fee_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route.costs.gas_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route.costs.activation_fee_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route.costs.network_cost_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
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/orders/amend-order","slug":"/api-reference/orders/amend-order","pageMetadata":{"title":"Amend an order","openapi":"api-reference/openapi.json PATCH /orders/{id}","description":"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.","href":"/api-reference/orders/amend-order"},"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: \"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\"\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":"Amend an order","openapi":"api-reference/openapi.json PATCH /orders/{id}","description":"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.","href":"/api-reference/orders/amend-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"amendOrder","summary":"Amend an order","description":"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.","tags":["Orders"],"parameters":["41a1a3cf-9258-4e95-b242-7bcdf1d3baa2"],"requestBody":"7ef0c256-b119-414f-8e9d-dcda63ce8f91","responses":{"200":"299dad5c-8c07-46b1-9c4e-74cc015a35c7","400":"25142d50-a006-4541-afb9-dad3c04fc5d3","401":"1555ee6f-03e0-467e-b79b-2b519cd2afc0","403":"48556ced-8394-4649-9bdf-f4b98d6b5360","404":"c11bb331-baaf-4cee-98a3-d4511b333db2","409":"70fc6f6a-25c9-4152-8660-afeb545dc48a","422":"f40b307b-825e-4f94-906b-7413078093b0","429":"a7ac779d-eb6c-40df-8d8b-8759511bf7f2","500":"e31a920b-4b66-444f-8498-1326940bcd4a","503":"c34c1421-6381-457a-8cc7-59856bc24a22"},"method":"patch","type":"path","servers":["b9d200f3-058d-4de6-ac62-d3daef380488"],"security":["c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd"],"path":"/orders/{id}","baseUrlOptions":["{baseUrl}/v1"],"title":"Amend an order","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.limit_price":"0.52","body.quantity":"12","body.client_order_id":"bot-0002"}]},"dependencies":{"parameters":{"41a1a3cf-9258-4e95-b242-7bcdf1d3baa2":{"schema":{"type":"string","format":"uuid","example":"8a1e5c07-4b3f-4d62-9f18-2c7e0a95d4b1","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"name":"id","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit_price":{"type":"string","description":"The new worst price per share, in dollars. Omit to keep the current one.","uniqueKey":"limit_price","typeLabel":"string"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","description":"The new total size in shares, counting what already filled. Omit to keep the current one.","uniqueKey":"quantity","typeLabel":"string"},"client_order_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","description":"The client_order_id of the new order that replaces this one. Omit and Lean picks one.","uniqueKey":"client_order_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"client_order_id":"bot-0002","limit_price":"0.52","quantity":"12"},"examples":{"Example":{"title":"Example","value":{"client_order_id":"bot-0002","limit_price":"0.52","quantity":"12"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"299dad5c-8c07-46b1-9c4e-74cc015a35c7":{"description":"The order that replaced it","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["success","data","meta"],"properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"oneOf.0.success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.id","typeLabel":"string\u003cuuid>"},"client_order_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.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.market_id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.title.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.title","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.outcome.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.outcome.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.outcome","typeLabel":"string | null"},"venue":{"oneOf":[{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.venue.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.venue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.venue","typeLabel":"enum\u003cstring> | null"},"ticker":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.ticker.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.ticker.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.ticker","typeLabel":"string | null"},"side":{"oneOf":[{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.side.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.side.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.side","typeLabel":"enum\u003cstring> | null"},"action":{"type":"string","enum":["buy","sell"],"isRequired":true,"uniqueKey":"oneOf.0.data.action","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["limit","market"],"isRequired":true,"uniqueKey":"oneOf.0.data.type","typeLabel":"enum\u003cstring>"},"time_in_force":{"type":"string","enum":["gtc","ioc","fok","gtd"],"isRequired":true,"uniqueKey":"oneOf.0.data.time_in_force","typeLabel":"enum\u003cstring>"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.expires_at","typeLabel":"string\u003cdate-time> | null"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.quantity","typeLabel":"string"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.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.remaining_quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.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.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.avg_fill_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.avg_fill_price","typeLabel":"string | null"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.notional_usd","typeLabel":"string"},"filled_notional_usd":{"oneOf":[{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.filled_notional_usd.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.filled_notional_usd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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.status","typeLabel":"enum\u003cstring>"},"venue_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.venue_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.venue_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.venue_status","typeLabel":"string | null"},"venue_order_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.venue_order_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.venue_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.venue_order_id","typeLabel":"string | null"},"status_reason":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.status_reason.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.status_reason.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.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.status_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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].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>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].quantity","typeLabel":"string"},"filled_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].filled_quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].limit_price","typeLabel":"string"},"avg_fill_price":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].avg_fill_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].avg_fill_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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].status","typeLabel":"enum\u003cstring>"},"venue_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue_status","typeLabel":"string | null"},"venue_order_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue_order_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].venue_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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].cancel_requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].cancel_requested_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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].status_reason.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.legs.items.[INDEX].status_reason.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.0.data.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].status_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.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]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.legs","typeLabel":"object[]"},"post_only":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.post_only","typeLabel":"boolean"},"replaces_order_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.replaces_order_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.replaces_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.replaces_order_id","typeLabel":"string\u003cuuid> | null"},"replaced_by_order_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.replaced_by_order_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.data.replaced_by_order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.replaced_by_order_id","typeLabel":"string\u003cuuid> | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.updated_at","typeLabel":"string\u003cdate-time>"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.livemode","typeLabel":"boolean"},"route":{"oneOf":[{"type":"object","properties":{"funding_venue":{"type":"string","enum":["polymarket","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.funding_venue","typeLabel":"enum\u003cstring>"},"execution_venue":{"type":"string","enum":["polymarket","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.execution_venue","typeLabel":"enum\u003cstring>"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.notional_usd","typeLabel":"string"},"costs":{"type":"object","properties":{"rebalance_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.costs.rebalance_fee_usd","typeLabel":"string"},"gas_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.costs.gas_usd","typeLabel":"string"},"activation_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.costs.activation_fee_usd","typeLabel":"string"},"network_cost_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.costs.network_cost_usd","typeLabel":"string"}},"required":["rebalance_fee_usd","gas_usd","activation_fee_usd","network_cost_usd"],"isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0.costs","typeLabel":"object"}},"required":["funding_venue","execution_venue","notional_usd","costs"],"isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"funding_venue":{"type":"string","enum":["polymarket","hyperliquid"]},"execution_venue":{"type":"string","enum":["polymarket","hyperliquid"]},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"costs":{"type":"object","properties":{"rebalance_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"gas_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"activation_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"network_cost_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"}},"required":["rebalance_fee_usd","gas_usd","activation_fee_usd","network_cost_usd"]}},"required":["funding_venue","execution_venue","notional_usd","costs"],"isRequired":true,"uniqueKey":"oneOf.0.data.route.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.route","typeLabel":"object | null"}},"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","route"],"isRequired":true,"uniqueKey":"oneOf.0.data","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.0.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.0.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.0.meta","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["success","error","meta"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"oneOf.1.success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"oneOf.1.error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.1.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.1.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.1.meta","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"id":"3f6b2d90-7c41-4e8a-b5d2-91a0c4e7f356","client_order_id":"bot-0002","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","title":"Denver Broncos at Los Angeles Chargers: DEN -3.5, Denver Broncos -3.5","outcome":"DEN","venue":"hyperliquid","ticker":"hl:9999","side":"yes","action":"buy","type":"limit","time_in_force":"gtc","expires_at":null,"quantity":"12","filled_quantity":"0","remaining_quantity":"12","limit_price":"0.52","avg_fill_price":null,"notional_usd":"6.24","filled_notional_usd":null,"status":"open","venue_status":null,"venue_order_id":null,"status_reason":null,"legs":[],"post_only":true,"replaces_order_id":"8a1e5c07-4b3f-4d62-9f18-2c7e0a95d4b1","replaced_by_order_id":null,"created_at":"2026-10-29T18:00:00.000Z","updated_at":"2026-10-29T18:05:00.000Z","livemode":false,"route":null},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"3f6b2d90-7c41-4e8a-b5d2-91a0c4e7f356","client_order_id":"bot-0002","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","title":"Denver Broncos at Los Angeles Chargers: DEN -3.5, Denver Broncos -3.5","outcome":"DEN","venue":"hyperliquid","ticker":"hl:9999","side":"yes","action":"buy","type":"limit","time_in_force":"gtc","expires_at":null,"quantity":"12","filled_quantity":"0","remaining_quantity":"12","limit_price":"0.52","avg_fill_price":null,"notional_usd":"6.24","filled_notional_usd":null,"status":"open","venue_status":null,"venue_order_id":null,"status_reason":null,"legs":[],"post_only":true,"replaces_order_id":"8a1e5c07-4b3f-4d62-9f18-2c7e0a95d4b1","replaced_by_order_id":null,"created_at":"2026-10-29T18:00:00.000Z","updated_at":"2026-10-29T18:05:00.000Z","livemode":false,"route":null},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"25142d50-a006-4541-afb9-dad3c04fc5d3":{"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"},"1555ee6f-03e0-467e-b79b-2b519cd2afc0":{"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"},"48556ced-8394-4649-9bdf-f4b98d6b5360":{"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"},"c11bb331-baaf-4cee-98a3-d4511b333db2":{"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":"NOT_FOUND","message":"Not found"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"NOT_FOUND","message":"Not found"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"70fc6f6a-25c9-4152-8660-afeb545dc48a":{"description":"The order cannot be amended. details.reason is ORDER_NOT_OPEN, ORDER_REPLACED with details.replaced_by_order_id, ORDER_NOT_AMENDABLE, or REPLACEMENT_PENDING with details.order_id when the order’s cancel was requested and nothing was placed in its place yet","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"CONFLICT","message":"The order cannot be amended"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"CONFLICT","message":"The order cannot be amended"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f40b307b-825e-4f94-906b-7413078093b0":{"description":"The new terms are refused: a key limit, the account’s cash or shares, or POST_ONLY_WOULD_CROSS for a post only order that would now trade","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","error","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Refused by a limit; nothing was changed"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Refused by a limit; nothing was changed"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a7ac779d-eb6c-40df-8d8b-8759511bf7f2":{"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"},"e31a920b-4b66-444f-8498-1326940bcd4a":{"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"},"c34c1421-6381-457a-8cc7-59856bc24a22":{"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":"UPSTREAM_ERROR","message":"A required service is temporarily unavailable."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"UPSTREAM_ERROR","message":"A required service is temporarily unavailable."},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd":{"apiKey":{"type":"http","scheme":"bearer","description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. A test key (`lean_sk_test_...`) simulates orders and fills with no money; a live key (`lean_sk_live_...`) trades for real within the key's limits. Every successful response says which mode answered in `data.livemode`.","scopes":[],"schemeName":"apiKey"}}},"servers":{"b9d200f3-058d-4de6-ac62-d3daef380488":{"url":"{baseUrl}/v1","description":"Lean API","variables":{"baseUrl":{"default":"https://api.lean.xyz","description":"The Lean API base URL, without /v1. Same value as LEAN_API_URL in the guides."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. A test key (`lean_sk_test_...`) simulates orders and fills with no money; a live key (`lean_sk_live_...`) trades for real within the key's limits. Every successful response says which mode answered in `data.livemode`.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A Lean API key, sent as `Authorization: Bearer \u003ckey>`. A test key (`lean_sk_test_...`) simulates orders and fills with no money; a live key (`lean_sk_live_...`) trades for real within the key's limits. Every successful response says which mode answered in `data.livemode`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"lean","siteName":"Lean API","title":"Amend an order - Lean API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T23:42:11.071Z","originalFileLocation":"api-reference/orders/amend-order.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=\"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\">\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=\"Amend an order - Lean API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\">\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/orders/amend-order\">\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=Orders\u0026amp;title=Amend+an+order\u0026amp;description=Changes+the+limit+price%2C+the+size+or+both+of+a+resting+good+til+canceled+order+on+one+venue.+Lean+cancels+the+order+and%2C+once+the+cancel+is+confirmed+with+its+f\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=54cfa3876d129eb3c3e46d635fd3188e577381c179c14097a19156f9273e875e\">\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=\"Amend an order - Lean API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lean.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Amend+an+order\u0026amp;description=Changes+the+limit+price%2C+the+size+or+both+of+a+resting+good+til+canceled+order+on+one+venue.+Lean+cancels+the+order+and%2C+once+the+cancel+is+confirmed+with+its+f\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=54cfa3876d129eb3c3e46d635fd3188e577381c179c14097a19156f9273e875e\">\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/orders/amend-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/amend-order.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/orders/amend-order#webpage\",\"url\":\"https://lean.mintlify.app/api-reference/orders/amend-order\",\"name\":\"Amend an order\",\"description\":\"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\",\"dateModified\":\"2026-11-13T23:42:11.071Z\",\"isPartOf\":{\"@id\":\"https://lean.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://lean.mintlify.app/api-reference/orders/amend-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://lean.mintlify.app/api-reference/orders/amend-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://lean.mintlify.app/api-reference/orders/preview-order\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Amend an order\",\"item\":\"https://lean.mintlify.app/api-reference/orders/amend-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://lean.mintlify.app/api-reference/orders/amend-order#apireference\",\"headline\":\"Amend an order\",\"name\":\"Amend an order\",\"description\":\"Changes the limit price, the size or both of a resting good til canceled order on one venue. Lean cancels the order and, once the cancel is confirmed with its final fill, places a new good til canceled order on the same venue with the same post_only for the rest of the new size: the answer is the new order, its replaces_order_id names the old one, and the old order’s replaced_by_order_id names the new one. Each keeps its own fills. A Kalshi, Polymarket US or Hyperliquid cancel is confirmed within the request. A live Polymarket cancel is confirmed some time after it is requested, so the first amend usually answers 409 REPLACEMENT_PENDING; send the same amend again once the old order reads canceled and the replacement is placed for what did not fill. The new order is placed as the calling key places one. Every check the new order faces, from the venue’s price and size rules and a post_only price that would trade to the key’s caps, the rolling day and the account’s cash or shares, runs before the cancel with what the old order holds counted as free, and a refusal leaves the order resting. Only a change between that check and the placement, such as another order spending the cash, can refuse the new order after the cancel, and the old order then stays canceled. Split, routed and immediate or cancel orders cannot be amended.\",\"url\":\"https://lean.mintlify.app/api-reference/orders/amend-order\",\"mainEntityOfPage\":{\"@id\":\"https://lean.mintlify.app/api-reference/orders/amend-order#webpage\"},\"dateModified\":\"2026-11-13T23:42:11.071Z\",\"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/orders/amend-order.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}","description":"One API order by id, refreshed from its venues, with its market’s `title` and `outcome` and each leg’s status and the quantity filled so far. A canceled ioc order and its canceled legs carry `status_reason.code` `IOC_REMAINDER_CANCELED`: the venue canceled what did not fill at once, and `filled_quantity` is what filled.","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","description":"Cancels what is still resting of an open order on every venue it was placed on and returns the order once the venues answer. Shares already filled stay filled.","href":"/api-reference/orders/cancel-order"},{"title":"Cancel every open order","openapi":"api-reference/openapi.json POST /orders/cancel-all","href":"/api-reference/orders/cancel-all-orders"},{"title":"Set a cancel timer","openapi":"api-reference/openapi.json POST /orders/cancel-after","href":"/api-reference/orders/set-cancel-after"},{"title":"Cancel several orders","openapi":"api-reference/openapi.json POST /orders/cancel-batch","href":"/api-reference/orders/cancel-orders-batch"},{"title":"List fills","openapi":"api-reference/openapi.json GET /fills","href":"/api-reference/orders/list-fills"},{"title":"Place a routed order","openapi":"api-reference/openapi.json POST /routed-orders","href":"/api-reference/orders/create-routed-order"},{"title":"Execute a routed order","openapi":"api-reference/openapi.json POST /routed-orders/{id}/execute","href":"/api-reference/orders/execute-routed-order"}]},{"group":"Stop losses","pages":[{"title":"Create a stop loss or take profit","openapi":"api-reference/openapi.json POST /stop-losses","href":"/api-reference/stop-losses/create-stop-loss"},{"title":"List stop losses","openapi":"api-reference/openapi.json GET /stop-losses","href":"/api-reference/stop-losses/list-stop-losses"},{"title":"Get a stop loss","openapi":"api-reference/openapi.json GET /stop-losses/{id}","href":"/api-reference/stop-losses/retrieve-stop-loss"},{"title":"Cancel a stop loss","openapi":"api-reference/openapi.json DELETE /stop-losses/{id}","href":"/api-reference/stop-losses/cancel-stop-loss"}]},{"group":"Limit chases","pages":[{"title":"Create a limit chase","openapi":"api-reference/openapi.json POST /limit-chases","href":"/api-reference/limit-chases/create-limit-chase"},{"title":"List limit chases","openapi":"api-reference/openapi.json GET /limit-chases","href":"/api-reference/limit-chases/list-limit-chases"},{"title":"Get a limit chase","openapi":"api-reference/openapi.json GET /limit-chases/{id}","href":"/api-reference/limit-chases/retrieve-limit-chase"},{"title":"Cancel a limit chase","openapi":"api-reference/openapi.json DELETE /limit-chases/{id}","href":"/api-reference/limit-chases/cancel-limit-chase"}]},{"group":"Account","pages":[{"title":"List positions","openapi":"api-reference/openapi.json GET /positions","href":"/api-reference/account/list-positions"},{"title":"Close positions","openapi":"api-reference/openapi.json POST /positions/close","href":"/api-reference/account/close-positions"},{"title":"List balances","openapi":"api-reference/openapi.json GET /balances","href":"/api-reference/account/list-balances"},{"title":"Get profit and loss","openapi":"api-reference/openapi.json GET /pnl","href":"/api-reference/account/get-pnl"},{"title":"Get profit and loss history","openapi":"api-reference/openapi.json GET /pnl/history","href":"/api-reference/account/get-pnl-history"},{"title":"Get risk","openapi":"api-reference/openapi.json GET /risk","href":"/api-reference/account/get-risk"},{"title":"Get account configuration","openapi":"api-reference/openapi.json GET /account/config","href":"/api-reference/account/retrieve-account-config"},{"title":"Lower this key's limits","openapi":"api-reference/openapi.json POST /account/limits","href":"/api-reference/account/lower-key-limits"},{"title":"Pause order placement","openapi":"api-reference/openapi.json POST /account/pause","href":"/api-reference/account/pause-trading"}]},{"group":"Deposits","pages":[{"title":"List deposit assets","openapi":"api-reference/openapi.json GET /deposits/assets","href":"/api-reference/deposits/list-deposit-assets"},{"title":"Get deposit addresses","openapi":"api-reference/openapi.json GET /deposits/addresses","href":"/api-reference/deposits/list-deposit-addresses"},{"title":"Create deposit addresses","openapi":"api-reference/openapi.json POST /deposits/addresses","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":"Amend an order - 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"]}