Get a point-in-time orderbook snapshot for a trading pair: the top bid
and ask price levels, up to 1000 per side. Above 100 levels the snapshot
is read from the market-data service and carries bookSeq. This is a
public endpoint that does not require authentication.
GET
/
api
/
v1
/
orderbook
/
{tradingPairId}
Orderbook Snapshot
curl --request GET \ --url https://apimonaco.xyz/api/v1/orderbook/{tradingPairId}
Legacy orderbook sequence number; not a book version, and its basis can change, so do not compare it across snapshots. Always 0 above 100 levels, where bookSeq versions the snapshot; at 100 or fewer levels no field versions it.
Durable-log sequence this snapshot is exact as of, as a decimal string. Present only above 100 levels. A point-in-time read and staleness check, not a base for applying WebSocket deltas: for a live local book use the depth WebSocket channel, whose snapshot is the handoff base. A side that returns as many levels as requested may hold more.
Example:
"184467"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Monaco Protocol SDK v1.1.14","description":"High-performance spot and perpetuals trading infrastructure built on Sei. Complete documentation for builders integrating Monaco Protocol into their applications.","colors":{"primary":"#233329","light":"#3A5544","dark":"#1A2620"},"logo":{"light":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0","dark":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo-white.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=2e00e628ed93f72b88edb25eb8d8725e"},"favicon":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logoMark.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=7cfd00a92f26b8cb3855b908c31629b8","api":{"playground":{"proxy":false},"examples":{"prefill":true}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"monaco","hasAudioNarration":false,"actualSubdomain":"monaco","customDomains":["docs.0xmonaco.com"],"gitSource":{"type":"github","owner":"monaco-research","repo":"monaco-core","deployBranch":"develop","contentDirectory":"docs/src","isPrivate":true,"mountPath":"","label":""},"feedback":{"issues":false,"edits":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5296f119781e823692a89","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"APIs","count":189},{"language":"default","tag":"REST API","count":166},{"language":"default","tag":"Libraries","count":27},{"language":"default","tag":"gRPC API","count":21},{"language":"default","tag":"Protobuf Reference","count":21},{"language":"default","tag":"Market","count":20},{"language":"default","tag":"TypeScript SDK","count":19},{"language":"default","tag":"Margin Accounts","count":19},{"language":"default","tag":"Orders","count":19},{"language":"default","tag":"Accounts","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/orderbookservice/orderbook-snapshot","slug":"/api-reference/orderbookservice/orderbook-snapshot","pageMetadata":{"title":"Orderbook Snapshot","description":"Orderbook Snapshot\n\n Get a point-in-time orderbook snapshot for a trading pair: the top bid\n and ask price levels, up to 1000 per side. Above 100 levels the snapshot\n is read from the market-data service and carries bookSeq. This is a\n public endpoint that does not require authentication.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orderbook/{tradingPairId}","href":"/api-reference/orderbookservice/orderbook-snapshot","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Orderbook Snapshot\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Get a point-in-time orderbook snapshot for a trading pair: the top bid\\nand ask price levels, up to 1000 per side. Above 100 levels the snapshot\\nis read from the market-data service and carries bookSeq. This is a\\npublic endpoint that does not require authentication.\"\n })]\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":"Orderbook Snapshot","description":"Orderbook Snapshot\n\n Get a point-in-time orderbook snapshot for a trading pair: the top bid\n and ask price levels, up to 1000 per side. Above 100 levels the snapshot\n is read from the market-data service and carries bookSeq. This is a\n public endpoint that does not require authentication.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orderbook/{tradingPairId}","href":"/api-reference/orderbookservice/orderbook-snapshot","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["OrderbookService","Orderbook"],"summary":"Orderbook Snapshot","description":"Orderbook Snapshot\n\n Get a point-in-time orderbook snapshot for a trading pair: the top bid\n and ask price levels, up to 1000 per side. Above 100 levels the snapshot\n is read from the market-data service and carries bookSeq. This is a\n public endpoint that does not require authentication.","operationId":"get_orderbook_snapshot","parameters":["e1c02a1f-7c9e-4720-bfc5-eb7f62d43da2","61416344-f654-4f1b-9558-e14b626f50f0","4ef33453-6dc4-427b-9470-ba5348179219","e9d8e081-ebdf-4987-8d70-3a49f329aba9","25eb9ff1-6328-41bb-bb5c-5be4eea03983"],"responses":{"200":"91166c5e-d265-4854-9cdd-bbcbdc27f8f5","400":"58dfa217-0d5e-45e3-a0d3-bc657427f3a8","404":"b371a90d-175b-443e-b712-4037efabe6e4","429":"af5a9d9f-16a9-44dd-a3da-8eb2ea2d573b","500":"1ca7dae5-2549-4dff-81ec-76f02768eba2","503":"69b9ac38-533c-4735-a9f3-c782aec88fbc"},"method":"get","type":"path","servers":["76af5a68-1490-444f-9e1c-a0268868c659"],"security":[],"path":"/api/v1/orderbook/{tradingPairId}","baseUrlOptions":["https://apimonaco.xyz"],"title":"Orderbook Snapshot","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"disableProxy":true},"dependencies":{"parameters":{"e1c02a1f-7c9e-4720-bfc5-eb7f62d43da2":{"name":"tradingPairId","in":"path","required":true,"schema":{"type":"string","default":"893d2add-2f36-4ee7-b660-893d2add2f36","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"893d2add-2f36-4ee7-b660-893d2add2f36"},"61416344-f654-4f1b-9558-e14b626f50f0":{"name":"levels","in":"query","schema":{"type":"integer","format":"uint32","minimum":1,"maximum":1000,"default":20,"description":"Number of price levels per side (max 1000). Above 100 the snapshot comes from the market-data book and carries bookSeq","uniqueKey":"","typeLabel":"integer\u003cuint32>"},"description":"Number of price levels per side (max 1000). Above 100 the snapshot comes from the market-data book and carries bookSeq"},"4ef33453-6dc4-427b-9470-ba5348179219":{"name":"tradingMode","in":"query","schema":{"type":"string","enum":["SPOT","MARGIN"],"minLength":1,"description":"Trading mode","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Trading mode"},"e9d8e081-ebdf-4987-8d70-3a49f329aba9":{"name":"magnitude","in":"query","schema":{"type":"string","enum":["0.000001","0.00001","0.0001","0.001","0.01","0.1","1","10","100","1000","10000"],"minLength":1,"description":"Price grouping magnitude","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Price grouping magnitude"},"25eb9ff1-6328-41bb-bb5c-5be4eea03983":{"name":"denomination","in":"query","schema":{"type":"string","enum":["base","quote"],"minLength":1,"description":"Price denomination","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Price denomination"}},"responses":{"91166c5e-d265-4854-9cdd-bbcbdc27f8f5":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"baseDecimals":{"oneOf":[{"example":8,"type":"integer","description":"Base token decimal places","format":"int32","uniqueKey":"baseDecimals.oneOf.0","typeLabel":"integer\u003cint32>"},{"example":8,"type":"null","description":"Base token decimal places","format":"int32","uniqueKey":"baseDecimals.oneOf.1","typeLabel":"null"}],"uniqueKey":"baseDecimals","typeLabel":"integer\u003cint32> | null"},"baseToken":{"oneOf":[{"example":"BTC","type":"string","description":"Base token symbol","uniqueKey":"baseToken.oneOf.0","typeLabel":"string"},{"example":"BTC","type":"null","description":"Base token symbol","uniqueKey":"baseToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"baseToken","typeLabel":"string | null"},"data":{"type":"object","properties":{"bids":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"price":{"oneOf":[{"example":"35000.00","type":"string","description":"Price at this level","uniqueKey":"data.bids.oneOf.0.items.[INDEX].price.oneOf.0","typeLabel":"string"},{"example":"35000.00","type":"null","description":"Price at this level","uniqueKey":"data.bids.oneOf.0.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bids.oneOf.0.items.[INDEX].price","typeLabel":"string | null"},"quantity":{"oneOf":[{"example":"1.5","type":"string","description":"Total quantity at this price level","uniqueKey":"data.bids.oneOf.0.items.[INDEX].quantity.oneOf.0","typeLabel":"string"},{"example":"1.5","type":"null","description":"Total quantity at this price level","uniqueKey":"data.bids.oneOf.0.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bids.oneOf.0.items.[INDEX].quantity","typeLabel":"string | null"},"orderCount":{"oneOf":[{"example":3,"type":"integer","description":"Number of orders at this price level","format":"uint32","uniqueKey":"data.bids.oneOf.0.items.[INDEX].orderCount.oneOf.0","typeLabel":"integer\u003cuint32>"},{"example":3,"type":"null","description":"Number of orders at this price level","format":"uint32","uniqueKey":"data.bids.oneOf.0.items.[INDEX].orderCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bids.oneOf.0.items.[INDEX].orderCount","typeLabel":"integer\u003cuint32> | null"}},"uniqueKey":"data.bids.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.bids.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"price":{"oneOf":[{"example":"35000.00","type":"string","description":"Price at this level"},{"example":"35000.00","type":"null","description":"Price at this level"}]},"quantity":{"oneOf":[{"example":"1.5","type":"string","description":"Total quantity at this price level"},{"example":"1.5","type":"null","description":"Total quantity at this price level"}]},"orderCount":{"oneOf":[{"example":3,"type":"integer","description":"Number of orders at this price level","format":"uint32"},{"example":3,"type":"null","description":"Number of orders at this price level","format":"uint32"}]}}},"uniqueKey":"data.bids.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bids","typeLabel":"object[] | null"},"asks":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"price":{"oneOf":[{"example":"35000.00","type":"string","description":"Price at this level","uniqueKey":"data.asks.oneOf.0.items.[INDEX].price.oneOf.0","typeLabel":"string"},{"example":"35000.00","type":"null","description":"Price at this level","uniqueKey":"data.asks.oneOf.0.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.asks.oneOf.0.items.[INDEX].price","typeLabel":"string | null"},"quantity":{"oneOf":[{"example":"1.5","type":"string","description":"Total quantity at this price level","uniqueKey":"data.asks.oneOf.0.items.[INDEX].quantity.oneOf.0","typeLabel":"string"},{"example":"1.5","type":"null","description":"Total quantity at this price level","uniqueKey":"data.asks.oneOf.0.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.asks.oneOf.0.items.[INDEX].quantity","typeLabel":"string | null"},"orderCount":{"oneOf":[{"example":3,"type":"integer","description":"Number of orders at this price level","format":"uint32","uniqueKey":"data.asks.oneOf.0.items.[INDEX].orderCount.oneOf.0","typeLabel":"integer\u003cuint32>"},{"example":3,"type":"null","description":"Number of orders at this price level","format":"uint32","uniqueKey":"data.asks.oneOf.0.items.[INDEX].orderCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.asks.oneOf.0.items.[INDEX].orderCount","typeLabel":"integer\u003cuint32> | null"}},"uniqueKey":"data.asks.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.asks.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"price":{"oneOf":[{"example":"35000.00","type":"string","description":"Price at this level"},{"example":"35000.00","type":"null","description":"Price at this level"}]},"quantity":{"oneOf":[{"example":"1.5","type":"string","description":"Total quantity at this price level"},{"example":"1.5","type":"null","description":"Total quantity at this price level"}]},"orderCount":{"oneOf":[{"example":3,"type":"integer","description":"Number of orders at this price level","format":"uint32"},{"example":3,"type":"null","description":"Number of orders at this price level","format":"uint32"}]}}},"uniqueKey":"data.asks.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.asks","typeLabel":"object[] | null"},"bestBid":{"oneOf":[{"example":"34900.00","type":"string","description":"Highest bid price","uniqueKey":"data.bestBid.oneOf.0","typeLabel":"string"},{"example":"34900.00","type":"null","description":"Highest bid price","uniqueKey":"data.bestBid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bestBid","typeLabel":"string | null"},"bestAsk":{"oneOf":[{"example":"35100.00","type":"string","description":"Lowest ask price","uniqueKey":"data.bestAsk.oneOf.0","typeLabel":"string"},{"example":"35100.00","type":"null","description":"Lowest ask price","uniqueKey":"data.bestAsk.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bestAsk","typeLabel":"string | null"},"bidVolume":{"oneOf":[{"example":"15.5","type":"string","description":"Total bid-side volume","uniqueKey":"data.bidVolume.oneOf.0","typeLabel":"string"},{"example":"15.5","type":"null","description":"Total bid-side volume","uniqueKey":"data.bidVolume.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bidVolume","typeLabel":"string | null"},"askVolume":{"oneOf":[{"example":"12.3","type":"string","description":"Total ask-side volume","uniqueKey":"data.askVolume.oneOf.0","typeLabel":"string"},{"example":"12.3","type":"null","description":"Total ask-side volume","uniqueKey":"data.askVolume.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.askVolume","typeLabel":"string | null"},"priceChange":{"type":"object","properties":{"price24hAgo":{"oneOf":[{"example":"34500.00","type":"string","description":"Price 24 hours ago","uniqueKey":"data.priceChange.price24hAgo.oneOf.0","typeLabel":"string"},{"example":"34500.00","type":"null","description":"Price 24 hours ago","uniqueKey":"data.priceChange.price24hAgo.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.priceChange.price24hAgo","typeLabel":"string | null"},"priceChange24h":{"oneOf":[{"example":"500.00","type":"string","description":"Absolute price change in last 24 hours","uniqueKey":"data.priceChange.priceChange24h.oneOf.0","typeLabel":"string"},{"example":"500.00","type":"null","description":"Absolute price change in last 24 hours","uniqueKey":"data.priceChange.priceChange24h.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.priceChange.priceChange24h","typeLabel":"string | null"},"priceChangePercent24h":{"oneOf":[{"example":"1.45","type":"string","description":"Percentage price change in last 24 hours","uniqueKey":"data.priceChange.priceChangePercent24h.oneOf.0","typeLabel":"string"},{"example":"1.45","type":"null","description":"Percentage price change in last 24 hours","uniqueKey":"data.priceChange.priceChangePercent24h.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.priceChange.priceChangePercent24h","typeLabel":"string | null"}},"uniqueKey":"data.priceChange","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"},"eventType":{"oneOf":[{"example":"orderbook_snapshot","type":"string","description":"Event type identifier","uniqueKey":"eventType.oneOf.0","typeLabel":"string"},{"example":"orderbook_snapshot","type":"null","description":"Event type identifier","uniqueKey":"eventType.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventType","typeLabel":"string | null"},"symbol":{"oneOf":[{"example":"BTC/USDC","type":"string","description":"Trading pair symbol","uniqueKey":"symbol.oneOf.0","typeLabel":"string"},{"example":"BTC/USDC","type":"null","description":"Trading pair symbol","uniqueKey":"symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"symbol","typeLabel":"string | null"},"tradingPairId":{"oneOf":[{"example":"123e4567-e89b-12d3-a456-426614174000","type":"string","description":"Trading pair UUID","format":"uuid","uniqueKey":"tradingPairId.oneOf.0","typeLabel":"string\u003cuuid>"},{"example":"123e4567-e89b-12d3-a456-426614174000","type":"null","description":"Trading pair UUID","format":"uuid","uniqueKey":"tradingPairId.oneOf.1","typeLabel":"null"}],"uniqueKey":"tradingPairId","typeLabel":"string\u003cuuid> | null"},"quoteDecimals":{"oneOf":[{"example":6,"type":"integer","description":"Quote token decimal places","format":"int32","uniqueKey":"quoteDecimals.oneOf.0","typeLabel":"integer\u003cint32>"},{"example":6,"type":"null","description":"Quote token decimal places","format":"int32","uniqueKey":"quoteDecimals.oneOf.1","typeLabel":"null"}],"uniqueKey":"quoteDecimals","typeLabel":"integer\u003cint32> | null"},"quoteToken":{"oneOf":[{"example":"USDC","type":"string","description":"Quote token symbol","uniqueKey":"quoteToken.oneOf.0","typeLabel":"string"},{"example":"USDC","type":"null","description":"Quote token symbol","uniqueKey":"quoteToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"quoteToken","typeLabel":"string | null"},"sequenceNumber":{"oneOf":[{"example":12345,"type":"integer","description":"Legacy orderbook sequence number; not a book version, and its basis can change, so do not compare it across snapshots. Always 0 above 100 levels, where bookSeq versions the snapshot; at 100 or fewer levels no field versions it.","format":"uint32","uniqueKey":"sequenceNumber.oneOf.0","typeLabel":"integer\u003cuint32>"},{"example":12345,"type":"null","description":"Legacy orderbook sequence number; not a book version, and its basis can change, so do not compare it across snapshots. Always 0 above 100 levels, where bookSeq versions the snapshot; at 100 or fewer levels no field versions it.","format":"uint32","uniqueKey":"sequenceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"sequenceNumber","typeLabel":"integer\u003cuint32> | null"},"timestamp":{"oneOf":[{"example":"2023-11-13T10:30:00Z","type":"string","description":"Snapshot timestamp","uniqueKey":"timestamp.oneOf.0","typeLabel":"string"},{"example":"2023-11-13T10:30:00Z","type":"null","description":"Snapshot timestamp","uniqueKey":"timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"timestamp","typeLabel":"string | null"},"tradingMode":{"oneOf":[{"example":"Spot","type":"string","description":"Trading mode","uniqueKey":"tradingMode.oneOf.0","typeLabel":"string"},{"example":"Spot","type":"null","description":"Trading mode","uniqueKey":"tradingMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"tradingMode","typeLabel":"string | null"},"bookSeq":{"oneOf":[{"example":"184467","type":"string","description":"Durable-log sequence this snapshot is exact as of, as a decimal string. Present only above 100 levels. A point-in-time read and staleness check, not a base for applying WebSocket deltas: for a live local book use the depth WebSocket channel, whose snapshot is the handoff base. A side that returns as many levels as requested may hold more.","uniqueKey":"bookSeq.oneOf.0","typeLabel":"string"},{"example":"184467","type":"null","description":"Durable-log sequence this snapshot is exact as of, as a decimal string. Present only above 100 levels. A point-in-time read and staleness check, not a base for applying WebSocket deltas: for a live local book use the depth WebSocket channel, whose snapshot is the handoff base. A side that returns as many levels as requested may hold more.","uniqueKey":"bookSeq.oneOf.1","typeLabel":"null"}],"uniqueKey":"bookSeq","typeLabel":"string | null"}},"description":"Orderbook snapshot with token metadata and sequence number.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"baseDecimals":8,"baseToken":"BTC","data":{"bids":[{"price":"35000.00","quantity":"1.5","orderCount":3}],"asks":[{"price":"35000.00","quantity":"1.5","orderCount":3}],"bestBid":"34900.00","bestAsk":"35100.00","bidVolume":"15.5","askVolume":"12.3","priceChange":{"price24hAgo":"34500.00","priceChange24h":"500.00","priceChangePercent24h":"1.45"}},"eventType":"orderbook_snapshot","symbol":"BTC/USDC","tradingPairId":"123e4567-e89b-12d3-a456-426614174000","quoteDecimals":6,"quoteToken":"USDC","sequenceNumber":12345,"timestamp":"2023-11-13T10:30:00Z","tradingMode":"Spot","bookSeq":"184467"}}},"exampleType":"generated"}},"exampleType":"generated"},"58dfa217-0d5e-45e3-a0d3-bc657427f3a8":{"description":"levels outside 1 to 1000, a tradingMode that is invalid or not the pair's, or an invalid magnitude or denomination value","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b371a90d-175b-443e-b712-4037efabe6e4":{"description":"Trading pair not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"af5a9d9f-16a9-44dd-a3da-8eb2ea2d573b":{"description":"Deep orderbook read budget exceeded for this client IP on the public ingress (reads above 100 levels cost ceil(levels/100) units; PrivateLink is not metered); retry after the interval in details.retryAfter","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1ca7dae5-2549-4dff-81ec-76f02768eba2":{"description":"Internal error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"69b9ac38-533c-4735-a9f3-c782aec88fbc":{"description":"The book cannot be read right now: the market-data service above 100 levels, the matching engine at 100 or fewer, or the gateway's matching-engine client is not ready (at any depth); retry","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"76af5a68-1490-444f-9e1c-a0268868c659":{"url":"https://apimonaco.xyz","description":"Production (Sei mainnet)"}}},"originalFileLocation":"proto-openapi/api/openapi.yaml"},"subdomain":"monaco","siteName":"Monaco Protocol SDK v1.1.14","title":"Orderbook Snapshot - Monaco Protocol SDK v1.1.14","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T00:28:13.713Z","originalFileLocation":"api-reference/orderbookservice/orderbook-snapshot.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=\"Orderbook Snapshot Get a point-in-time orderbook snapshot for a trading pair: the top bid and ask price levels, up to 1000 per side. Above 100 levels the snapshot is read from the market-data service and carries bookSeq. This is a public endpoint that does not require authentication.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Orderbook Snapshot - Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head property=\"og:description\" content=\"Orderbook Snapshot Get a point-in-time orderbook snapshot for a trading pair: the top bid and ask price levels, up to 1000 per side. Above 100 levels the snapshot is read from the market-data service and carries bookSeq. This is a public endpoint that does not require authentication.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://monaco.mintlify.site/_mintlify/api/og/v2?division=Orderbook\u0026amp;title=Orderbook+Snapshot\u0026amp;description=Orderbook+Snapshot%0A%0A+Get+a+point-in-time+orderbook+snapshot+for+a+trading+pair%3A+the+top+bid%0A+and+ask+price+levels%2C+up+to+1000+per+side.+Above+100+levels+the+sna\u0026amp;theme=86c8539ecb88515b97c26589\u0026amp;signature=909727be8b3e45bd849ce6a2eb27db0c6d0a66bdd83d8ddaec55f5f669240c6d\">\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=\"Orderbook Snapshot - Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Orderbook Snapshot Get a point-in-time orderbook snapshot for a trading pair: the top bid and ask price levels, up to 1000 per side. Above 100 levels the snapshot is read from the market-data service and carries bookSeq. This is a public endpoint that does not require authentication.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://monaco.mintlify.site/_mintlify/api/og/v2?division=Orderbook\u0026amp;title=Orderbook+Snapshot\u0026amp;description=Orderbook+Snapshot%0A%0A+Get+a+point-in-time+orderbook+snapshot+for+a+trading+pair%3A+the+top+bid%0A+and+ask+price+levels%2C+up+to+1000+per+side.+Above+100+levels+the+sna\u0026amp;theme=86c8539ecb88515b97c26589\u0026amp;signature=909727be8b3e45bd849ce6a2eb27db0c6d0a66bdd83d8ddaec55f5f669240c6d\">\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/monaco/4wZNikyT1wBLArhB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#233329\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orderbookservice/orderbook-snapshot.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.0xmonaco.com/#organization\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"url\":\"https://docs.0xmonaco.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.0xmonaco.com#website\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"url\":\"https://docs.0xmonaco.com\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot#webpage\",\"url\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot\",\"name\":\"Orderbook Snapshot\",\"description\":\"Orderbook Snapshot Get a point-in-time orderbook snapshot for a trading pair: the top bid and ask price levels, up to 1000 per side. Above 100 levels the snapshot is read from the market-data service and carries bookSeq. This is a public endpoint that does not require authentication.\",\"dateModified\":\"2026-11-12T00:28:13.713Z\",\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.0xmonaco.com/api-reference/healthservice/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API\",\"item\":\"https://docs.0xmonaco.com/api-reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Orderbook Snapshot\",\"item\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot#apireference\",\"headline\":\"Orderbook Snapshot\",\"name\":\"Orderbook Snapshot\",\"description\":\"Orderbook Snapshot Get a point-in-time orderbook snapshot for a trading pair: the top bid and ask price levels, up to 1000 per side. Above 100 levels the snapshot is read from the market-data service and carries bookSeq. This is a public endpoint that does not require authentication.\",\"url\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot\",\"mainEntityOfPage\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/orderbookservice/orderbook-snapshot#webpage\"},\"dateModified\":\"2026-11-12T00:28:13.713Z\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Monaco Protocol SDK v1.1.14\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/orderbookservice/orderbook-snapshot.md","siteName":"Monaco Protocol SDK v1.1.14","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[{"title":"Introduction","href":"/introduction"},{"title":"Markets","href":"/markets"},{"title":"AI \u0026 Agents","href":"/build-with-ai"},{"group":"Learn","pages":[{"title":"Accounts","href":"/accounts"},{"title":"Orders","href":"/trading-mechanics/spot"},{"title":"Margin","href":"/trading-mechanics/perps"},{"title":"Funding Rates","href":"/trading-mechanics/funding-rates"},{"title":"Liquidations \u0026 Auto-Deleveraging","href":"/trading-mechanics/liquidations"},{"title":"Fees","href":"/fees"},{"title":"Earn","href":"/earn"}]},{"group":"Build","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"Testnet","href":"/testnet"},{"title":"Wallets \u0026 Auth","href":"/developers/accounts/wallets"},{"title":"Balances, Deposits \u0026 Withdrawals","href":"/developers/vault"},{"title":"Perps Collateral","href":"/developers/perps-collateral"},{"title":"Market Data","href":"/developers/markets"},{"title":"Order Management","href":"/developers/trade"},{"title":"Rate Limits","href":"/developers/rate-limits"},{"title":"Positions","href":"/developers/positions"},{"title":"Market-Maker Runbook","href":"/developers/market-maker-runbook"},{"title":"RFQ (block trades)","href":"/developers/rfq"},{"title":"Delegated Agents","href":"/developers/delegated-agents"},{"title":"Invite Codes","href":"/developers/invite-codes"},{"title":"TraderCodes","href":"/developers/tradercodes"},{"title":"BuilderCodes","href":"/developers/buildercodes"}]},{"group":"Libraries","pages":[{"title":"MCP Server","href":"/sdk/mcp-server"},{"group":"TypeScript SDK","root":{"title":"TypeScript SDK","href":"/sdk/typescript/intro"},"expanded":false,"pages":[{"title":"Applications","href":"/sdk/typescript/applications"},{"title":"Authentication","href":"/sdk/typescript/auth"},{"title":"Error Handling","href":"/sdk/typescript/error-handling"},{"title":"Market Data","href":"/sdk/typescript/market"},{"title":"Market Pulse","href":"/sdk/typescript/pulse"},{"title":"Region Status","href":"/sdk/typescript/compliance"},{"title":"Analytics","href":"/sdk/typescript/analytics"},{"title":"Profile","href":"/sdk/typescript/profile"},{"title":"Portfolio Analytics","href":"/sdk/typescript/portfolio"},{"title":"Trading","href":"/sdk/typescript/trades"},{"title":"RFQ","href":"/sdk/typescript/rfq"},{"title":"Margin Accounts","href":"/sdk/typescript/margin-accounts"},{"title":"Positions","href":"/sdk/typescript/positions"},{"title":"Delegated Agents","href":"/sdk/typescript/delegated-agents"},{"title":"Vault","href":"/sdk/typescript/vault"},{"title":"TraderCodes","href":"/sdk/typescript/tradercodes"},{"title":"BuilderCodes","href":"/sdk/typescript/buildercodes"},{"title":"Managed Markets","href":"/sdk/typescript/managed-markets"},{"title":"WebSockets","href":"/sdk/typescript/websockets"}]},{"group":"React SDK","root":{"title":"React SDK","href":"/sdk/react/intro"},"expanded":false,"pages":[{"title":"Session \u0026 Profile Hooks","href":"/sdk/react/hooks/session"},{"title":"Market Data Hooks","href":"/sdk/react/hooks/market-data"},{"title":"Trading Hooks","href":"/sdk/react/hooks/trading"},{"title":"Balance \u0026 Vault Hooks","href":"/sdk/react/hooks/balances"},{"title":"TraderCodes Hooks","href":"/sdk/react/hooks/codes"}]},{"title":"Rust SDK","href":"/sdk/rust"},{"title":"Python, Go, C++ \u0026 More","href":"/sdk/python-quickstart"}]},{"group":"APIs","pages":[{"group":"REST API","root":{"title":"REST API","href":"/api-reference"},"expanded":false,"pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /health","href":"/api-reference/healthservice/health-check"}]},{"group":"Auth","pages":[{"title":"Create authentication challenge","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/challenge","href":"/api-reference/authservice/create-authentication-challenge"},{"title":"Verify signature and authenticate","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/verify","href":"/api-reference/authservice/verify-signature-and-authenticate"},{"title":"Mint one Mainnet invite code","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/invite-codes/requests","href":"/api-reference/authservice/mint-one-mainnet-invite-code"},{"title":"List my Mainnet invite codes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/invite-codes","href":"/api-reference/authservice/list-my-mainnet-invite-codes"},{"title":"Refresh session expiry","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/refresh","href":"/api-reference/authservice/refresh-session-expiry"},{"title":"Revoke current session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/revoke","href":"/api-reference/authservice/revoke-current-session"}]},{"group":"Accounts","pages":[{"title":"Get user profile","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me","href":"/api-reference/accountsservice/get-user-profile"},{"title":"Get user balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances","href":"/api-reference/accountsservice/get-user-balances"},{"title":"Get user balance by asset","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances/{assetId}","href":"/api-reference/accountsservice/get-user-balance-by-asset"},{"title":"Get user movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/movements","href":"/api-reference/accountsservice/get-user-movements"},{"title":"Get user trade history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/trades","href":"/api-reference/accountsservice/get-user-trade-history"},{"title":"Get portfolio stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio","href":"/api-reference/accountsservice/get-portfolio-stats"},{"title":"Get portfolio chart time series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/chart","href":"/api-reference/accountsservice/get-portfolio-chart-time-series"},{"title":"Get portfolio summary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/summary","href":"/api-reference/accountsservice/get-portfolio-summary"},{"title":"Get portfolio performance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/performance","href":"/api-reference/accountsservice/get-portfolio-performance"},{"title":"Get portfolio realized PnL","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/realized-pnl","href":"/api-reference/accountsservice/get-portfolio-realized-pnl"},{"title":"Get portfolio assets","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/assets","href":"/api-reference/accountsservice/get-portfolio-assets"},{"title":"Get portfolio margin","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/margin","href":"/api-reference/accountsservice/get-portfolio-margin"},{"title":"List funding payments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/funding-payments","href":"/api-reference/accountsservice/list-funding-payments"},{"title":"List sub-accounts with balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts","href":"/api-reference/accountsservice/list-sub-accounts-with-balances"},{"title":"Get your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/get-your-self-trade-prevention-default"},{"title":"Set your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/set-your-self-trade-prevention-default"}]},{"group":"Account Limits","pages":[{"title":"Create sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/accounts/sub-accounts/limits","href":"/api-reference/accountsservice/create-sub-account-limit"},{"title":"Get sub-account limits","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts/{subAccountId}/limits","href":"/api-reference/accountsservice/get-sub-account-limits"},{"title":"Update sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/update-sub-account-limit"},{"title":"Delete sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/delete-sub-account-limit"}]},{"group":"Applications","pages":[{"title":"Get application configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/config","href":"/api-reference/applicationsservice/get-application-configuration"},{"title":"Get application stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/stats","href":"/api-reference/applicationsservice/get-application-stats"},{"title":"List application users","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/users","href":"/api-reference/applicationsservice/list-application-users"},{"title":"List application balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/balances","href":"/api-reference/applicationsservice/list-application-balances"},{"title":"List application margin accounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/margin-accounts","href":"/api-reference/applicationsservice/list-application-margin-accounts"},{"title":"List application orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/orders","href":"/api-reference/applicationsservice/list-application-orders"},{"title":"List application movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/movements","href":"/api-reference/applicationsservice/list-application-movements"}]},{"group":"Market","pages":[{"title":"Trading Pairs","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs","href":"/api-reference/marketservice/trading-pairs"},{"title":"Trading Pair By ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}","href":"/api-reference/marketservice/trading-pair-by-id"},{"title":"Market Metadata","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/metadata","href":"/api-reference/marketservice/market-metadata"},{"title":"Get apiv1marketpairs perpconfig","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/config","href":"/api-reference/marketservice/get-apiv1marketpairs-perpconfig"},{"title":"Get apiv1marketpairs perpsummary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/summary","href":"/api-reference/marketservice/get-apiv1marketpairs-perpsummary"},{"title":"Get apiv1marketpairs mark price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/mark-price","href":"/api-reference/marketservice/get-apiv1marketpairs-mark-price"},{"title":"Get apiv1marketpairs index price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/index-price","href":"/api-reference/marketservice/get-apiv1marketpairs-index-price"},{"title":"Get apiv1marketpairs funding","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding","href":"/api-reference/marketservice/get-apiv1marketpairs-funding"},{"title":"Get apiv1marketpairs fundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding/history","href":"/api-reference/marketservice/get-apiv1marketpairs-fundinghistory"},{"title":"Get apiv1marketfundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/funding/history","href":"/api-reference/marketservice/get-apiv1marketfundinghistory"},{"title":"Open Interest","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/open-interest","href":"/api-reference/marketservice/open-interest"},{"title":"Trader Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trader-metrics","href":"/api-reference/marketservice/trader-metrics"},{"title":"Trade Flow","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trade-flow","href":"/api-reference/marketservice/trade-flow"},{"title":"Liquidation Events","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-events","href":"/api-reference/marketservice/liquidation-events"},{"title":"All Liquidation Events","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/liquidation-events","href":"/api-reference/marketservice/all-liquidation-events"},{"title":"Insurance Funds","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/insurance-funds","href":"/api-reference/marketservice/insurance-funds"},{"title":"Liquidation Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-metrics","href":"/api-reference/marketservice/liquidation-metrics"},{"title":"Candlestick Data","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/charts/candlestick/{tradingPairId}/{interval}","href":"/api-reference/marketservice/candlestick-data"},{"title":"Market Stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/stats","href":"/api-reference/marketservice/market-stats"},{"title":"Market Screener","description":"Market Screener\n\n Single-call aggregate of per-pair market stats across all trading pairs.\n Returns current price plus quote-volume and percent price change for\n 1h / 24h / 7d windows, and a 7-point UTC-day snapshot for sparkline\n rendering. Window fields are independently null when a pair lacks\n sufficient history. Results sorted by quoteVolume24h descending\n (nulls last) and paginated.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/screener","href":"/api-reference/marketservice/market-screener"}]},{"group":"Orderbook","pages":[{"title":"Orderbook Snapshot","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orderbook/{tradingPairId}","href":"/api-reference/orderbookservice/orderbook-snapshot"}]},{"group":"Trades","pages":[{"title":"Trade Feed","description":"Trade Feed\n\n Trades across every market, newest first, from the full history (recent\n and archived trades alike). Set `taker_application_id` to list only the\n trades an application (frontend) took. Public; each client IP has a read\n budget, and a request over it gets HTTP 429 / RESOURCE_EXHAUSTED.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades","href":"/api-reference/tradesservice/trade-feed"},{"title":"Recent Trades","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/{tradingPairId}","href":"/api-reference/tradesservice/recent-trades"},{"title":"Get Trade by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/by-id/{tradeId}","href":"/api-reference/tradesservice/get-trade-by-id"}]},{"group":"RFQ","pages":[{"title":"Get RFQ capabilities","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfq/capabilities","href":"/api-reference/rfqservice/get-rfq-capabilities"},{"title":"Request quotes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs","href":"/api-reference/rfqservice/request-quotes"},{"title":"List your RFQs","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfqs","href":"/api-reference/rfqservice/list-your-rfqs"},{"title":"Get an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfqs/{rfqId}","href":"/api-reference/rfqservice/get-an-rfq"},{"title":"Accept an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/accept","href":"/api-reference/rfqservice/accept-an-rfq"},{"title":"Cancel an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/cancel","href":"/api-reference/rfqservice/cancel-an-rfq"},{"title":"Quote an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/rfqs/{rfqId}/quote","href":"/api-reference/rfqservice/quote-an-rfq"},{"title":"Withdraw a quote","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/rfqs/{rfqId}/quote","href":"/api-reference/rfqservice/withdraw-a-quote"},{"title":"Answer last look","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/last-look","href":"/api-reference/rfqservice/answer-last-look"}]},{"group":"Fees","pages":[{"title":"Simulate fees for a potential order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/simulate","href":"/api-reference/feesservice/simulate-fees-for-a-potential-order"},{"title":"Get my fee tier and pair schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/tier","href":"/api-reference/feesservice/get-my-fee-tier-and-pair-schedule"},{"title":"Get a trading pair's fee tier schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/schedule","href":"/api-reference/feesservice/get-a-trading-pairs-fee-tier-schedule"}]},{"group":"Withdrawals","pages":[{"title":"Initiate withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/initiate-withdrawal"},{"title":"List pending withdrawals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/list-pending-withdrawals"},{"title":"Get withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals/{withdrawalIndex}","href":"/api-reference/withdrawalsservice/get-withdrawal"}]},{"group":"Analytics","pages":[{"title":"Protocol totals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/protocol/totals","href":"/api-reference/analyticsservice/protocol-totals"},{"title":"Protocol series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/protocol/series","href":"/api-reference/analyticsservice/protocol-series"},{"title":"Market volumes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/markets/volume","href":"/api-reference/analyticsservice/market-volumes"},{"title":"Treasury net fees","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/treasury/net-fees","href":"/api-reference/analyticsservice/treasury-net-fees"},{"title":"Builders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders","href":"/api-reference/analyticsservice/builders"},{"title":"Builder","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}","href":"/api-reference/analyticsservice/builder"},{"title":"Builder totals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}/totals","href":"/api-reference/analyticsservice/builder-totals"},{"title":"Builder series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}/series","href":"/api-reference/analyticsservice/builder-series"},{"title":"Builder leaderboard","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builder-leaderboard","href":"/api-reference/analyticsservice/builder-leaderboard"},{"title":"Wallet leaderboard","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallet-leaderboard","href":"/api-reference/analyticsservice/wallet-leaderboard"},{"title":"Wallet summary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallets/{wallet}","href":"/api-reference/analyticsservice/wallet-summary"},{"title":"Wallet liquidations","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallets/{wallet}/liquidations","href":"/api-reference/analyticsservice/wallet-liquidations"},{"title":"Token custody","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/tokens","href":"/api-reference/analyticsservice/token-custody"},{"title":"Token custody detail","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/tokens/{token}","href":"/api-reference/analyticsservice/token-custody-detail"},{"title":"Vault deposits","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/deposits","href":"/api-reference/analyticsservice/vault-deposits"},{"title":"Vault withdrawals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/withdrawals","href":"/api-reference/analyticsservice/vault-withdrawals"}]},{"group":"Pulse","pages":[{"title":"Get the market pulse news feed","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/pulse","href":"/api-reference/pulseservice/get-the-market-pulse-news-feed"}]},{"group":"Compliance","pages":[{"title":"Get the caller's region status","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/compliance/region","href":"/api-reference/complianceservice/get-the-callers-region-status"}]},{"group":"Sweeper","pages":[{"title":"Register a deposit address for monitoring","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/sweeper/register","href":"/api-reference/sweeperservice/register-a-deposit-address-for-monitoring"},{"title":"List the chains and assets the sweeper watches","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/chains","href":"/api-reference/sweeperservice/list-the-chains-and-assets-the-sweeper-watches"},{"title":"List the caller's sweeper deposits, newest first","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits","href":"/api-reference/sweeperservice/list-the-callers-sweeper-deposits-newest-first"},{"title":"Get the status of the caller's deposit from Hyperliquid by its action nonce","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits/hypercore/{nonce}","href":"/api-reference/sweeperservice/get-the-status-of-the-callers-deposit-from-hyperliquid-by-its-action-nonce"},{"title":"Get the status of the caller's sweeper deposits in one transaction","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits/{txHash}","href":"/api-reference/sweeperservice/get-the-status-of-the-callers-sweeper-deposits-in-one-transaction"}]},{"group":"Managed Markets","pages":[{"title":"List caller managed market assignments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/managed-markets/assignments","href":"/api-reference/managedmarketsservice/list-caller-managed-market-assignments"},{"title":"Claim or renew a fenced maker lease","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/lease","href":"/api-reference/managedmarketsservice/claim-or-renew-a-fenced-maker-lease"},{"title":"Refresh the server-bounded managed quote set","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/quotes","href":"/api-reference/managedmarketsservice/refresh-the-server-bounded-managed-quote-set"}]},{"group":"Orders","pages":[{"title":"Get user orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders","href":"/api-reference/ordersservice/get-user-orders"},{"title":"Create new order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders","href":"/api-reference/ordersservice/create-new-order"},{"title":"Get order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/get-order-by-id"},{"title":"Replace existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/replace-existing-order"},{"title":"Cancel existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/cancel","href":"/api-reference/ordersservice/cancel-existing-order"},{"title":"Batch cancel specific orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel","href":"/api-reference/ordersservice/batch-cancel-specific-orders"},{"title":"Batch create orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-create","href":"/api-reference/ordersservice/batch-create-orders"},{"title":"Batch replace orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-replace","href":"/api-reference/ordersservice/batch-replace-orders"},{"title":"Cancel all orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all","href":"/api-reference/ordersservice/cancel-all-orders"},{"title":"Cancel all orders for a trading pair","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all/{tradingPairId}","href":"/api-reference/ordersservice/cancel-all-orders-for-a-trading-pair"},{"title":"Cancel all orders after a timeout","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/cancel-all-after","href":"/api-reference/ordersservice/cancel-all-orders-after-a-timeout"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Delete apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/delete-apiv1ordersconditional"},{"title":"Create TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap","href":"/api-reference/ordersservice/create-twap-order"},{"title":"List TWAP orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap","href":"/api-reference/ordersservice/list-twap-orders"},{"title":"Get TWAP order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}","href":"/api-reference/ordersservice/get-twap-order-by-id"},{"title":"Get TWAP order TCA report","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/tca","href":"/api-reference/ordersservice/get-twap-order-tca-report"},{"title":"List TWAP order slices","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/slices","href":"/api-reference/ordersservice/list-twap-order-slices"},{"title":"Cancel TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap/{twapOrderId}/cancel","href":"/api-reference/ordersservice/cancel-twap-order"}]},{"group":"Margin Accounts","pages":[{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Post apiv1marginaccounts collateraltransfer in","deprecated":true,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-in"},{"title":"Post apiv1marginaccounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-out"},{"title":"Get apiv1marginaccounts movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-movements"},{"title":"Get apiv1marginaccounts pnl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/pnl","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-pnl"},{"title":"Post apiv1marginaccounts simulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-simulate-order-risk"},{"title":"Get apiv1margincollateralavailable","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/collateral/available","href":"/api-reference/marginaccountsservice/get-apiv1margincollateralavailable"},{"title":"Post apiv1margincollateraltransfer","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/collateral/transfer","href":"/api-reference/marginaccountsservice/post-apiv1margincollateraltransfer"},{"title":"Get apiv1marginparent margin account","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-account"},{"title":"Post apiv1marginparent margin accountcollateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-in"},{"title":"Post apiv1marginparent margin accountcollateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-out"},{"title":"Get apiv1marginparent margin accountmovements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-accountmovements"},{"title":"Post apiv1marginparent margin accountsimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountsimulate-order-risk"},{"title":"Post apiv1marginrisk bucketscollateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketscollateraltransfer-in"},{"title":"Post apiv1marginrisk bucketssimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk"},{"title":"Post apiv1marginsub accounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts"},{"title":"Post apiv1marginsub accounts close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/close","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-close"},{"title":"Post apiv1marginsub accounts collateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-in"},{"title":"Post apiv1marginsub accounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-out"}]},{"group":"Positions","pages":[{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Get apiv1positionshistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/history","href":"/api-reference/positionsservice/get-apiv1positionshistory"},{"title":"Post apiv1positionsbatch close all","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/batch-close-all","href":"/api-reference/positionsservice/post-apiv1positionsbatch-close-all"},{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Post apiv1positions close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/close","href":"/api-reference/positionsservice/post-apiv1positions-close"},{"title":"Get position PnL history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/pnl/history","href":"/api-reference/positionsservice/get-position-pnl-history"},{"title":"Get apiv1positions risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/risk","href":"/api-reference/positionsservice/get-apiv1positions-risk"},{"title":"Post apiv1positions tp sl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/tp-sl","href":"/api-reference/positionsservice/post-apiv1positions-tp-sl"}]},{"group":"Delegated Agents","pages":[{"title":"Upsert delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/upsert-delegated-agent"},{"title":"List delegated agents","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/list-delegated-agents"},{"title":"List delegating owners","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents/owners","href":"/api-reference/delegatedagentsservice/list-delegating-owners"},{"title":"Revoke delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/delegated-agents/{delegatedAgentId}","href":"/api-reference/delegatedagentsservice/revoke-delegated-agent"},{"title":"Create delegated session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents/sessions","href":"/api-reference/delegatedagentsservice/create-delegated-session"}]},{"group":"TraderCodes","pages":[{"title":"Get your TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/me","href":"/api-reference/tradercodeservice/get-your-tradercode"},{"title":"Check custom TraderCode availability","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/available","href":"/api-reference/tradercodeservice/check-custom-tradercode-availability"},{"title":"Look up a TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/{code}","href":"/api-reference/tradercodeservice/look-up-a-tradercode"},{"title":"Claim or edit your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/claim-or-edit-your-custom-tradercode"},{"title":"Clear your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/clear-your-custom-tradercode"},{"title":"Get your referral position","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me","href":"/api-reference/tradercodeservice/get-your-referral-position"},{"title":"Get your referral downline and earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/downline","href":"/api-reference/tradercodeservice/get-your-referral-downline-and-earnings"},{"title":"Get one level of your referral tree","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/tree","href":"/api-reference/tradercodeservice/get-one-level-of-your-referral-tree"},{"title":"Get your rewards balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/rewards/balance","href":"/api-reference/tradercodeservice/get-your-rewards-balance"},{"title":"Transfer rewards into a trading balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/tradercodes/rewards/transfer","href":"/api-reference/tradercodeservice/transfer-rewards-into-a-trading-balance"}]},{"group":"BuilderCodes","pages":[{"title":"Get your BuilderCodes program configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/config","href":"/api-reference/buildercoderewardsservice/get-your-buildercodes-program-configuration"},{"title":"Set your builder fees","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/buildercodes/builder-fee","href":"/api-reference/buildercoderewardsservice/set-your-builder-fees"},{"title":"List your builder-fee changes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/builder-fee/changes","href":"/api-reference/buildercoderewardsservice/list-your-builder-fee-changes"},{"title":"List your per-trade BuilderCodes earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts","href":"/api-reference/buildercoderewardsservice/list-your-per-trade-buildercodes-earnings"},{"title":"Summarize your BuilderCodes earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts/summary","href":"/api-reference/buildercoderewardsservice/summarize-your-buildercodes-earnings"},{"title":"Get your accrued BuilderCodes balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/rewards/balance","href":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance"},{"title":"Claim accrued BuilderCodes payout balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/buildercodes/rewards/claim","href":"/api-reference/buildercoderewardsservice/claim-accrued-buildercodes-payout-balance"}]}]},{"title":"WebSocket API","href":"/reference/websockets"},{"title":"HTTP message signatures","href":"/reference/http-message-signatures"},{"group":"gRPC API","root":{"title":"gRPC API","href":"/reference/grpc"},"expanded":false,"pages":[{"group":"Protobuf Reference","root":{"title":"Protobuf Reference","href":"/grpc/protos"},"expanded":false,"pages":[{"group":"Core","pages":[{"title":"AuthService","href":"/grpc/protos/auth"},{"title":"AccountsService","href":"/grpc/protos/accounts"},{"title":"ApplicationsService","href":"/grpc/protos/applications"},{"title":"HealthService","href":"/grpc/protos/health"},{"title":"ComplianceService","href":"/grpc/protos/compliance"}]},{"group":"Trading","pages":[{"title":"MarketService","href":"/grpc/protos/market"},{"title":"AnalyticsService","href":"/grpc/protos/analytics"},{"title":"PulseService","href":"/grpc/protos/pulse"},{"title":"OrdersService","href":"/grpc/protos/orders"},{"title":"OrderbookService","href":"/grpc/protos/orderbook"},{"title":"TradesService","href":"/grpc/protos/trades"},{"title":"FeesService","href":"/grpc/protos/fees"},{"title":"RfqService","href":"/grpc/protos/rfq"}]},{"group":"Perps","pages":[{"title":"MarginAccountsService","href":"/grpc/protos/margin-accounts"},{"title":"PositionsService","href":"/grpc/protos/positions"}]},{"group":"Vault and Delegation","pages":[{"title":"WithdrawalsService","href":"/grpc/protos/withdrawals"},{"title":"SweeperService","href":"/grpc/protos/sweeper"},{"title":"DelegatedAgentsService","href":"/grpc/protos/delegated-agents"}]},{"group":"TraderCodes","pages":[{"title":"TraderCodeService","href":"/grpc/protos/tradercodes"}]},{"group":"BuilderCodes","pages":[{"title":"BuildercodeRewardsService","href":"/grpc/protos/buildercodes"}]},{"group":"Managed Markets","pages":[{"title":"ManagedMarketsService","href":"/grpc/protos/managed-markets"}]}]}]}]},{"group":"Resources","pages":[{"title":null,"href":"/changelog"},{"group":"Examples","expanded":false,"pages":[{"title":"Build a Trading App","href":"/examples/build-trading-app"},{"title":"End-to-End Examples","href":"/examples/end-to-end"}]}]}]},"basePath":"","title":"Orderbook Snapshot - Monaco Protocol SDK v1.1.14","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}