{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polymarket US Documentation","colors":{"primary":"#165DFC","light":"#165DFC","dark":"#165DFC"},"logo":{"light":"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=31d6284cd801a07214abb060e79928e4","dark":"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=5a708086de6cea6b0d2e06113cb3d890"},"favicon":"https://mintcdn.com/polymarketusdocs/evzbz56sXnnj2zm_/favicon.svg?fit=max\u0026auto=format\u0026n=evzbz56sXnnj2zm_\u0026q=85\u0026s=c10a861ca59caafabd100b8975cc0b5c","background":{"color":{"light":"#FFFFFF","dark":"#0A0B0D"}},"navbar":{"links":[{"icon":"signal","href":"https://status.polymarketexchange.com","label":"System Status"},{"icon":"discord","href":"https://discord.gg/cA6Skf5wCk","label":"Join Discord"}],"primary":{"type":"button","label":"Main Site","href":"https://polymarket.us"}},"footer":{"socials":{"x":"https://x.com/polymarket","linkedin":"https://www.linkedin.com/company/polymarket","discord":"https://discord.gg/cA6Skf5wCk"},"links":[{"header":"Polymarket","items":[{"label":"Careers","href":"https://polymarket.com/careers"},{"label":"Polymarket International","href":"https://polymarket.com"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://polymarket.us/privacy"},{"label":"Terms of Service","href":"https://polymarket.us/tos"},{"label":"Market Integrity","href":"https://integrity.polymarket.us/"},{"label":"System Status","href":"https://status.polymarketexchange.com"},{"label":"Polymarket Exchange","href":"https://polymarketexchange.com/"},{"label":"Polymarket Clearing","href":"https://polymarketclearing.com/"}]}]},"fonts":{"family":"Inter"},"styling":{"eyebrows":"breadcrumbs","latex":false},"banner":{"content":"You are viewing documentation for Polymarket US","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polymarketusdocs","hasAudioNarration":false,"actualSubdomain":"polymarketusdocs","customDomains":["docs.polymarket.us"],"gitSource":{"type":"github","owner":"polymarket","repo":"website-isv-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0e73a400e864d11fae193","collectionId":"01f350a0-5cec-4ca6-8046-522ecfffdb18","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0e73a400e864d11fae193"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0e7b6a716ea245f81c860","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Institutional API","count":120},{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"REST API","count":64},{"language":"default","tag":"App Users","count":47},{"language":"default","tag":"RFQs","count":42},{"language":"default","tag":"Partner Integration","count":29},{"language":"default","tag":"Trading","count":28},{"language":"default","tag":"FIX API","count":23},{"language":"default","tag":"SDKs","count":21},{"language":"default","tag":"Guide","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"http://polymarket.us/support"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-container table{table-layout:auto}#content-container table td,#content-container table th{min-width:0!important}#content-container table td code,#content-container table td[data-numeric=true],#content-container table th code{white-space:nowrap}.rewards-cta .card{background:#165dfc!important;border-color:transparent!important}.rewards-cta .card:hover{background:#1253e0!important;border-color:transparent!important}.rewards-cta .card [data-component-part=card-title]{color:#fff!important}.rewards-cta .card [data-component-part=card-content]{color:rgb(255 255 255/.85)!important}.rewards-cta .card [data-component-part=card-icon] svg{background-color:#fff!important}.rewards-cta .card #card-link-arrow-icon{color:rgb(255 255 255/.8)!important}"}],"page":{"pagePath":"api-reference/orders/preview-order","slug":"/api-reference/orders/preview-order","pageMetadata":{"title":"Preview Order","description":"Preview an order before submission to validate parameters and see expected fills","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/preview","href":"/api-reference/orders/preview-order","autogeneratedByOpenApi":true},"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: \"Preview an order before submission to validate parameters and see expected fills\"\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":{"config":{},"pageMetadata":{"title":"Preview Order","description":"Preview an order before submission to validate parameters and see expected fills","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/preview","href":"/api-reference/orders/preview-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Orders"],"summary":"Preview Order","description":"Preview an order before submission to validate parameters and see expected fills","operationId":"OrdersService_PreviewOrder","requestBody":"30b78a70-137d-4ee6-8f87-36ebfe324dbe","responses":{"200":"5924dd82-1898-4add-8f7e-8534671e7209","400":"2a44db83-bfa2-421d-805d-1b91c58c4eb9","401":"8cb44f5d-e66b-4436-b976-48347ea8391f","500":"718b2eba-f0a2-41b5-ae00-e6f35a512a74"},"method":"post","type":"path","servers":["bd11bacf-a866-41bf-b17f-09ae149fafc7"],"security":["8edbfa0b-66a3-49ab-b21b-1d89e773228c"],"path":"/v1/order/preview","baseUrlOptions":["https://api.polymarket.us"],"title":"Preview Order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Request to preview an order","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","required":["marketSlug"],"properties":{"marketSlug":{"type":"string","description":"Unique market slug into which the order should be entered","isRequired":true,"uniqueKey":"request.marketSlug","typeLabel":"string"},"type":{"type":"string","enum":["ORDER_TYPE_LIMIT","ORDER_TYPE_MARKET"],"description":"Type of order (limit or market)","uniqueKey":"request.type","typeLabel":"enum\u003cstring>"},"price":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"request.price.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"request.price.currency","typeLabel":"string"}},"description":"Order price and currency. Required for limit orders.","uniqueKey":"request.price","typeLabel":"object"},"quantity":{"type":"number","format":"double","description":"Order quantity in contracts. Supports decimal quantities on markets whose minimumTradeQty is less than 1.","uniqueKey":"request.quantity","typeLabel":"number\u003cdouble>"},"tif":{"type":"string","enum":["TIME_IN_FORCE_DAY","TIME_IN_FORCE_GOOD_TILL_CANCEL","TIME_IN_FORCE_GOOD_TILL_DATE","TIME_IN_FORCE_IMMEDIATE_OR_CANCEL","TIME_IN_FORCE_FILL_OR_KILL"],"description":"Order time in force policy","uniqueKey":"request.tif","typeLabel":"enum\u003cstring>"},"participateDontInitiate":{"type":"boolean","description":"If true, order must rest on the book prior to matching (maker only). Order will be rejected if it would immediately match.","uniqueKey":"request.participateDontInitiate","typeLabel":"boolean"},"goodTillTime":{"type":"string","description":"Expiration time for orders with TIME_IN_FORCE_GOOD_TILL_DATE","uniqueKey":"request.goodTillTime","typeLabel":"string"},"intent":{"type":"string","enum":["ORDER_INTENT_BUY_LONG","ORDER_INTENT_SELL_LONG","ORDER_INTENT_BUY_SHORT","ORDER_INTENT_SELL_SHORT"],"description":"Order intent. Either `intent` or (`outcomeSide` + `action`) must be set.","uniqueKey":"request.intent","typeLabel":"enum\u003cstring>"},"outcomeSide":{"type":"string","enum":["OUTCOME_SIDE_YES","OUTCOME_SIDE_NO"],"description":"Outcome side. Set with `action` as an alternative to `intent`. Takes priority if both are set.","uniqueKey":"request.outcomeSide","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["ORDER_ACTION_BUY","ORDER_ACTION_SELL"],"description":"Order action. Set with `outcomeSide` as an alternative to `intent`.","uniqueKey":"request.action","typeLabel":"enum\u003cstring>"},"cashOrderQty":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"request.cashOrderQty.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"request.cashOrderQty.currency","typeLabel":"string"}},"description":"Order quantity in cash and currency. Used for market orders instead of share quantity.","uniqueKey":"request.cashOrderQty","typeLabel":"object"},"manualOrderIndicator":{"type":"string","enum":["MANUAL_ORDER_INDICATOR_MANUAL","MANUAL_ORDER_INDICATOR_AUTOMATIC"],"description":"Indicates whether the order was placed manually or automatically","uniqueKey":"request.manualOrderIndicator","typeLabel":"enum\u003cstring>"},"synchronousExecution":{"type":"boolean","description":"If true, will block until the order is filled, rejected, canceled, or expired, up to maxBlockTime seconds","uniqueKey":"request.synchronousExecution","typeLabel":"boolean"},"maxBlockTime":{"type":"string","format":"int64","description":"Maximum block time in seconds if synchronous execution is requested","uniqueKey":"request.maxBlockTime","typeLabel":"string\u003cint64>"},"slippageTolerance":{"type":"object","properties":{"currentPrice":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"request.slippageTolerance.currentPrice.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"request.slippageTolerance.currentPrice.currency","typeLabel":"string"}},"description":"Current price of the market used as reference for slippage calculation","uniqueKey":"request.slippageTolerance.currentPrice","typeLabel":"object"},"bips":{"oneOf":[{"type":"integer","format":"int32","description":"Slippage tolerance in basis points (1 bip = 0.01%)","uniqueKey":"request.slippageTolerance.bips.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Slippage tolerance in basis points (1 bip = 0.01%)","uniqueKey":"request.slippageTolerance.bips.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.slippageTolerance.bips","typeLabel":"integer\u003cint32> | null"},"ticks":{"oneOf":[{"type":"integer","format":"int32","description":"Slippage tolerance in price ticks. Takes priority over bips if both are set.","uniqueKey":"request.slippageTolerance.ticks.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Slippage tolerance in price ticks. Takes priority over bips if both are set.","uniqueKey":"request.slippageTolerance.ticks.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.slippageTolerance.ticks","typeLabel":"integer\u003cint32> | null"}},"description":"Slippage tolerance configuration for the order","uniqueKey":"request.slippageTolerance","typeLabel":"object"}},"description":"The order to preview","uniqueKey":"request","typeLabel":"object"}},"description":"Request to preview an order","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5924dd82-1898-4add-8f7e-8534671e7209":{"description":"Order previewed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","description":"Exchange-assigned order ID","uniqueKey":"order.id","typeLabel":"string"},"marketSlug":{"type":"string","description":"Market slug for this order","uniqueKey":"order.marketSlug","typeLabel":"string"},"side":{"type":"string","enum":["ORDER_SIDE_BUY","ORDER_SIDE_SELL"],"description":"Side of the order (buy or sell)","uniqueKey":"order.side","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["ORDER_TYPE_LIMIT","ORDER_TYPE_MARKET"],"description":"Type of order (limit or market)","uniqueKey":"order.type","typeLabel":"enum\u003cstring>"},"price":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"order.price.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"order.price.currency","typeLabel":"string"}},"description":"Order price and currency","uniqueKey":"order.price","typeLabel":"object"},"quantity":{"type":"number","format":"double","description":"Original order quantity in contracts","uniqueKey":"order.quantity","typeLabel":"number\u003cdouble>"},"cumQuantity":{"type":"number","format":"double","description":"Cumulative filled quantity in contracts","uniqueKey":"order.cumQuantity","typeLabel":"number\u003cdouble>"},"leavesQuantity":{"type":"number","format":"double","description":"Remaining unfilled quantity in contracts","uniqueKey":"order.leavesQuantity","typeLabel":"number\u003cdouble>"},"tif":{"type":"string","enum":["TIME_IN_FORCE_DAY","TIME_IN_FORCE_GOOD_TILL_CANCEL","TIME_IN_FORCE_GOOD_TILL_DATE","TIME_IN_FORCE_IMMEDIATE_OR_CANCEL","TIME_IN_FORCE_FILL_OR_KILL"],"description":"Order time in force policy","uniqueKey":"order.tif","typeLabel":"enum\u003cstring>"},"goodTillTime":{"type":"string","format":"date-time","description":"Expiration time for GTD orders","uniqueKey":"order.goodTillTime","typeLabel":"string\u003cdate-time>"},"intent":{"type":"string","enum":["ORDER_INTENT_BUY_LONG","ORDER_INTENT_SELL_LONG","ORDER_INTENT_BUY_SHORT","ORDER_INTENT_SELL_SHORT"],"description":"Order intent (buy/sell YES or NO)","uniqueKey":"order.intent","typeLabel":"enum\u003cstring>"},"marketMetadata":{"type":"object","properties":{"slug":{"type":"string","description":"Market slug identifier","uniqueKey":"order.marketMetadata.slug","typeLabel":"string"},"icon":{"type":"string","description":"Market image URL","uniqueKey":"order.marketMetadata.icon","typeLabel":"string"},"title":{"type":"string","description":"Market title/name","uniqueKey":"order.marketMetadata.title","typeLabel":"string"},"outcome":{"type":"string","description":"Market outcome description","uniqueKey":"order.marketMetadata.outcome","typeLabel":"string"},"eventSlug":{"type":"string","description":"Parent event slug","uniqueKey":"order.marketMetadata.eventSlug","typeLabel":"string"},"teamId":{"oneOf":[{"type":"integer","format":"int32","description":"Team ID (deprecated, use team object instead)","deprecated":true,"uniqueKey":"order.marketMetadata.teamId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Team ID (deprecated, use team object instead)","deprecated":true,"uniqueKey":"order.marketMetadata.teamId.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.teamId","typeLabel":"integer\u003cint32> | null"},"team":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Team ID","uniqueKey":"order.marketMetadata.team.oneOf.0.id","typeLabel":"integer\u003cint32>"},"name":{"type":"string","description":"Team name","uniqueKey":"order.marketMetadata.team.oneOf.0.name","typeLabel":"string"},"abbreviation":{"type":"string","description":"Team abbreviation","uniqueKey":"order.marketMetadata.team.oneOf.0.abbreviation","typeLabel":"string"},"league":{"type":"string","description":"League the team belongs to","uniqueKey":"order.marketMetadata.team.oneOf.0.league","typeLabel":"string"},"record":{"type":"string","description":"Team record (wins-losses)","uniqueKey":"order.marketMetadata.team.oneOf.0.record","typeLabel":"string"},"logo":{"type":"string","description":"Team logo URL","uniqueKey":"order.marketMetadata.team.oneOf.0.logo","typeLabel":"string"},"alias":{"type":"string","description":"Team alias","uniqueKey":"order.marketMetadata.team.oneOf.0.alias","typeLabel":"string"},"safeName":{"type":"string","description":"URL-safe team name","uniqueKey":"order.marketMetadata.team.oneOf.0.safeName","typeLabel":"string"},"homeIcon":{"oneOf":[{"type":"string","description":"Home game icon URL","uniqueKey":"order.marketMetadata.team.oneOf.0.homeIcon.oneOf.0","typeLabel":"string"},{"type":"null","description":"Home game icon URL","uniqueKey":"order.marketMetadata.team.oneOf.0.homeIcon.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.homeIcon","typeLabel":"string | null"},"awayIcon":{"oneOf":[{"type":"string","description":"Away game icon URL","uniqueKey":"order.marketMetadata.team.oneOf.0.awayIcon.oneOf.0","typeLabel":"string"},{"type":"null","description":"Away game icon URL","uniqueKey":"order.marketMetadata.team.oneOf.0.awayIcon.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.awayIcon","typeLabel":"string | null"},"colorPrimary":{"oneOf":[{"type":"string","description":"Primary team color (hex)","uniqueKey":"order.marketMetadata.team.oneOf.0.colorPrimary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary team color (hex)","uniqueKey":"order.marketMetadata.team.oneOf.0.colorPrimary.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.colorPrimary","typeLabel":"string | null"},"ordering":{"oneOf":[{"type":"string","description":"Display ordering","uniqueKey":"order.marketMetadata.team.oneOf.0.ordering.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display ordering","uniqueKey":"order.marketMetadata.team.oneOf.0.ordering.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.ordering","typeLabel":"string | null"},"ranking":{"oneOf":[{"type":"string","format":"int64","description":"Team ranking","uniqueKey":"order.marketMetadata.team.oneOf.0.ranking.oneOf.0","typeLabel":"string\u003cint64>"},{"type":"null","format":"int64","description":"Team ranking","uniqueKey":"order.marketMetadata.team.oneOf.0.ranking.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.ranking","typeLabel":"string\u003cint64> | null"},"conference":{"oneOf":[{"type":"string","description":"Conference the team belongs to","uniqueKey":"order.marketMetadata.team.oneOf.0.conference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Conference the team belongs to","uniqueKey":"order.marketMetadata.team.oneOf.0.conference.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team.oneOf.0.conference","typeLabel":"string | null"}},"description":"Team information with full details including ordering","uniqueKey":"order.marketMetadata.team.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer","format":"int32","description":"Team ID"},"name":{"type":"string","description":"Team name"},"abbreviation":{"type":"string","description":"Team abbreviation"},"league":{"type":"string","description":"League the team belongs to"},"record":{"type":"string","description":"Team record (wins-losses)"},"logo":{"type":"string","description":"Team logo URL"},"alias":{"type":"string","description":"Team alias"},"safeName":{"type":"string","description":"URL-safe team name"},"homeIcon":{"oneOf":[{"type":"string","description":"Home game icon URL"},{"type":"null","description":"Home game icon URL"}]},"awayIcon":{"oneOf":[{"type":"string","description":"Away game icon URL"},{"type":"null","description":"Away game icon URL"}]},"colorPrimary":{"oneOf":[{"type":"string","description":"Primary team color (hex)"},{"type":"null","description":"Primary team color (hex)"}]},"ordering":{"oneOf":[{"type":"string","description":"Display ordering"},{"type":"null","description":"Display ordering"}]},"ranking":{"oneOf":[{"type":"string","format":"int64","description":"Team ranking"},{"type":"null","format":"int64","description":"Team ranking"}]},"conference":{"oneOf":[{"type":"string","description":"Conference the team belongs to"},{"type":"null","description":"Conference the team belongs to"}]}},"description":"Team information with full details including ordering","uniqueKey":"order.marketMetadata.team.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.marketMetadata.team","typeLabel":"object | null"}},"description":"Market metadata","uniqueKey":"order.marketMetadata","typeLabel":"object"},"state":{"type":"string","enum":["ORDER_STATE_NEW","ORDER_STATE_PARTIALLY_FILLED","ORDER_STATE_FILLED","ORDER_STATE_CANCELED","ORDER_STATE_REPLACED","ORDER_STATE_REJECTED","ORDER_STATE_EXPIRED","ORDER_STATE_PENDING_NEW","ORDER_STATE_PENDING_REPLACE","ORDER_STATE_PENDING_CANCEL","ORDER_STATE_PENDING_RISK"],"description":"Current order state","uniqueKey":"order.state","typeLabel":"enum\u003cstring>"},"commissionNotionalTotalCollected":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"order.commissionNotionalTotalCollected.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"order.commissionNotionalTotalCollected.currency","typeLabel":"string"}},"description":"Total notional value of all commissions collected on this order","uniqueKey":"order.commissionNotionalTotalCollected","typeLabel":"object"},"commissionsBasisPoints":{"type":"string","description":"Commission rate in basis points","uniqueKey":"order.commissionsBasisPoints","typeLabel":"string"},"makerCommissionsBasisPoints":{"type":"string","description":"Maker commission rate in basis points","uniqueKey":"order.makerCommissionsBasisPoints","typeLabel":"string"},"avgPx":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"order.avgPx.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"order.avgPx.currency","typeLabel":"string"}},"description":"Average fill price","uniqueKey":"order.avgPx","typeLabel":"object"},"cashOrderQty":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","format":"decimal","example":"0.55","description":"The amount as a decimal string","isRequired":true,"uniqueKey":"order.cashOrderQty.value","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","example":"USD","description":"The currency code (e.g., 'USD')","isRequired":true,"uniqueKey":"order.cashOrderQty.currency","typeLabel":"string"}},"description":"Total cash order quantity for market orders","uniqueKey":"order.cashOrderQty","typeLabel":"object"},"insertTime":{"type":"string","format":"date-time","description":"Time order was inserted into the book or replaced","uniqueKey":"order.insertTime","typeLabel":"string\u003cdate-time>"},"createTime":{"type":"string","format":"date-time","description":"Time order was created","uniqueKey":"order.createTime","typeLabel":"string\u003cdate-time>"},"outcomeSide":{"type":"string","enum":["OUTCOME_SIDE_YES","OUTCOME_SIDE_NO"],"description":"Outcome side.","uniqueKey":"order.outcomeSide","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["ORDER_ACTION_BUY","ORDER_ACTION_SELL"],"description":"Order action.","uniqueKey":"order.action","typeLabel":"enum\u003cstring>"}},"description":"Previewed order with calculated values","uniqueKey":"order","typeLabel":"object"}},"description":"Response containing previewed order","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"order":{"id":"\u003cstring>","marketSlug":"\u003cstring>","side":"ORDER_SIDE_BUY","type":"ORDER_TYPE_LIMIT","price":{"value":"0.55","currency":"USD"},"quantity":123,"cumQuantity":123,"leavesQuantity":123,"tif":"TIME_IN_FORCE_DAY","goodTillTime":"2023-11-07T05:31:56Z","intent":"ORDER_INTENT_BUY_LONG","marketMetadata":{"slug":"\u003cstring>","icon":"\u003cstring>","title":"\u003cstring>","outcome":"\u003cstring>","eventSlug":"\u003cstring>","teamId":123,"team":{"id":123,"name":"\u003cstring>","abbreviation":"\u003cstring>","league":"\u003cstring>","record":"\u003cstring>","logo":"\u003cstring>","alias":"\u003cstring>","safeName":"\u003cstring>","homeIcon":"\u003cstring>","awayIcon":"\u003cstring>","colorPrimary":"\u003cstring>","ordering":"\u003cstring>","ranking":"\u003cstring>","conference":"\u003cstring>"}},"state":"ORDER_STATE_NEW","commissionNotionalTotalCollected":{"value":"0.55","currency":"USD"},"commissionsBasisPoints":"\u003cstring>","makerCommissionsBasisPoints":"\u003cstring>","avgPx":{"value":"0.55","currency":"USD"},"cashOrderQty":{"value":"0.55","currency":"USD"},"insertTime":"2023-11-07T05:31:56Z","createTime":"2023-11-07T05:31:56Z","outcomeSide":"OUTCOME_SIDE_YES","action":"ORDER_ACTION_BUY"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2a44db83-bfa2-421d-805d-1b91c58c4eb9":{"description":"Bad request - invalid order preview request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8cb44f5d-e66b-4436-b976-48347ea8391f":{"description":"Unauthorized - invalid or missing authentication token","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"718b2eba-f0a2-41b5-ae00-e6f35a512a74":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8edbfa0b-66a3-49ab-b21b-1d89e773228c":{"X-PM-Access-Key":{"type":"apiKey","in":"header","name":"X-PM-Access-Key","description":"Your API key ID (UUID). Generate at [polymarket.us/developer](https://polymarket.us/developer).","scopes":[]},"X-PM-Timestamp":{"type":"apiKey","in":"header","name":"X-PM-Timestamp","description":"Unix timestamp in milliseconds. Must be within 30 seconds of server time.","scopes":[]},"X-PM-Signature":{"type":"apiKey","in":"header","name":"X-PM-Signature","description":"Base64-encoded Ed25519 signature of `timestamp + method + path`. See [Authentication](/api/authentication) for details.","scopes":[]}}},"servers":{"bd11bacf-a866-41bf-b17f-09ae149fafc7":{"url":"https://api.polymarket.us"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-PM-Access-Key","description":"Your API key ID (UUID). Generate at [polymarket.us/developer](https://polymarket.us/developer).","scopes":[]},"schema":{"title":"X-PM-Access-Key","type":"string","description":"Your API key ID (UUID). Generate at [polymarket.us/developer](https://polymarket.us/developer).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-PM-Access-Key","name":"X-PM-Access-Key"},{"scheme":{"type":"apiKey","in":"header","name":"X-PM-Timestamp","description":"Unix timestamp in milliseconds. Must be within 30 seconds of server time.","scopes":[]},"schema":{"title":"X-PM-Timestamp","type":"string","description":"Unix timestamp in milliseconds. Must be within 30 seconds of server time.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-PM-Timestamp","name":"X-PM-Timestamp"},{"scheme":{"type":"apiKey","in":"header","name":"X-PM-Signature","description":"Base64-encoded Ed25519 signature of `timestamp + method + path`. See [Authentication](/api/authentication) for details.","scopes":[]},"schema":{"title":"X-PM-Signature","type":"string","description":"Base64-encoded Ed25519 signature of `timestamp + method + path`. See [Authentication](/api/authentication) for details.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-PM-Signature","name":"X-PM-Signature"}],"title":"X-PM-Access-Key \u0026 X-PM-Timestamp \u0026 X-PM-Signature"}]},"originalFileLocation":"api-reference/oapi-schemas/orders-schema.json"},"subdomain":"polymarketusdocs","siteName":"Polymarket US Documentation","title":"Preview Order - Polymarket US Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-31T00:31:00.852Z","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=\"system\"}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=\"Preview an order before submission to validate parameters and see expected fills\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview Order - Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Preview an order before submission to validate parameters and see expected fills\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polymarket.us/api-reference/orders/preview-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polymarketusdocs.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Preview+Order\u0026amp;description=Preview+an+order+before+submission+to+validate+parameters+and+see+expected+fills\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=60361def6736a8a4ad4c431fbafc5699cfdc620614e89e4e0adb1b457c5cf4b2\">\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 Order - Polymarket US Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Preview an order before submission to validate parameters and see expected fills\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polymarketusdocs.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Preview+Order\u0026amp;description=Preview+an+order+before+submission+to+validate+parameters+and+see+expected+fills\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=60361def6736a8a4ad4c431fbafc5699cfdc620614e89e4e0adb1b457c5cf4b2\">\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=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#165DFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polymarket.us/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://docs.polymarket.us/#organization\",\"name\":\"Polymarket US Documentation\",\"url\":\"https://docs.polymarket.us\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=31d6284cd801a07214abb060e79928e4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polymarket.us#website\",\"name\":\"Polymarket US Documentation\",\"url\":\"https://docs.polymarket.us\",\"publisher\":{\"@id\":\"https://docs.polymarket.us/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polymarket.us/api-reference/orders/preview-order#webpage\",\"url\":\"https://docs.polymarket.us/api-reference/orders/preview-order\",\"name\":\"Preview Order\",\"description\":\"Preview an order before submission to validate parameters and see expected fills\",\"dateModified\":\"2026-05-31T00:31:00.852Z\",\"isPartOf\":{\"@id\":\"https://docs.polymarket.us#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polymarket.us/api-reference/orders/preview-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polymarket.us/api-reference/orders/preview-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://docs.polymarket.us/api-reference/orders/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview Order\",\"item\":\"https://docs.polymarket.us/api-reference/orders/preview-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.polymarket.us/api-reference/orders/preview-order#apireference\",\"headline\":\"Preview Order\",\"name\":\"Preview Order\",\"description\":\"Preview an order before submission to validate parameters and see expected fills\",\"url\":\"https://docs.polymarket.us/api-reference/orders/preview-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polymarket.us/api-reference/orders/preview-order#webpage\"},\"dateModified\":\"2026-05-31T00:31:00.852Z\",\"publisher\":{\"@id\":\"https://docs.polymarket.us/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polymarket.us#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Polymarket US Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Polymarket US Documentation","nav":{"global":{},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/welcome"}]},{"tab":"App Users","pages":[{"title":"App Users","href":"/learn/home"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Rate Limits","href":"/api-reference/rate-limits"}]},{"group":"Orders","pages":[{"title":"Orders API Overview","href":"/api-reference/orders/overview"},{"title":"Get Open Orders","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json get /v1/orders/open","href":"/api-reference/orders/get-open-orders"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json get /v1/order/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/orders","href":"/api-reference/orders/create-order"},{"title":"Cancel All Open Orders","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/orders/open/cancel","href":"/api-reference/orders/cancel-all-open-orders"},{"title":"Cancel Order","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/{orderId}/cancel","href":"/api-reference/orders/cancel-order"},{"title":"Modify Order","description":"Modify an existing order in the marketplace. Allows changing price, quantity, time in force, and other parameters.","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/{orderId}/modify","href":"/api-reference/orders/modify-order"},{"title":"Preview Order","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/preview","href":"/api-reference/orders/preview-order"},{"title":"Close Position Order","description":"Create an order to close an existing position in a market. This will sell all contracts held in the specified market.","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/order/close-position","href":"/api-reference/orders/close-position-order"},{"title":"Create Multiple Orders","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/orders/batched","href":"/api-reference/orders/create-multiple-orders"},{"title":"Cancel Multiple Orders","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/orders/batched/cancel","href":"/api-reference/orders/cancel-multiple-orders"},{"title":"Modify Multiple Orders","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/orders-schema.json post /v1/orders/batched/modify","href":"/api-reference/orders/modify-multiple-orders"}]},{"group":"Combos","pages":[{"title":"Combos API Overview","href":"/api-reference/combos/overview"},{"group":"Combos","pages":[{"title":"Get combos","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/combos-schema.json get /v1/combos","href":"/api-reference/combos/get-combos"},{"title":"Create combo","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/combos-schema.json post /v1/combos","href":"/api-reference/combos/create-combo"}]}]},{"group":"RFQs","pages":[{"title":"RFQ API Overview","href":"/api-reference/rfqs/overview"},{"group":"RFQs","pages":[{"title":"Get RFQs","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json get /v1/rfqs","href":"/api-reference/rfqs/get-rfqs"},{"title":"Create RFQ","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json post /v1/rfqs","href":"/api-reference/rfqs/create-rfq"},{"title":"Get quotes","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json get /v1/rfqs/quotes","href":"/api-reference/rfqs/get-quotes"},{"title":"Create quote","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json post /v1/rfqs/quotes","href":"/api-reference/rfqs/create-quote"},{"title":"Get RFQ trades","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json get /v1/rfqs/trades","href":"/api-reference/rfqs/get-rfq-trades"},{"title":"Get RFQ user ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json get /v1/rfqs/user-id","href":"/api-reference/rfqs/get-rfq-user-id"},{"title":"Delete RFQ","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}","href":"/api-reference/rfqs/delete-rfq"},{"title":"Delete quote","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}/quotes/{quoteId}","href":"/api-reference/rfqs/delete-quote"},{"title":"Accept quote","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/accept","href":"/api-reference/rfqs/accept-quote"},{"title":"Confirm quote","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/confirm","href":"/api-reference/rfqs/confirm-quote"}]}]},{"group":"Portfolio","pages":[{"title":"Portfolio API Overview","href":"/api-reference/portfolio/overview"},{"title":"Get User Positions","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/portfolio-schema.json get /v1/portfolio/positions","href":"/api-reference/portfolio/get-user-positions"},{"title":"Get Activities","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/portfolio-schema.json get /v1/portfolio/activities","href":"/api-reference/portfolio/get-activities"},{"title":"Get Account Balances","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/portfolio-schema.json get /v1/account/balances","href":"/api-reference/account/get-account-balances"}]},{"group":"Events","pages":[{"title":"Events API Overview","href":"/api-reference/events/overview"},{"title":"Get Events","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/events-schema.json get /v1/events","href":"/api-reference/events/get-events"},{"title":"Get Event By Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/events-schema.json get /v1/events/slug/{slug}","href":"/api-reference/events/get-event-by-slug"},{"title":"Get Event By ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/events-schema.json get /v1/events/{id}","href":"/api-reference/events/get-event-by-id"},{"title":"Get Event By Partner External ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/events-schema.json get /v1/partners/{partnerKey}/events/{externalId}","href":"/api-reference/partners/get-event-by-partner-external-id"}]},{"group":"Markets","pages":[{"title":"Markets API Overview","href":"/api-reference/market/overview"},{"title":"Get Price History","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/price-history-schema.json get /v1/price-history","href":"/api-reference/price-history/get-price-history"},{"title":"Get Market By ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/market/id/{id}","href":"/api-reference/markets/get-market-by-id"},{"title":"Get Market By Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/market/slug/{slug}","href":"/api-reference/markets/get-market-by-slug"},{"title":"Get Markets","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/markets","href":"/api-reference/markets/get-markets"},{"title":"Get Market BBO","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/markets/{slug}/bbo","href":"/api-reference/markets/get-market-bbo"},{"title":"Get Market Book","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/markets/{slug}/book","href":"/api-reference/markets/get-market-book"},{"title":"Get Market Settlement","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/markets-schema.json get /v1/markets/{slug}/settlement","href":"/api-reference/markets/get-market-settlement"}]},{"group":"Asset Prices","pages":[{"title":"Asset Prices API Overview","href":"/api-reference/asset-prices/overview"},{"title":"Get A Bucketed OHLC Price Series For One Or More Assets","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/asset-prices-schema.json get /v1/asset-prices/history","href":"/api-reference/asset-prices/get-a-bucketed-ohlc-price-series-for-one-or-more-assets"}]},{"group":"Series","pages":[{"title":"Series API Overview","href":"/api-reference/series/overview"},{"title":"Get Series","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/series-schema.json get /v1/series","href":"/api-reference/series/get-series"},{"title":"Get Series By ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/series-schema.json get /v1/series/id/{id}","href":"/api-reference/series/get-series-by-id"}]},{"group":"Sports","pages":[{"title":"Sports API Overview","href":"/api-reference/sports/overview"},{"title":"Get All Leagues","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/leagues","href":"/api-reference/sports/get-all-leagues"},{"title":"Get League By Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/leagues/{slug}","href":"/api-reference/sports/get-league-by-slug"},{"title":"Get Events By League Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/leagues/{slug}/events","href":"/api-reference/sports/get-events-by-league-slug"},{"title":"Get All Sports","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/sports","href":"/api-reference/sports/get-all-sports"},{"title":"Get Sport By Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/sports/{slug}","href":"/api-reference/sports/get-sport-by-slug"},{"title":"Get Events By Sport Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-schema.json get /v2/sports/{slug}/events","href":"/api-reference/sports/get-events-by-sport-slug"}]},{"group":"Sports (Legacy)","pages":[{"title":"Sports API Overview (Legacy)","href":"/api-reference/sports-legacy/overview"},{"title":"Get Sports","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-legacy-schema.json get /v1/sports","href":"/api-reference/sports/get-sports"},{"title":"Get Sports Players","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-legacy-schema.json get /v1/sports/players","href":"/api-reference/sports/get-sports-players"},{"title":"Get Sports Teams","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-legacy-schema.json get /v1/sports/teams","href":"/api-reference/sports/get-sports-teams"},{"title":"Get Sports Teams For Provider","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-legacy-schema.json get /v1/sports/teams/provider","href":"/api-reference/sports/get-sports-teams-for-provider"},{"title":"Get Sports Events","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/sports-legacy-schema.json get /v1/sports/{seriesId}/events","href":"/api-reference/sports/get-sports-events"}]},{"group":"Tags","pages":[{"title":"Tags API Overview","href":"/api-reference/tags/overview"},{"title":"Get Tags","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/tags-schema.json get /v2/tags","href":"/api-reference/tags/get-tags"},{"title":"Get Tag By Slug","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/tags-schema.json get /v2/tags/slug/{slug}","href":"/api-reference/tags/get-tag-by-slug"},{"title":"Get Tag By ID","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/tags-schema.json get /v2/tags/{id}","href":"/api-reference/tags/get-tag-by-id"},{"title":"Get Events For A Tag","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/tags-schema.json get /v2/tags/{slug}/events","href":"/api-reference/tags/get-events-for-a-tag"}]},{"group":"Search","pages":[{"title":"Search API Overview","href":"/api-reference/search/overview"},{"title":"Search","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/search-schema.json get /v1/search","href":"/api-reference/search/search"}]},{"group":"Incentives","pages":[{"title":"Incentives API Overview","href":"/api-reference/incentives/overview"},{"title":"Get Incentive Programs","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/incentives-schema.json get /v1/incentives","href":"/api-reference/incentives/get-incentive-programs"},{"title":"Get Your Incentive Earnings","deprecated":null,"version":null,"openapi":"/api-reference/oapi-schemas/incentives-schema.json get /v1/incentives/earnings","href":"/api-reference/incentives/get-your-incentive-earnings"}]}]},{"tab":"WebSockets","pages":[{"title":"WebSockets","href":"/api-reference/websocket/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/api-reference/sdks/introduction"}]},{"tab":"Institutional API","pages":[{"title":"Institutional API","href":"/trader-guide/overview"}]},{"tab":"Incentives","pages":[{"title":"Incentives","href":"/incentives/overview"}]},{"tab":"Fees \u0026 Rebates","pages":[{"title":"Fees \u0026 Rebates","href":"/fees"}]},{"tab":"Data","pages":[{"title":"Data","href":"/data-guide/overview"}]},{"tab":"Partner Integration","pages":[{"title":"Partner Integration","href":"/partners/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Preview Order - Polymarket US Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}