Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.
POST
/
orders
/
preview
Error
A valid request URL is required to generate request examples
A Lean API key, sent as Authorization: Bearer <key>. A test key (lean_sk_test_...) simulates orders and fills with no money; a live key (lean_sk_live_...) trades for real within the key's limits. Every successful response says which mode answered in data.livemode.
Body
application/json
client_order_id
string
required
Unique per API key. Replaying an id returns the original order.
Pattern: ^[A-Za-z0-9_-]{1,64}$
market_id
string
required
A market id from GET /markets, or a venue symbol that names one market: a Polymarket token id, a Hyperliquid book coin (#…, written %23… in a path), or a leg ticker (pm:…, hl:…, pmus:… or a Kalshi market ticker) that lists only this outcome. A symbol that names more than one market, such as a Polymarket condition id, is refused with 400; use the token id or the market id instead. An order named by a venue symbol trades only that listing, so it is refused when venues leaves out the symbol's venue. A buy routed automatically still buys that listing, paid from the other venue. The order is stored under the market id.
Required string length: 1 - 512
action
enum<string>
required
Available options:
buy,
sell
quantity
string
Shares, in 0.01 steps. Send exactly one of quantity or notional. A sell of the whole position, as held or written to two decimals, sells what each venue's increment allows and keeps the rest.
Pattern: ^\d+(?:\.\d+)?$
notional
string
Dollars to spend on an ioc or fok buy, in place of quantity, at most two decimals. The buy walks the books from the best price and never spends more than this before fees; Lean works out the shares. Sells and resting orders are sized with quantity.
Pattern: ^\d+(?:\.\d{1,2})?$
limit_price
string
Worst price per share you accept, in dollars. Required with quantity on a limit order. With notional or on a market order it defaults to 0.99 for a buy and 0.01 for a sell; a market order is then placed 1 cent past the worst price its quantity reaches in the book, tightened by max_slippage_bps when set.
type
enum<string>
default:limit
limit trades at limit_price or better. market trades at once at the best prices: it needs time_in_force ioc or fok, and each venue order is placed 1 cent past the worst price its quantity reaches in the book of that venue. limit_price and max_slippage_bps are optional extra caps on the worst price it accepts.
Available options:
limit,
market
time_in_force
enum<string>
default:gtc
gtc rests until filled or canceled. ioc fills what it can at once and cancels the rest. fok fills the whole order at once or cancels all of it, and is placed whole on one venue: Polymarket, else Kalshi, else Polymarket US, since Hyperliquid has no fill or kill. gtd rests like gtc until expires_at, and is placed on Kalshi, Polymarket and Polymarket US, since Hyperliquid has no order expiry. Polymarket takes an ioc or fok buy only by dollar amount: one sized with notional can fill there, while one sized with quantity goes only to the other venues, and when Polymarket is the only one it is refused with 400 VALIDATION_ERROR, so send it with notional or as gtc. notional needs ioc or fok.
Available options:
gtc,
ioc,
fok,
gtd
expires_at
string<date-time>
When a gtd order expires, as an ISO 8601 time. Required with gtd and refused with any other time_in_force. At least 3 minutes and at most 30 days ahead. Whatever has not filled by then is canceled, and the order reads expired.
max_slippage_bps
integer
Optional extra cap: the furthest each venue order may trade from that venue's own best price, in basis points; overrides the account's max_slippage_bps. Each venue is measured against its own book, not the best price across venues, so venues quoting different prices can each fill. Never looser than limit_price. Without one, a limit order trades to its limit and a market order to 1 cent past the worst price its quantity reaches in the book, as the Lean trading terminal places it.
Required range: 0 <= x <= 10000
all_or_none
boolean
default:false
Refuse the order unless the books, as read, fill the whole quantity within the slippage bound. Needs time_in_force ioc or fok. Best effort: venue orders are placed separately and books can move between the read and the fill, so a partial fill is still possible.
post_only
boolean
default:false
Only rest on the book, never take. Needs time_in_force gtc, cannot take best_price, and is placed on Kalshi, Polymarket US and Hyperliquid, since Polymarket cannot rest post-only. An order that would trade at once against the books, as read, is refused with reason POST_ONLY_WOULD_CROSS, and the venue rejects one that would trade by the time it arrives.
venues
enum<string>[]
Only these venues may fill or fund the order, within the account's allowed venues. A single venue sends the order only there, and the order is refused if that venue can't fill it. Omit to use every allowed venue.
Minimum array length: 1
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
best_price
boolean
default:false
Buy at the best price across venues: when a route across venues that moves cash from another venue would cost less in all than buying where the account's cash is, the buy goes through that route. Needs the route scope. A test key prices a route at the order's limit, so there it wins only when the direct buy's fees cost more. Sells already sell across every venue that holds shares, so this does not change them.
Response
What POST /v1/orders would do with this body and the best route across venues; places and reserves nothing
Option 1
Option 2
success
enum<boolean>
required
Available options:
true
data
object
required
Hide child attributes
data.market_id
string
required
The market id from GET /markets, however the request named the market.
Minimum string length: 1
data.action
enum<string>
required
Available options:
buy,
sell
data.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.limit_price
string
required
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.execution
object | null
required
Hide child attributes
data.execution.venue
enum<string> | null
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.execution.ticker
string | null
required
Minimum string length: 1
data.execution.side
enum<string> | null
required
Available options:
yes,
no
data.execution.notional_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.max_slippage_bps
integer | null
required
Required range: 0 <= x <= 10000
data.execution.executable_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.expected_average_price
string | null
required
data.execution.legs
object[]
required
Hide child attributes
data.execution.legs.venue
enum<string>
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.execution.legs.ticker
string
required
Minimum string length: 1
data.execution.legs.side
enum<string>
required
Available options:
yes,
no
data.execution.legs.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.legs.limit_price
string
required
data.execution.legs.notional_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.legs.expected_fill_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.legs.expected_average_price
string | null
required
data.execution.legs.expected_fee_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.execution.legs.expected_resting_fee_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.would_submit
boolean
required
data.route_plan
object | null
required
Hide child attributes
data.route_plan.market_id
string
required
The market id from GET /markets, however the request named the market.
Minimum string length: 1
data.route_plan.action
enum<string>
required
Available options:
buy,
sell
data.route_plan.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.executable_quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.average_price
string | null
required
data.route_plan.legs
object[]
required
Hide child attributes
data.route_plan.legs.venue
enum<string>
required
Available options:
kalshi,
polymarket,
polymarket_us,
hyperliquid
data.route_plan.legs.ticker
string
required
Minimum string length: 1
data.route_plan.legs.side
enum<string>
required
Available options:
yes,
no
data.route_plan.legs.quantity
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.legs.average_price
string
required
data.route_plan.legs.limit_price
string
required
data.route_plan.legs.fee_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.legs.executable
boolean
required
data.route_plan.expected_total_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.max_total_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.network_cost_usd
string
required
Pattern: ^\d+(?:\.\d+)?$
data.route_plan.limited_by
string | null
required
data.route_plan.quoted_at
string<date-time>
required
data.route_plan.expires_at
string<date-time>
required
data.route_plan.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+)?$
data.warnings
object[]
required
Hide child attributes
data.warnings.code
enum<string>
required
Available options:
BELOW_VENUE_MINIMUM,
ORDER_NOTIONAL_LIMIT,
DAILY_NOTIONAL_LIMIT,
NO_EXECUTABLE_VENUE,
VENUE_NOT_ALLOWED,
INSUFFICIENT_FUNDS,
INSUFFICIENT_HOLDINGS,
INSUFFICIENT_DEPTH,
POST_ONLY_WOULD_CROSS,
CLIENT_ORDER_ID_USED,
TRADING_UNAVAILABLE,
ROUTE_LIMITED,
ROUTE_UNAVAILABLE
data.warnings.message
string
required
Minimum string length: 1
data.livemode
boolean
required
meta
object
required
Hide child attributes
meta.timestampMs
integer
required
Required range: x >= 0
meta.requestId
string
required
Minimum string length: 1
meta.traceId
string
Minimum string length: 1
meta.cachedAtMs
integer
Required range: x >= 0
meta.source
enum<string>
Available options:
cache,
database,
clickhouse,
upstream,
fallback,
internal
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lean API","colors":{"primary":"#2F5BFF","light":"#8EA6FF","dark":"#3D66FF"},"logo":{"light":"https://mintcdn.com/lean/aK_dPkAAQjEsgndO/logo/light.svg?fit=max\u0026auto=format\u0026n=aK_dPkAAQjEsgndO\u0026q=85\u0026s=6f5d064937ce6cfedc8198e9ba927287","dark":"https://mintcdn.com/lean/aK_dPkAAQjEsgndO/logo/dark.svg?fit=max\u0026auto=format\u0026n=aK_dPkAAQjEsgndO\u0026q=85\u0026s=6d4c29348beb6f1c14aa1aecb4003afd","href":"/"},"api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript"],"prefill":true}},"appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#0C0F17"}},"navbar":{"links":[{"href":"https://lean.mintlify.site/api-reference/openapi.json","label":"OpenAPI spec"}],"primary":{"type":"button","label":"Quickstart","href":"/quickstart"}},"footer":{"links":[{"header":"Lean API v0.1","items":[{"label":"Limitations","href":"/"},{"label":"Changelog","href":"/changelog"},{"label":"OpenAPI spec","href":"https://lean.mintlify.site/api-reference/openapi.json"}]}]},"fonts":{"family":"Geist"},"styling":{"codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lean","hasAudioNarration":false,"actualSubdomain":"lean","customDomains":[],"gitSource":{"type":"github","owner":"nivasaurus","repo":"lean-api-docs-demo","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae2d9189e92e136d8b49833"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afba544821a1e85a5162553","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":62},{"language":"default","tag":"Guides","count":32},{"language":"default","tag":"Orders","count":13},{"language":"default","tag":"Use cases","count":13},{"language":"default","tag":"API keys","count":11},{"language":"default","tag":"Account","count":9},{"language":"default","tag":"Markets","count":7},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Transfers","count":5},{"language":"default","tag":"Limit chases","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--lean-ink: #09090b;--lean-ink-2: #2b2d34;--lean-slate: #5d6270;--lean-faint: #8a8f9c;--lean-line: #e7e8ec;--lean-line-2: #f0f1f4;--lean-mist: #f7f8fa;--lean-cobalt: #2f5bff;--lean-cobalt-ink: #1f43d6;--lean-night: #0c0f17;--lean-night-2: #131826;--lean-night-line: #1f2536}code,pre,kbd{font-family:'Geist Mono', ui-monospace, 'SF Mono', Menlo, monospace}.prose h1,.prose h2,.prose h3{letter-spacing:-0.025em;font-weight:600}.prose h2{padding-top:28px;border-top:1px solid var(--lean-line)}.dark .prose h2{border-top-color:#ffffff14}.prose :not(pre)>code{font-size:.86em;background:var(--lean-mist);border:1px solid var(--lean-line-2);padding:1px 5px;border-radius:5px;color:var(--lean-ink-2)}.dark .prose :not(pre)>code{background:#ffffff0d;border-color:#ffffff14;color:#e6e9f2}.prose table{font-size:14px}.prose thead th{font-weight:500;font-size:13px;color:var(--lean-faint);border-bottom:1px solid var(--lean-ink)}.prose tbody td{border-bottom:1px solid var(--lean-line-2);vertical-align:top}.dark .prose thead th{border-bottom-color:#ffffff55}.dark .prose tbody td{border-bottom-color:#ffffff12}#content-area:has(.lean-hero)>#header{display:none}#content-area:has(.lean-hero)>#content{margin-top:0}.lean-hero{background:var(--lean-night);color:#fff;border-radius:18px;padding:56px 48px;margin:8px 0 56px;border:1px solid var(--lean-night-line);background-image:radial-gradient(1200px 400px at 85% -10%, #2f5bff33, transparent 60%)}.lean-kicker{display:inline-flex;align-items:center;gap:10px;font-size:13px;color:#b9c1d4;border:1px solid #ffffff1f;background:#ffffff08;border-radius:999px;padding:5px 14px 5px 6px;margin-bottom:24px}.lean-kicker b{font:500 11.5px/1 'Geist Mono', monospace;color:#fff;background:var(--lean-cobalt);border-radius:999px;padding:5px 8px}.lean-hero h1.lean-title{font-size:clamp(36px, 4.6vw, 56px);line-height:1.04;letter-spacing:-0.045em;font-weight:600;margin:0 0 20px;max-width:14ch;color:#fff;border:0;padding:0}.lean-lede{font-size:18px;line-height:1.6;color:#aeb6c8;max-width:48ch;margin:0 0 32px}.lean-cta{display:flex;gap:12px;flex-wrap:wrap}.lean-btn{display:inline-flex;align-items:center;height:40px;padding:0 18px;border-radius:10px;font-size:14.5px;font-weight:500;text-decoration:none!important;border:1px solid transparent}.lean-btn-primary{background:var(--lean-cobalt);color:#fff!important}.lean-btn-primary:hover{background:var(--lean-cobalt-ink)}.lean-btn-ghost{color:#fff!important;border-color:#ffffff2e;background:#ffffff08}.lean-btn-ghost:hover{background:#ffffff14;border-color:#ffffff44}.lean-facts{display:flex;flex-wrap:wrap;gap:20px 36px;margin-top:44px;padding-top:24px;border-top:1px solid #ffffff14;color:#8d95a8;font-size:13.5px}.lean-facts strong{display:block;color:#fff;font-weight:500;font-size:15px;margin-bottom:2px}.lean-steps{list-style:none;margin:24px 0 8px;padding:0!important;display:grid;grid-template-columns:repeat(5, minmax(0, 1fr));border-top:1px solid var(--lean-ink)}.dark .lean-steps{border-top-color:#ffffff55}.lean-steps li{padding:20px 20px 4px 0;margin:0!important}.lean-steps li+li{padding-left:20px;border-left:1px solid var(--lean-line)}.dark .lean-steps li+li{border-left-color:#ffffff14}.lean-steps li::marker{content:none}.lean-step-n{font:500 13px/1 'Geist Mono', monospace;color:var(--lean-faint);display:block;margin-bottom:28px}.lean-steps h3{font-size:16px;margin:0 0 6px;border:0;padding:0}.lean-steps p{margin:0 0 14px;color:var(--lean-slate);font-size:14px;line-height:1.6}.dark .lean-steps p{color:#9aa2b5}.lean-chip{display:inline-flex;flex-wrap:wrap;gap:8px;align-items:center;max-width:100%;padding:7px 10px;border-radius:8px;background:var(--lean-mist);border:1px solid var(--lean-line);font:500 12.5px/1.2 'Geist Mono', monospace;color:var(--lean-ink-2)!important;text-decoration:none!important;border-bottom-width:1px!important}.lean-chip:hover{border-color:#cfd3dc;color:var(--lean-ink)!important}.lean-chip code{background:none!important;border:0!important;padding:0!important;font:inherit!important;color:inherit!important}.dark .lean-chip{background:var(--lean-night-2);border-color:var(--lean-night-line);color:#d5dae6!important}.dark .lean-chip:hover{border-color:#3a4258;color:#fff!important}.lean-verb{font:600 10.5px/1 'Geist Mono', monospace;letter-spacing:.02em;padding:3px 5px;border-radius:4px}.lean-verb-get{color:#0f8a5f;background:#e7f6ef}.lean-verb-post{color:#2f5bff;background:#eef2ff}.dark .lean-verb-get{color:#4fd1a0;background:#0f8a5f26}.dark .lean-verb-post{color:#8ea6ff;background:#2f5bff26}@media (max-width: 1279px){.lean-steps{grid-template-columns:repeat(2, minmax(0, 1fr))}.lean-steps li,.lean-steps li+li{padding:20px 20px 16px 0;border-left:0;border-bottom:1px solid var(--lean-line)}.dark .lean-steps li,.dark .lean-steps li+li{border-bottom-color:#ffffff14}.lean-step-n{margin-bottom:14px}}@media (max-width: 700px){.lean-hero{padding:40px 24px}.lean-steps{grid-template-columns:1fr}}body,body *{-webkit-hyphens:none!important;hyphens:none!important}"}],"page":{"pagePath":"api-reference/orders/preview-order","slug":"/api-reference/orders/preview-order","pageMetadata":{"title":"Preview an order","openapi":"api-reference/openapi.json POST /orders/preview","description":"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.","href":"/api-reference/orders/preview-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: \"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\"\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":"Preview an order","openapi":"api-reference/openapi.json POST /orders/preview","description":"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.","href":"/api-reference/orders/preview-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"previewOrder","summary":"Preview an order","description":"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.","tags":["Orders"],"requestBody":"db509c84-18e0-4bc5-bf61-26ebe51cac50","responses":{"200":"72092d75-af34-4d54-b408-c576b6ebe6b1","400":"a4fcc4d9-960a-4547-9461-8186adb9f534","401":"abcb62d2-21f7-4557-9f24-bb3abd38f51b","403":"b96704b0-cb2c-4234-9f2b-69bdf45a9adc","404":"ac31f774-6543-465e-a010-ae07765361dd","409":"6160fb40-7880-466d-8d0a-5e084c5f2706","422":"35812d13-fb8b-4498-a04d-dd04ec68070b","429":"7da942d0-1787-42a8-81b8-cb9f80dfb91d","500":"53d1852f-a0f9-441e-a70b-f0b8eb2ec401","503":"00002b29-64d5-4907-b7d7-53396850817c"},"method":"post","type":"path","servers":["b9d200f3-058d-4de6-ac62-d3daef380488"],"security":["c7e5b678-a356-44de-a8fa-4ee7f0d1c1fd"],"path":"/orders/preview","baseUrlOptions":["{baseUrl}/v1"],"title":"Preview an order","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.client_order_id":"bot-0001","body.market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","body.action":"buy","body.quantity":"10","body.limit_price":"0.55","body.type":"limit","body.time_in_force":"gtc","body.all_or_none":false,"body.post_only":false,"body.best_price":false}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"client_order_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","description":"Unique per API key. Replaying an id returns the original order.","isRequired":true,"uniqueKey":"client_order_id","typeLabel":"string"},"market_id":{"type":"string","minLength":1,"maxLength":512,"description":"A market id from GET /markets, or a venue symbol that names one market: a Polymarket token id, a Hyperliquid book coin (`#…`, written `%23…` in a path), or a leg `ticker` (`pm:…`, `hl:…`, `pmus:…` or a Kalshi market ticker) that lists only this outcome. A symbol that names more than one market, such as a Polymarket condition id, is refused with 400; use the token id or the market id instead. An order named by a venue symbol trades only that listing, so it is refused when `venues` leaves out the symbol's venue. A buy routed automatically still buys that listing, paid from the other venue. The order is stored under the market id.","isRequired":true,"uniqueKey":"market_id","typeLabel":"string"},"action":{"type":"string","enum":["buy","sell"],"isRequired":true,"uniqueKey":"action","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","description":"Shares, in 0.01 steps. Send exactly one of quantity or notional. A sell of the whole position, as held or written to two decimals, sells what each venue's increment allows and keeps the rest.","uniqueKey":"quantity","typeLabel":"string"},"notional":{"type":"string","pattern":"^\\d+(?:\\.\\d{1,2})?$","description":"Dollars to spend on an ioc or fok buy, in place of quantity, at most two decimals. The buy walks the books from the best price and never spends more than this before fees; Lean works out the shares. Sells and resting orders are sized with quantity.","uniqueKey":"notional","typeLabel":"string"},"limit_price":{"type":"string","description":"Worst price per share you accept, in dollars. Required with quantity on a limit order. With notional or on a market order it defaults to 0.99 for a buy and 0.01 for a sell; a market order is then placed 1 cent past the worst price its quantity reaches in the book, tightened by max_slippage_bps when set.","uniqueKey":"limit_price","typeLabel":"string"},"type":{"type":"string","enum":["limit","market"],"default":"limit","description":"limit trades at limit_price or better. market trades at once at the best prices: it needs time_in_force ioc or fok, and each venue order is placed 1 cent past the worst price its quantity reaches in the book of that venue. limit_price and max_slippage_bps are optional extra caps on the worst price it accepts.","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"time_in_force":{"type":"string","enum":["gtc","ioc","fok","gtd"],"default":"gtc","description":"gtc rests until filled or canceled. ioc fills what it can at once and cancels the rest. fok fills the whole order at once or cancels all of it, and is placed whole on one venue: Polymarket, else Kalshi, else Polymarket US, since Hyperliquid has no fill or kill. gtd rests like gtc until expires_at, and is placed on Kalshi, Polymarket and Polymarket US, since Hyperliquid has no order expiry. Polymarket takes an ioc or fok buy only by dollar amount: one sized with notional can fill there, while one sized with quantity goes only to the other venues, and when Polymarket is the only one it is refused with 400 VALIDATION_ERROR, so send it with notional or as gtc. notional needs ioc or fok.","uniqueKey":"time_in_force","typeLabel":"enum\u003cstring>"},"expires_at":{"type":"string","format":"date-time","description":"When a gtd order expires, as an ISO 8601 time. Required with gtd and refused with any other time_in_force. At least 3 minutes and at most 30 days ahead. Whatever has not filled by then is canceled, and the order reads expired.","uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"max_slippage_bps":{"type":"integer","minimum":0,"maximum":10000,"description":"Optional extra cap: the furthest each venue order may trade from that venue's own best price, in basis points; overrides the account's max_slippage_bps. Each venue is measured against its own book, not the best price across venues, so venues quoting different prices can each fill. Never looser than limit_price. Without one, a limit order trades to its limit and a market order to 1 cent past the worst price its quantity reaches in the book, as the Lean trading terminal places it.","uniqueKey":"max_slippage_bps","typeLabel":"integer"},"all_or_none":{"type":"boolean","default":false,"description":"Refuse the order unless the books, as read, fill the whole quantity within the slippage bound. Needs time_in_force ioc or fok. Best effort: venue orders are placed separately and books can move between the read and the fill, so a partial fill is still possible.","uniqueKey":"all_or_none","typeLabel":"boolean"},"post_only":{"type":"boolean","default":false,"description":"Only rest on the book, never take. Needs time_in_force gtc, cannot take best_price, and is placed on Kalshi, Polymarket US and Hyperliquid, since Polymarket cannot rest post-only. An order that would trade at once against the books, as read, is refused with reason POST_ONLY_WOULD_CROSS, and the venue rejects one that would trade by the time it arrives.","uniqueKey":"post_only","typeLabel":"boolean"},"venues":{"type":"array","items":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"uniqueKey":"venues.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Only these venues may fill or fund the order, within the account's allowed venues. A single venue sends the order only there, and the order is refused if that venue can't fill it. Omit to use every allowed venue.","uniqueKey":"venues","typeLabel":"enum\u003cstring>[]"},"best_price":{"type":"boolean","default":false,"description":"Buy at the best price across venues: when a route across venues that moves cash from another venue would cost less in all than buying where the account's cash is, the buy goes through that route. Needs the route scope. A test key prices a route at the order's limit, so there it wins only when the direct buy's fees cost more. Sells already sell across every venue that holds shares, so this does not change them.","uniqueKey":"best_price","typeLabel":"boolean"}},"required":["client_order_id","market_id","action"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"client_order_id":"bot-0001","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","type":"limit","quantity":"10","limit_price":"0.55","time_in_force":"gtc","all_or_none":false,"post_only":false,"best_price":false},"examples":{"Example":{"title":"Example","value":{"client_order_id":"bot-0001","market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","type":"limit","quantity":"10","limit_price":"0.55","time_in_force":"gtc","all_or_none":false,"post_only":false,"best_price":false}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"72092d75-af34-4d54-b408-c576b6ebe6b1":{"description":"What POST /v1/orders would do with this body and the best route across venues; places and reserves nothing","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":{"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"},"action":{"type":"string","enum":["buy","sell"],"isRequired":true,"uniqueKey":"oneOf.0.data.action","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.limit_price","typeLabel":"string"},"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"},"execution":{"oneOf":[{"type":"object","properties":{"venue":{"oneOf":[{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.venue.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.venue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.venue","typeLabel":"enum\u003cstring> | null"},"ticker":{"oneOf":[{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.ticker.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.ticker.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.ticker","typeLabel":"string | null"},"side":{"oneOf":[{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.side.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.side.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.side","typeLabel":"enum\u003cstring> | null"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.notional_usd","typeLabel":"string"},"max_slippage_bps":{"oneOf":[{"type":"integer","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.max_slippage_bps.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.max_slippage_bps.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.max_slippage_bps","typeLabel":"integer | null"},"executable_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.executable_quantity","typeLabel":"string"},"expected_average_price":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.expected_average_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.expected_average_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.expected_average_price","typeLabel":"string | null"},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].venue","typeLabel":"enum\u003cstring>"},"ticker":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].ticker","typeLabel":"string"},"side":{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].quantity","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].limit_price","typeLabel":"string"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].notional_usd","typeLabel":"string"},"expected_fill_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_fill_quantity","typeLabel":"string"},"expected_average_price":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_average_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_average_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_average_price","typeLabel":"string | null"},"expected_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_fee_usd","typeLabel":"string"},"expected_resting_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX].expected_resting_fee_usd","typeLabel":"string"}},"required":["venue","ticker","side","quantity","limit_price","notional_usd","expected_fill_quantity","expected_average_price","expected_fee_usd","expected_resting_fee_usd"],"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0.legs","typeLabel":"object[]"}},"required":["venue","ticker","side","notional_usd","max_slippage_bps","executable_quantity","expected_average_price","legs"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"venue":{"oneOf":[{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]},{"type":"null","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]}]},"ticker":{"oneOf":[{"type":"string","minLength":1},{"type":"null","minLength":1}]},"side":{"oneOf":[{"type":"string","enum":["yes","no"]},{"type":"null","enum":["yes","no"]}]},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"max_slippage_bps":{"oneOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null","minimum":0,"maximum":10000}]},"executable_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"expected_average_price":{"oneOf":[{"type":"string"},{"type":"null"}]},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]},"ticker":{"type":"string","minLength":1},"side":{"type":"string","enum":["yes","no"]},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"limit_price":{"type":"string"},"notional_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"expected_fill_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"expected_average_price":{"oneOf":[{"type":"string"},{"type":"null"}]},"expected_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"expected_resting_fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"}},"required":["venue","ticker","side","quantity","limit_price","notional_usd","expected_fill_quantity","expected_average_price","expected_fee_usd","expected_resting_fee_usd"]}}},"required":["venue","ticker","side","notional_usd","max_slippage_bps","executable_quantity","expected_average_price","legs"],"isRequired":true,"uniqueKey":"oneOf.0.data.execution.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.execution","typeLabel":"object | null"},"would_submit":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.would_submit","typeLabel":"boolean"},"route_plan":{"oneOf":[{"type":"object","properties":{"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.route_plan.oneOf.0.market_id","typeLabel":"string"},"action":{"type":"string","enum":["buy","sell"],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.action","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.quantity","typeLabel":"string"},"executable_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.executable_quantity","typeLabel":"string"},"average_price":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.average_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.average_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.average_price","typeLabel":"string | null"},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].venue","typeLabel":"enum\u003cstring>"},"ticker":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].ticker","typeLabel":"string"},"side":{"type":"string","enum":["yes","no"],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].quantity","typeLabel":"string"},"average_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].average_price","typeLabel":"string"},"limit_price":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].limit_price","typeLabel":"string"},"fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].fee_usd","typeLabel":"string"},"executable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX].executable","typeLabel":"boolean"}},"required":["venue","ticker","side","quantity","average_price","limit_price","fee_usd","executable"],"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.legs","typeLabel":"object[]"},"expected_total_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.expected_total_usd","typeLabel":"string"},"max_total_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.max_total_usd","typeLabel":"string"},"network_cost_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.network_cost_usd","typeLabel":"string"},"limited_by":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.limited_by.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.limited_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.limited_by","typeLabel":"string | null"},"quoted_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.quoted_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.expires_at","typeLabel":"string\u003cdate-time>"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0.livemode","typeLabel":"boolean"}},"required":["market_id","action","quantity","executable_quantity","average_price","legs","expected_total_usd","max_total_usd","network_cost_usd","limited_by","quoted_at","expires_at","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"market_id":{"type":"string","minLength":1,"description":"The market id from GET /markets, however the request named the market."},"action":{"type":"string","enum":["buy","sell"]},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"executable_quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"average_price":{"oneOf":[{"type":"string"},{"type":"null"}]},"legs":{"type":"array","items":{"type":"object","properties":{"venue":{"type":"string","enum":["kalshi","polymarket","polymarket_us","hyperliquid"]},"ticker":{"type":"string","minLength":1},"side":{"type":"string","enum":["yes","no"]},"quantity":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"average_price":{"type":"string"},"limit_price":{"type":"string"},"fee_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"executable":{"type":"boolean"}},"required":["venue","ticker","side","quantity","average_price","limit_price","fee_usd","executable"]}},"expected_total_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"max_total_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"network_cost_usd":{"type":"string","pattern":"^\\d+(?:\\.\\d+)?$"},"limited_by":{"oneOf":[{"type":"string"},{"type":"null"}]},"quoted_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"livemode":{"type":"boolean"}},"required":["market_id","action","quantity","executable_quantity","average_price","legs","expected_total_usd","max_total_usd","network_cost_usd","limited_by","quoted_at","expires_at","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.data.route_plan","typeLabel":"object | null"},"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"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BELOW_VENUE_MINIMUM","ORDER_NOTIONAL_LIMIT","DAILY_NOTIONAL_LIMIT","NO_EXECUTABLE_VENUE","VENUE_NOT_ALLOWED","INSUFFICIENT_FUNDS","INSUFFICIENT_HOLDINGS","INSUFFICIENT_DEPTH","POST_ONLY_WOULD_CROSS","CLIENT_ORDER_ID_USED","TRADING_UNAVAILABLE","ROUTE_LIMITED","ROUTE_UNAVAILABLE"],"isRequired":true,"uniqueKey":"oneOf.0.data.warnings.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.warnings.items.[INDEX].message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"oneOf.0.data.warnings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.warnings","typeLabel":"object[]"},"livemode":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.livemode","typeLabel":"boolean"}},"required":["market_id","action","quantity","limit_price","type","time_in_force","expires_at","execution","would_submit","route_plan","route","warnings","livemode"],"isRequired":true,"uniqueKey":"oneOf.0.data","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.0.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.0.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.0.meta","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["success","error","meta"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"oneOf.1.success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","FORBIDDEN","CONFLICT","UPSTREAM_ERROR","RATE_LIMITED","INTERNAL_ERROR","FEATURE_DISABLED","CONDITIONAL_SELL_REJECTED","CONDITIONAL_SELL_ACTIVE"],"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"oneOf":[{},{"type":"null","uniqueKey":"oneOf.1.error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.error.details","typeLabel":"null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"},"meta":{"type":"object","properties":{"timestampMs":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.meta.timestampMs","typeLabel":"integer"},"requestId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.meta.requestId","typeLabel":"string"},"traceId":{"type":"string","minLength":1,"uniqueKey":"oneOf.1.meta.traceId","typeLabel":"string"},"cachedAtMs":{"type":"integer","minimum":0,"uniqueKey":"oneOf.1.meta.cachedAtMs","typeLabel":"integer"},"source":{"type":"string","enum":["cache","database","clickhouse","upstream","fallback","internal"],"uniqueKey":"oneOf.1.meta.source","typeLabel":"enum\u003cstring>"}},"required":["timestampMs","requestId"],"isRequired":true,"uniqueKey":"oneOf.1.meta","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Would submit":{"title":"Would submit","summary":"POST /v1/orders would place this","value":{"success":true,"data":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","limit_price":"0.50","type":"limit","time_in_force":"ioc","expires_at":null,"execution":{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","notional_usd":"2.5","max_slippage_bps":700,"executable_quantity":"5","expected_average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"}]},"would_submit":true,"route_plan":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","executable_quantity":"5","average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true}],"expected_total_usd":"2.35","max_total_usd":"2.5","network_cost_usd":"0","limited_by":null,"quoted_at":"2026-10-11T18:00:00.000Z","expires_at":"2026-10-11T18:00:15.000Z","livemode":true},"route":null,"warnings":[],"livemode":true},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}},"Would be refused":{"title":"Would be refused","summary":"Above the key limit; would_submit is false","value":{"success":true,"data":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"50","limit_price":"0.50","type":"limit","time_in_force":"ioc","expires_at":null,"execution":null,"would_submit":false,"route_plan":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"50","executable_quantity":"50","average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"50","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"50","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true}],"expected_total_usd":"23.5","max_total_usd":"25","network_cost_usd":"0","limited_by":null,"quoted_at":"2026-10-11T18:00:00.000Z","expires_at":"2026-10-11T18:00:15.000Z","livemode":true},"route":null,"warnings":[{"code":"ORDER_NOTIONAL_LIMIT","message":"Order notional exceeds this key's per-order limit"},{"code":"ORDER_NOTIONAL_LIMIT","message":"Order notional exceeds this key's per-order limit"}],"livemode":true},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}},"Insufficient funds":{"title":"Insufficient funds","summary":"No venue that could place it has the cash","value":{"success":true,"data":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","limit_price":"0.50","type":"limit","time_in_force":"ioc","expires_at":null,"execution":null,"would_submit":false,"route_plan":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","executable_quantity":"5","average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true}],"expected_total_usd":"2.35","max_total_usd":"2.5","network_cost_usd":"0","limited_by":null,"quoted_at":"2026-10-11T18:00:00.000Z","expires_at":"2026-10-11T18:00:15.000Z","livemode":true},"route":null,"warnings":[{"code":"INSUFFICIENT_FUNDS","message":"The trading account cannot pay for this order on the venues that could place it"},{"code":"INSUFFICIENT_FUNDS","message":"The trading account cannot pay for this order on the venues that could place it"}],"livemode":true},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}},"Test key":{"title":"Test key","summary":"A test key's plan is simulated over the public order books","value":{"success":true,"data":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","limit_price":"0.50","type":"limit","time_in_force":"ioc","expires_at":null,"execution":{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","notional_usd":"2.5","max_slippage_bps":700,"executable_quantity":"5","expected_average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"}]},"would_submit":true,"route_plan":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","executable_quantity":"5","average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true}],"expected_total_usd":"2.35","max_total_usd":"2.5","network_cost_usd":"0","limited_by":null,"quoted_at":"2026-10-11T18:00:00.000Z","expires_at":"2026-10-11T18:00:15.000Z","livemode":false},"route":null,"warnings":[],"livemode":false},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}},"Live trading off":{"title":"Live trading off","summary":"A live key on an account where live trading is not enabled yet","value":{"success":true,"data":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","limit_price":"0.50","type":"limit","time_in_force":"ioc","expires_at":null,"execution":{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","notional_usd":"2.5","max_slippage_bps":700,"executable_quantity":"5","expected_average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","limit_price":"0.50","notional_usd":"2.5","expected_fill_quantity":"5","expected_average_price":"0.47","expected_fee_usd":"0","expected_resting_fee_usd":"0"}]},"would_submit":false,"route_plan":{"market_id":"mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4","action":"buy","quantity":"5","executable_quantity":"5","average_price":"0.47","legs":[{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true},{"venue":"hyperliquid","ticker":"\u003cvenue ticker>","side":"yes","quantity":"5","average_price":"0.47","limit_price":"0.50","fee_usd":"0","executable":true}],"expected_total_usd":"2.35","max_total_usd":"2.5","network_cost_usd":"0","limited_by":null,"quoted_at":"2026-10-11T18:00:00.000Z","expires_at":"2026-10-11T18:00:15.000Z","livemode":true},"route":null,"warnings":[{"code":"TRADING_UNAVAILABLE","message":"Live order placement is switched off. Test keys can still place simulated orders."},{"code":"TRADING_UNAVAILABLE","message":"Live order placement is switched off. Test keys can still place simulated orders."}],"livemode":true},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a4fcc4d9-960a-4547-9461-8186adb9f534":{"description":"The order terms are invalid or no venue takes them","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"},"examples":{"market_gtc":{"title":"market_gtc","summary":"A market order that would rest","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"market orders need time_in_force ioc or fok"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}},"gtd_on_hyperliquid":{"title":"gtd_on_hyperliquid","summary":"gtd with only a Hyperliquid listing","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"gtd orders are placed on Kalshi, Polymarket, or Polymarket US, since Hyperliquid has no order expiry, and this order has none of them to go to"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}},"gtd_without_expiry":{"title":"gtd_without_expiry","summary":"gtd without expires_at","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"gtd orders need expires_at"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}},"Bad limit price":{"title":"Bad limit price","summary":"limit_price outside (0, 1)","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"limit_price must be strictly between 0 and 1"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"abcb62d2-21f7-4557-9f24-bb3abd38f51b":{"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"},"examples":{"Unknown key":{"title":"Unknown key","summary":"Unknown, expired or revoked key","value":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Invalid, expired or revoked API key"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}},"Missing key":{"title":"Missing key","summary":"No Authorization header","value":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Missing API key"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"b96704b0-cb2c-4234-9f2b-69bdf45a9adc":{"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"},"examples":{"Missing scope":{"title":"Missing scope","summary":"The key lacks the read scope","value":{"success":false,"error":{"code":"FORBIDDEN","message":"This API key lacks the read scope"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ac31f774-6543-465e-a010-ae07765361dd":{"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"},"examples":{"Not found":{"title":"Not found","summary":"Market not found","value":{"success":false,"error":{"code":"NOT_FOUND","message":"Market not found"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6160fb40-7880-466d-8d0a-5e084c5f2706":{"description":"A venue has stopped trading the market, so it has no book to quote; details.reason is MARKET_NOT_TRADABLE","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"},"examples":{"market_not_tradable":{"title":"market_not_tradable","summary":"The venue stopped trading the market","value":{"success":false,"error":{"code":"CONFLICT","message":"Polymarket has stopped trading this market","details":{"reason":"MARKET_NOT_TRADABLE"}},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"35812d13-fb8b-4498-a04d-dd04ec68070b":{"description":"The body is sized wrong; nothing was checked further","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"},"examples":{"quantity_and_notional":{"title":"quantity_and_notional","summary":"Both or neither of quantity and notional","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Send exactly one of quantity or notional"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}},"notional_gtc":{"title":"notional_gtc","summary":"notional on a resting order","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"notional needs time_in_force ioc or fok; size a resting order with quantity"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}},"notional_sell":{"title":"notional_sell","summary":"notional on a sell","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"notional sizes buys only; size a sell with quantity"},"meta":{"timestampMs":1792771200000,"requestId":"7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7da942d0-1787-42a8-81b8-cb9f80dfb91d":{"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"},"examples":{"Rate limited":{"title":"Rate limited","summary":"Over 5 requests a second; wait for Retry-After","value":{"success":false,"error":{"code":"RATE_LIMITED","message":"Too many requests for this API key"},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"53d1852f-a0f9-441e-a70b-f0b8eb2ec401":{"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"},"examples":{"Internal error":{"title":"Internal error","summary":"Unexpected server error","value":{"success":false,"error":{"code":"INTERNAL_ERROR","message":"An internal error occurred."},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"exampleType":"examples"}},"exampleType":"examples"},"00002b29-64d5-4907-b7d7-53396850817c":{"description":"A venue failed or did not answer, or routing is paused","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"},"examples":{"Venue error":{"title":"Venue error","summary":"The venue failed or did not answer","value":{"success":false,"error":{"code":"UPSTREAM_ERROR","message":"A required service is temporarily unavailable."},"meta":{"timestampMs":1791741600000,"requestId":"0e7a3c91-5f2b-4d84-9c16-a8b4e2d7f031"}}}},"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":"Preview an order - Lean API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T23:15:58.267Z","originalFileLocation":"api-reference/orders/preview-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=\"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\">\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=\"Preview an order - Lean API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\">\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/preview-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=Preview+an+order\u0026amp;description=Runs+the+same+checks+as+POST+%2Fv1%2Forders+on+the+same+body+and+returns+what+it+would+do%3A+the+venue+legs%2C+the+expected+average+price%2C+the+route+a+buy+would+take+an\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=9f36d3c181bdadd251901c79f699353b47794a37105c2f030ee7245c96d25d64\">\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=\"Preview an order - Lean API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lean.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Preview+an+order\u0026amp;description=Runs+the+same+checks+as+POST+%2Fv1%2Forders+on+the+same+body+and+returns+what+it+would+do%3A+the+venue+legs%2C+the+expected+average+price%2C+the+route+a+buy+would+take+an\u0026amp;theme=479271959554d25dc0271270\u0026amp;signature=9f36d3c181bdadd251901c79f699353b47794a37105c2f030ee7245c96d25d64\">\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/preview-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/preview-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/preview-order#webpage\",\"url\":\"https://lean.mintlify.app/api-reference/orders/preview-order\",\"name\":\"Preview an order\",\"description\":\"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\",\"dateModified\":\"2026-11-12T23:15:58.267Z\",\"isPartOf\":{\"@id\":\"https://lean.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://lean.mintlify.app/api-reference/orders/preview-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://lean.mintlify.app/api-reference/orders/preview-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lean API\",\"item\":\"https://lean.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview an order\",\"item\":\"https://lean.mintlify.app/api-reference/orders/preview-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://lean.mintlify.app/api-reference/orders/preview-order#apireference\",\"headline\":\"Preview an order\",\"name\":\"Preview an order\",\"description\":\"Runs the same checks as POST /v1/orders on the same body and returns what it would do: the venue legs, the expected average price, the route a buy would take and whether the order would be refused before reaching a venue. Nothing is placed or reserved.\",\"url\":\"https://lean.mintlify.app/api-reference/orders/preview-order\",\"mainEntityOfPage\":{\"@id\":\"https://lean.mintlify.app/api-reference/orders/preview-order#webpage\"},\"dateModified\":\"2026-11-12T23:15:58.267Z\",\"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/preview-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","description":"Best bid and ask with the quantity resting at each, mid and last trade for up to 25 markets in one call, across venues and per venue. Ids that match no market are returned in `not_found`.","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","description":"Previews up to 25 order bodies in one call, each exactly as POST /v1/orders/preview previews it, and runs them at once, so a batch takes about as long as its slowest preview. Each body is previewed on its own: the batch does not add the notional of one body to another's limit checks. One body that cannot be previewed does not stop the rest; its result carries the status and error the single preview answers with. Results are in the order the bodies were sent. Nothing is placed or reserved, and the call counts once against the key's rate limit.","href":"/api-reference/orders/preview-orders-batch"},{"title":"Create an order","openapi":"api-reference/openapi.json POST /orders","href":"/api-reference/orders/create-order"},{"title":"List orders","openapi":"api-reference/openapi.json GET /orders","href":"/api-reference/orders/list-orders"},{"title":"Retrieve an order","openapi":"api-reference/openapi.json GET /orders/{id}","href":"/api-reference/orders/retrieve-order"},{"title":"Amend an order","openapi":"api-reference/openapi.json PATCH /orders/{id}","href":"/api-reference/orders/amend-order"},{"title":"Cancel an order","openapi":"api-reference/openapi.json POST /orders/{id}/cancel","href":"/api-reference/orders/cancel-order"},{"title":"Cancel every open order","openapi":"api-reference/openapi.json POST /orders/cancel-all","href":"/api-reference/orders/cancel-all-orders"},{"title":"Set a cancel timer","openapi":"api-reference/openapi.json POST /orders/cancel-after","href":"/api-reference/orders/set-cancel-after"},{"title":"Cancel several orders","openapi":"api-reference/openapi.json POST /orders/cancel-batch","href":"/api-reference/orders/cancel-orders-batch"},{"title":"List fills","openapi":"api-reference/openapi.json GET /fills","href":"/api-reference/orders/list-fills"},{"title":"Place a routed order","openapi":"api-reference/openapi.json POST /routed-orders","href":"/api-reference/orders/create-routed-order"},{"title":"Execute a routed order","openapi":"api-reference/openapi.json POST /routed-orders/{id}/execute","href":"/api-reference/orders/execute-routed-order"}]},{"group":"Stop losses","pages":[{"title":"Create a stop loss or take profit","openapi":"api-reference/openapi.json POST /stop-losses","href":"/api-reference/stop-losses/create-stop-loss"},{"title":"List stop losses","openapi":"api-reference/openapi.json GET /stop-losses","href":"/api-reference/stop-losses/list-stop-losses"},{"title":"Get a stop loss","openapi":"api-reference/openapi.json GET /stop-losses/{id}","href":"/api-reference/stop-losses/retrieve-stop-loss"},{"title":"Cancel a stop loss","openapi":"api-reference/openapi.json DELETE /stop-losses/{id}","href":"/api-reference/stop-losses/cancel-stop-loss"}]},{"group":"Limit chases","pages":[{"title":"Create a limit chase","openapi":"api-reference/openapi.json POST /limit-chases","href":"/api-reference/limit-chases/create-limit-chase"},{"title":"List limit chases","openapi":"api-reference/openapi.json GET /limit-chases","href":"/api-reference/limit-chases/list-limit-chases"},{"title":"Get a limit chase","openapi":"api-reference/openapi.json GET /limit-chases/{id}","href":"/api-reference/limit-chases/retrieve-limit-chase"},{"title":"Cancel a limit chase","openapi":"api-reference/openapi.json DELETE /limit-chases/{id}","href":"/api-reference/limit-chases/cancel-limit-chase"}]},{"group":"Account","pages":[{"title":"List positions","openapi":"api-reference/openapi.json GET /positions","href":"/api-reference/account/list-positions"},{"title":"Close positions","openapi":"api-reference/openapi.json POST /positions/close","href":"/api-reference/account/close-positions"},{"title":"List balances","openapi":"api-reference/openapi.json GET /balances","href":"/api-reference/account/list-balances"},{"title":"Get profit and loss","openapi":"api-reference/openapi.json GET /pnl","href":"/api-reference/account/get-pnl"},{"title":"Get profit and loss history","openapi":"api-reference/openapi.json GET /pnl/history","href":"/api-reference/account/get-pnl-history"},{"title":"Get risk","openapi":"api-reference/openapi.json GET /risk","href":"/api-reference/account/get-risk"},{"title":"Get account configuration","openapi":"api-reference/openapi.json GET /account/config","href":"/api-reference/account/retrieve-account-config"},{"title":"Lower this key's limits","openapi":"api-reference/openapi.json POST /account/limits","href":"/api-reference/account/lower-key-limits"},{"title":"Pause order placement","openapi":"api-reference/openapi.json POST /account/pause","href":"/api-reference/account/pause-trading"}]},{"group":"Deposits","pages":[{"title":"List deposit assets","openapi":"api-reference/openapi.json GET /deposits/assets","href":"/api-reference/deposits/list-deposit-assets"},{"title":"Get deposit addresses","openapi":"api-reference/openapi.json GET /deposits/addresses","href":"/api-reference/deposits/list-deposit-addresses"},{"title":"Create deposit addresses","openapi":"api-reference/openapi.json POST /deposits/addresses","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":"Preview 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"]}