Access L2 order book snapshots and best bid/offer (BBO) data
Prefer Streaming for Production UseThis polling API is subject to rate limits. For production applications that need continuous market data, use the gRPC Market Data Stream instead. The streaming API provides real-time updates with lower latency and no rate limit concerns.
No Participant ID RequiredThese endpoints only require Auth0 JWT authentication with read:marketdata scope. You do not need to provide the x-participant-id header or complete KYC onboarding to access order book data.
The BBO endpoint returns only the top of book - the best (highest) bid and best (lowest) offer. This is the most efficient way to get current market prices.
Spread in price units (best_offer.px - best_bid.px)
midPrice
string
Mid price ((best_bid.px + best_offer.px) / 2)
state
string
Current trading state (optional)
transactTime
datetime
Server timestamp
Instrument State Tracking: The state field in order book and BBO responses is optional. The preferred approach is to use ListInstruments to get and cache the initial state, then subscribe to the instrument state change subscription for real-time state updates.
Instruments follow the primary lifecycle: PENDING → OPEN → CLOSED → EXPIRED → TERMINATED. Instruments may also be SUSPENDED or HALTED during their lifecycle.
Initial state for a newly created instrument which has not yet begun trading.
OPEN
In this state, the instrument is open for continuous order entry and matching.
CLOSED
In this state, orders can not be entered, modified, or canceled, and no matching occurs. Any existing Day orders will be expired.
EXPIRED
An instrument moves to this state when its Expiration Date/Time is reached. In this state, any resting orders are expired and no new orders can be entered.
TERMINATED
When an instrument’s Termination Date is reached, the order book is removed from the matching engine, orders are canceled, and positions are closed. Historical data will still remain in Polymarket US ledgers.
Orders can be entered and modified, but no matching occurs. When the instrument transitions to an OPEN state, the orders entered during PREOPEN will match at a single opening price that is automatically determined by an algorithm that is designed to maximize the volume traded at the open.
MATCH_AND_CLOSE_AUCTION
This state is similar to PREOPEN, with the exception that matching will occur upon the transition of this state to any other state. This state is useful if you want matching to occur at the end of the state, but you don’t want the instrument to be open after.
Streaming First ArchitectureFor any use case requiring more than occasional snapshots, use the streaming API. It provides:
Real-time updates as they happen
No rate limiting concerns
Lower latency than polling
Reduced API calls and infrastructure load
{"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":"6ae4d6dce5865a4973d4139f","collectionId":"de8ac8a5-4d15-4172-a8dc-b32e3965d74d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4d6dce5865a4973d4139f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4d6dce5865a4973d4139f","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Institutional API","count":121},{"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":"Guide","count":22},{"language":"default","tag":"SDKs","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":"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":"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":"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":"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":"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}],"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":"institutional/orderbook/overview","slug":"/institutional/orderbook/overview","pageMetadata":{"title":"Order Book API Overview","description":"Access L2 order book snapshots and best bid/offer (BBO) data","href":"/institutional/orderbook/overview"},"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: \"Access L2 order book snapshots and best bid/offer (BBO) data\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Table,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Prefer Streaming for Production Use`})}),_jsxs(_components.p,{children:[`This polling API is subject to rate limits. For production applications that need continuous market data, use the `,_jsx(_components.a,{href:`/streaming-endpoints/market-data-stream`,children:`gRPC Market Data Stream`}),` instead. The streaming API provides real-time updates with lower latency and no rate limit concerns.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/orderbook/{symbol}`})}),_jsx(_components.td,{children:`Get L2 order book snapshot`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/orderbook/{symbol}/bbo`})}),_jsx(_components.td,{children:`Get best bid/offer`})]})]})]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`No Participant ID Required`})}),_jsxs(_components.p,{children:[`These endpoints only require Auth0 JWT authentication with `,_jsx(_components.code,{children:`read:marketdata`}),` scope. You do not need to provide the `,_jsx(_components.code,{children:`x-participant-id`}),` header or complete KYC onboarding to access order book data.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`l2-order-book`,children:`L2 Order Book`}),`\n`,_jsx(_components.p,{children:`The L2 (Level 2) order book provides aggregated price levels showing the total quantity available at each price point. This is useful for:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Understanding market depth at different price levels`}),`\n`,_jsx(_components.li,{children:`Analyzing liquidity distribution`}),`\n`,_jsx(_components.li,{children:`Building trading strategies based on order book imbalance`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`request-parameters`,children:`Request Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`symbol`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Instrument symbol (e.g., “tec-nfl-sbw-2026-02-08-kc”)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`depth`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Number of price levels to return (default: 3, max: 10)`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`symbol`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Instrument symbol`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bids`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`Bid side of order book (sorted by price descending)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`offers`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`Offer/ask side of order book (sorted by price ascending)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`state`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Current trading state of the instrument (optional)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stats`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Market statistics (last trade, OHLC, etc.)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transactTime`})}),_jsx(_components.td,{children:`datetime`}),_jsx(_components.td,{children:`Server timestamp of the data`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`book-entry-structure`,children:`Book Entry Structure`}),`\n`,_jsxs(_components.p,{children:[`Each entry in the `,_jsx(_components.code,{children:`bids`}),` and `,_jsx(_components.code,{children:`offers`}),` arrays contains:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`px`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Price level`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`qty`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Total quantity at this price`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`best-bid/offer-bbo`,children:`Best Bid/Offer (BBO)`}),`\n`,_jsx(_components.p,{children:`The BBO endpoint returns only the top of book - the best (highest) bid and best (lowest) offer. This is the most efficient way to get current market prices.`}),`\n`,_jsx(Heading,{level:`3`,id:`response-fields-2`,children:`Response Fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`symbol`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Instrument symbol`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bestBid`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Best bid (highest buy price)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bestOffer`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Best offer (lowest sell price)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`spread`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Spread in price units (best_offer.px - best_bid.px)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`midPrice`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Mid price ((best_bid.px + best_offer.px) / 2)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`state`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Current trading state (optional)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`transactTime`})}),_jsx(_components.td,{children:`datetime`}),_jsx(_components.td,{children:`Server timestamp`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Instrument State Tracking:`}),` The `,_jsx(_components.code,{children:`state`}),` field in order book and BBO responses is optional. The preferred approach is to use `,_jsx(_components.code,{children:`ListInstruments`}),` to get and cache the initial state, then subscribe to the instrument state change subscription for real-time state updates.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`instrument-states`,children:`Instrument States`}),`\n`,_jsx(_components.p,{children:`Instruments follow the primary lifecycle: PENDING → OPEN → CLOSED → EXPIRED → TERMINATED. Instruments may also be SUSPENDED or HALTED during their lifecycle.`}),`\n`,_jsx(Heading,{level:`3`,id:`primary-state-flow`,children:`Primary State Flow`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`State\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PENDING`})}),_jsx(_components.td,{children:`Initial state for a newly created instrument which has not yet begun trading.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`OPEN`})}),_jsx(_components.td,{children:`In this state, the instrument is open for continuous order entry and matching.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CLOSED`})}),_jsx(_components.td,{children:`In this state, orders can not be entered, modified, or canceled, and no matching occurs. Any existing Day orders will be expired.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`EXPIRED`})}),_jsx(_components.td,{children:`An instrument moves to this state when its Expiration Date/Time is reached. In this state, any resting orders are expired and no new orders can be entered.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`TERMINATED`})}),_jsx(_components.td,{children:`When an instrument’s Termination Date is reached, the order book is removed from the matching engine, orders are canceled, and positions are closed. Historical data will still remain in Polymarket US ledgers.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`exception-states`,children:`Exception States`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`State\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`SUSPENDED`})}),_jsx(_components.td,{children:`Orders can be canceled but no matching occurs, and no order entry or modification is allowed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`HALTED`})}),_jsx(_components.td,{children:`This state is similar to SUSPENDED, with the exception that orders cannot be canceled.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`other-possible-states`,children:`Other Possible States`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`State\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0\\xA0`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PREOPEN`})}),_jsx(_components.td,{children:`Orders can be entered and modified, but no matching occurs. When the instrument transitions to an OPEN state, the orders entered during PREOPEN will match at a single opening price that is automatically determined by an algorithm that is designed to maximize the volume traded at the open.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MATCH_AND_CLOSE_AUCTION`})}),_jsx(_components.td,{children:`This state is similar to PREOPEN, with the exception that matching will occur upon the transition of this state to any other state. This state is useful if you want matching to occur at the end of the state, but you don’t want the instrument to be open after.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`example-usage`,children:`Example Usage`}),`\n`,_jsx(Heading,{level:`3`,id:`get-l2-order-book`,children:`Get L2 Order Book`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.preprod.polymarketexchange.com/v1/orderbook/tec-nfl-sbw-2026-02-08-kc?depth=5\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_TOKEN\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`get-bbo`,children:`Get BBO`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.preprod.polymarketexchange.com/v1/orderbook/tec-nfl-sbw-2026-02-08-kc/bbo\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_TOKEN\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use`,children:`When to Use`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Use Case`}),_jsx(_components.th,{children:`Recommended API`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Continuous market data feed`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/streaming-endpoints/market-data-stream`,children:`gRPC Market Data Stream`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`One-time snapshot for display`}),_jsx(_components.td,{children:`REST Order Book (this API)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Building a trading UI`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/streaming-endpoints/market-data-stream`,children:`gRPC Market Data Stream`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Quick price check`}),_jsx(_components.td,{children:`REST BBO endpoint`})]})]})]}),`\n`,_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Streaming First Architecture`})}),_jsx(_components.p,{children:`For any use case requiring more than occasional snapshots, use the streaming API. It provides:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Real-time updates as they happen`}),`\n`,_jsx(_components.li,{children:`No rate limiting concerns`}),`\n`,_jsx(_components.li,{children:`Lower latency than polling`}),`\n`,_jsx(_components.li,{children:`Reduced API calls and infrastructure load`}),`\n`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Order Book API Overview","description":"Access L2 order book snapshots and best bid/offer (BBO) data","href":"/institutional/orderbook/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"L2 Order Book","slug":"l2-order-book","depth":2,"children":[{"title":"Request Parameters","slug":"request-parameters","depth":3,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":3,"children":[]},{"title":"Book Entry Structure","slug":"book-entry-structure","depth":3,"children":[]}]},{"title":"Best Bid/Offer (BBO)","slug":"best-bid/offer-bbo","depth":2,"children":[{"title":"Response Fields","slug":"response-fields-2","depth":3,"children":[]}]},{"title":"Instrument States","slug":"instrument-states","depth":2,"children":[{"title":"Primary State Flow","slug":"primary-state-flow","depth":3,"children":[]},{"title":"Exception States","slug":"exception-states","depth":3,"children":[]},{"title":"Other Possible States","slug":"other-possible-states","depth":3,"children":[]}]},{"title":"Example Usage","slug":"example-usage","depth":2,"children":[{"title":"Get L2 Order Book","slug":"get-l2-order-book","depth":3,"children":[]},{"title":"Get BBO","slug":"get-bbo","depth":3,"children":[]}]},{"title":"When to Use","slug":"when-to-use","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"polymarketusdocs","siteName":"Polymarket US Documentation","title":"Order Book API Overview - Polymarket US Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-18T23:39:17.570Z","originalFileLocation":"institutional/orderbook/overview.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=\"Access L2 order book snapshots and best bid/offer (BBO) data\">\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=\"Order Book API Overview - Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Access L2 order book snapshots and best bid/offer (BBO) data\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polymarket.us/institutional/orderbook/overview\">\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=Order+Book\u0026amp;title=Order+Book+API+Overview\u0026amp;description=Access+L2+order+book+snapshots+and+best+bid%2Foffer+%28BBO%29+data\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=8b59dfc48cacf2eb9590b028c312d36a4f5db10db12309e5c643ea7b438c30f9\">\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=\"Order Book API Overview - Polymarket US Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Access L2 order book snapshots and best bid/offer (BBO) data\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polymarketusdocs.mintlify.app/_mintlify/api/og/v2?division=Order+Book\u0026amp;title=Order+Book+API+Overview\u0026amp;description=Access+L2+order+book+snapshots+and+best+bid%2Foffer+%28BBO%29+data\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=8b59dfc48cacf2eb9590b028c312d36a4f5db10db12309e5c643ea7b438c30f9\">\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/institutional/orderbook/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/institutional/orderbook/overview.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/institutional/orderbook/overview#webpage\",\"url\":\"https://docs.polymarket.us/institutional/orderbook/overview\",\"name\":\"Order Book API Overview\",\"description\":\"Access L2 order book snapshots and best bid/offer (BBO) data\",\"dateModified\":\"2026-03-18T23:39:17.570Z\",\"isPartOf\":{\"@id\":\"https://docs.polymarket.us#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polymarket.us/institutional/orderbook/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polymarket.us/institutional/orderbook/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Polymarket US Documentation\",\"item\":\"https://docs.polymarket.us\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Order Book API Overview\",\"item\":\"https://docs.polymarket.us/institutional/orderbook/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.polymarket.us/institutional/orderbook/overview#article\",\"headline\":\"Order Book API Overview\",\"name\":\"Order Book API Overview\",\"description\":\"Access L2 order book snapshots and best bid/offer (BBO) data\",\"url\":\"https://docs.polymarket.us/institutional/orderbook/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polymarket.us/institutional/orderbook/overview#webpage\"},\"dateModified\":\"2026-03-18T23:39:17.570Z\",\"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","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"WebSockets","pages":[{"title":"WebSockets","href":"/api-reference/websocket/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/api-reference/sdks/introduction"}]},{"tab":"Institutional API","anchors":[{"anchor":"Guide","pages":[{"title":"Guide","href":"/trader-guide/overview"}]},{"anchor":"REST API","groups":[{"group":"Overview","pages":[{"title":"REST API Overview","href":"/institutional/introduction"}]},{"group":"Health","pages":[{"title":"Health API Overview","href":"/institutional/health/overview"},{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/health-schema.json get /v1/health","href":"/api-reference/health/health-check"}]}]},{"group":"Trading","pages":[{"title":"Trading API Overview","href":"/institutional/trading/overview"},{"group":"Trading","pages":[{"title":"Insert order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders","href":"/api-reference/trading/insert-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cancel","href":"/api-reference/trading/cancel-order"},{"title":"Cancel order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cancel/list","href":"/api-reference/trading/cancel-order-list"},{"title":"Insert order cross","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cross","href":"/api-reference/trading/insert-order-cross"},{"title":"Insert order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/list","href":"/api-reference/trading/insert-order-list"},{"title":"Get open orders","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json get /v1/trading/orders/open","href":"/api-reference/trading/get-open-orders"},{"title":"Preview order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/preview","href":"/api-reference/trading/preview-order"},{"title":"Cancel replace order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/replace","href":"/api-reference/trading/cancel-replace-order"},{"title":"Cancel replace order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/replace/list","href":"/api-reference/trading/cancel-replace-order-list"}]}]},{"group":"Combos","pages":[{"title":"Combos API Overview","href":"/institutional/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":"/institutional/rfqs/overview"},{"group":"RFQs","pages":[{"title":"Get RFQs","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs","href":"/institutional/rfqs/get-rfqs"},{"title":"Create RFQ","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json post /v1/rfqs","href":"/institutional/rfqs/create-rfq"},{"title":"Get quotes","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/quotes","href":"/institutional/rfqs/get-quotes"},{"title":"Create quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json post /v1/rfqs/quotes","href":"/institutional/rfqs/create-quote"},{"title":"Get RFQ trades","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/trades","href":"/institutional/rfqs/get-rfq-trades"},{"title":"Get RFQ user ID","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/user-id","href":"/institutional/rfqs/get-rfq-user-id"},{"title":"Delete RFQ","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}","href":"/institutional/rfqs/delete-rfq"},{"title":"Delete quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}/quotes/{quoteId}","href":"/institutional/rfqs/delete-quote"},{"title":"Accept quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/accept","href":"/institutional/rfqs/accept-quote"},{"title":"Confirm quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/confirm","href":"/institutional/rfqs/confirm-quote"}]}]},{"group":"Report","pages":[{"title":"Report API Overview","href":"/institutional/report/overview"},{"group":"Report","pages":[{"title":"Download executions CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/executions/csv","href":"/api-reference/report/download-executions-csv"},{"title":"Search executions","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/executions/search","href":"/api-reference/report/search-executions"},{"title":"Download orders CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/orders/csv","href":"/api-reference/report/download-orders-csv"},{"title":"Search orders","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/orders/search","href":"/api-reference/report/search-orders"},{"title":"Download trades CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/csv","href":"/api-reference/report/download-trades-csv"},{"title":"Search trades","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/search","href":"/api-reference/report/search-trades"},{"title":"Get trade stats","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/stats","href":"/api-reference/report/get-trade-stats"}]}]},{"group":"Positions","pages":[{"title":"Positions API Overview","href":"/institutional/positions/overview"},{"group":"Positions","pages":[{"title":"List account positions","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions","href":"/api-reference/positions/list-account-positions"},{"title":"Get account balance","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json post /v1/positions/balance","href":"/api-reference/positions/get-account-balance"},{"title":"List account balances","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json post /v1/positions/balances","href":"/api-reference/positions/list-account-balances"},{"title":"Get position ledger","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions/ledger","href":"/api-reference/positions/get-position-ledger"},{"title":"Download position ledger as CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions/ledger/download","href":"/api-reference/positions/download-position-ledger-as-csv"}]}]},{"group":"Funding","pages":[{"title":"Funding Overview","href":"/institutional/funding/overview"},{"group":"Funding","pages":[{"title":"Get account balance ledger","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/funding-schema.json get /v1/funding/balance-ledger","href":"/api-reference/funding/get-account-balance-ledger"},{"title":"Download account balance ledger as CSV","description":"Streams balance ledger as CSV.","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/funding-schema.json get /v1/funding/balance-ledger/download","href":"/api-reference/funding/download-account-balance-ledger-as-csv"}]}]},{"group":"Order Book","pages":[{"title":"Order Book API Overview","href":"/institutional/orderbook/overview"},{"group":"Order Book","pages":[{"title":"Get order book","description":"Returns the current aggregated order book for a symbol","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/orderbook-schema.json get /v1/orderbook/{symbol}","href":"/api-reference/order-book/get-order-book"},{"title":"Get best bid/offer","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/orderbook-schema.json get /v1/orderbook/{symbol}/bbo","href":"/api-reference/order-book/get-best-bidoffer"}]}]},{"group":"Settlement","pages":[{"title":"Settlement API Overview","href":"/institutional/settlement/overview"},{"group":"Settlement","pages":[{"title":"Get instrument settlement","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/settlement-schema.json get /v1/instruments/{symbol}/settlement","href":"/api-reference/settlement/get-instrument-settlement"}]}]},{"group":"Reference Data","pages":[{"title":"Reference Data API Overview","href":"/institutional/refdata/overview"},{"group":"ReferenceData","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/instruments","href":"/api-reference/referencedata/list-instruments"},{"title":"Get instrument metadata","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/metadata","href":"/api-reference/referencedata/get-instrument-metadata"},{"title":"List symbols","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/symbols","href":"/api-reference/referencedata/list-symbols"}]}]},{"group":"Accounts","pages":[{"title":"Accounts API Overview","href":"/institutional/accounts/overview"},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"List users","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/users","href":"/api-reference/accounts/list-users"},{"title":"Get who am I","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/whoami","href":"/api-reference/accounts/get-who-am-i"}]}]},{"group":"Payments","pages":[{"title":"Payments Overview","href":"/institutional/payments/overview"},{"title":"Aeropay Integration","href":"/institutional/payments/aeropay-guide"},{"title":"Checkout Integration","href":"/institutional/payments/checkout-guide"},{"title":"Funding Management","href":"/institutional/payments/funding-management"}]},{"group":"Incentives","pages":[{"title":"Incentives API Overview","href":"/institutional/incentives/overview"},{"group":"Incentives","pages":[{"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 Incentive Earnings","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/incentives-schema.json get /v1/incentives/earnings","href":"/api-reference/incentives/get-incentive-earnings"}]}]}]},{"anchor":"gRPC API","pages":[{"title":"gRPC API","href":"/grpc-api/overview"}]},{"anchor":"FIX API","pages":[{"title":"FIX API","href":"/institutional/fix-api/fix-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"}]}]},"basePath":"","title":"Order Book API Overview - Polymarket US Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}
