Format and example of WebSocket error responses, including the client ID mapping pattern.
Error responses follow the same format as successful responses, with success set to false and an errorMsg field explaining the issue. You can use the id field to map the error response with the corresponding request.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Orderly","colors":{"primary":"#aa5cf8","light":"#BE7CFF","dark":"#aa5cf8"},"logo":{"light":"https://mintcdn.com/orderly-network-staging/GoLgfYba1CLV7Hn-/logo/light.svg?fit=max\u0026auto=format\u0026n=GoLgfYba1CLV7Hn-\u0026q=85\u0026s=a284c772cd7a2d9d12e66558986910ba","dark":"https://mintcdn.com/orderly-network-staging/GoLgfYba1CLV7Hn-/logo/dark.svg?fit=max\u0026auto=format\u0026n=GoLgfYba1CLV7Hn-\u0026q=85\u0026s=fc450bfc96ea6c25ebb2bca350f5d64a"},"favicon":"https://mintcdn.com/orderly-network-staging/W2c87En2SrxSUBGJ/favicon.png?fit=max\u0026auto=format\u0026n=W2c87En2SrxSUBGJ\u0026q=85\u0026s=6d4dbe3d03cbecc127b55cb8fb064eb7","api":{"openapi":["orderly.openapi.yaml","sv.openapi.yaml"]},"appearance":{"default":"dark"},"background":{"image":"https://mintcdn.com/orderly-network-staging/eQ3a3CD-iQx6FVnc/images/sdks/color-bg.png?fit=max\u0026auto=format\u0026n=eQ3a3CD-iQx6FVnc\u0026q=85\u0026s=750890d7f41071674e77b8c1b06a20ff"},"navbar":{"links":[{"href":"https://linktr.ee/orderlynetwork","label":"Socials"}]},"footer":{"socials":{"twitter":"https://twitter.com/OrderlyNetwork","linkedin":"https://www.linkedin.com/company/orderly-network","discord":"https://discord.gg/orderlynetwork","medium":"https://medium.com/@orderlynetwork"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orderly-network-staging","hasAudioNarration":false,"actualSubdomain":"orderly-network-staging","customDomains":["staging-docs.orderly.network"],"gitSource":{"type":"github","owner":"orderlynetwork","repo":"documentation","deployBranch":"staging","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf61a5808b7de58451a40c","collectionId":"1d393afa-41b2-4c92-b1c7-1f98cd2dc3e6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf61a5808b7de58451a40c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adf61a5808b7de58451a40c","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Build on Omnichain","count":348},{"language":"default","tag":"SDKs","count":209},{"language":"default","tag":"Autogenerated technical reference","count":131},{"language":"default","tag":"Builder API","count":83},{"language":"default","tag":"Interfaces","count":72},{"language":"default","tag":"[evm] react hooks SDK","count":62},{"language":"default","tag":"Trading API","count":50},{"language":"default","tag":"Introduction","count":46},{"language":"default","tag":"User API","count":41},{"language":"default","tag":"Websocket API","count":38}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"iframe.preview{width:100%;min-height:500px}#sidebar-content button[aria-expanded]{align-items:center!important}#sidebar-content button[aria-expanded] svg{align-self:center}.omnichain-release-notes-marker~h2{margin:2.5rem 0 .9rem;padding-bottom:0;border-bottom:0;font-size:clamp(1.4rem,1.1rem + 1vw,2rem);letter-spacing:-.02em}.omnichain-release-notes-marker~h2+div{display:grid!important;gap:.75rem;padding:1.1rem 1.15rem;border:1px solid rgba(150,150,170,.18);border-radius:18px;background:linear-gradient(180deg,rgba(255,255,255,.02),rgba(255,255,255,.04));box-shadow:0 1px 0 rgba(255,255,255,.02) inset}.omnichain-release-notes-marker~h2+div>div{display:block!important;width:100%!important;padding-top:1rem;border-top:1px solid rgba(150,150,170,.12)}.omnichain-release-notes-marker~h2+div>div:first-child{padding-top:0;border-top:0}.omnichain-release-notes-marker~h2+div>div>div:first-child{float:none!important;display:inline-flex!important;width:auto!important;min-width:0;margin:0;margin-bottom:.55rem}.omnichain-release-notes-marker~h2+div>div>div:first-child p{margin:0}.omnichain-release-notes-marker~h2+div>div>div:first-child span[data-as=p]{background:0 0!important}.omnichain-release-notes-marker~h2+div .orderly-chip-times{background:rgba(202,148,0,.14)!important;color:#f2d17a!important;border:0!important}html:not(.dark) .omnichain-release-notes-marker~h2+div .orderly-chip-times{background:rgba(202,148,0,.12)!important;color:#8a6400!important}.omnichain-release-notes-marker~h2+div>div>div:last-child{float:none!important;display:block!important;width:auto!important;min-width:0;padding-left:0!important;margin-left:0!important}.omnichain-release-notes-marker~h2+div>div>div:last-child>p{margin:0}.omnichain-release-notes-marker~h2+div>div>div:last-child>span[data-as=p]{display:block;margin-top:0;font-size:.95rem;line-height:1.45}.omnichain-release-notes-marker~h2+div>div>div:last-child>span[data-as=p]:first-child strong{display:block;font-weight:600}.omnichain-release-notes-marker~h2+div>div>div:last-child>span[data-as=p]:nth-child(2){margin-top:.25rem;font-size:1rem;font-weight:600}.omnichain-release-notes-marker~h2+div>div>div:last-child ul{margin:.35rem 0 0;padding-left:1.2rem}.omnichain-release-notes-marker~h2+div>div>div:last-child li{margin:.2rem 0;line-height:1.6}@media (max-width:720px){.omnichain-release-notes-marker~h2+div{padding:.95rem .9rem}.omnichain-release-notes-marker~h2+div>div>div:first-child{width:auto!important;min-width:0}}.sdk-overview-cards .card{height:auto!important;margin-bottom:1.25rem!important}.sdk-overview-cards .card.block{display:flex;flex-direction:column}@media screen and (max-width:768px){.sdk-overview-cards .card{margin-bottom:1rem!important}}@media screen and (min-width:1024px){.container{display:flex}.left{width:30%}.right{width:70%}.card{position:relative;height:fit-content;border:1px solid #2a1f3a;padding:16px;border-radius:8px;transition:border .3s ease-in-out;background-color:#16132b;margin-bottom:10px}.gold,.silver{position:absolute;top:8px;left:8px;z-index:10}.card a img,.card img{pointer-events:none;cursor:default}.card:hover{border-color:gold}.card .gold,.card .silver{left:8px;color:#2a1f3a;border-radius:8px;font-size:12px;padding:.5px 5px;font-weight:700;transition:border .3s ease-in-out}.card .gold{position:absolute;top:8px;background:linear-gradient(135deg,#856220,#f4e683,#bf923d,#f1ea82,#4e341b);display:none}.card:hover .bronze,.card:hover .gold,.card:hover .link,.card:hover .silver{display:block}.card .silver{background:linear-gradient(135deg,#856220,#c9c9c9,#7d7d7d,#a5a5a5)}.card .bronze,.card .link,.card .silver{position:absolute;top:8px;display:none}.card .bronze{left:8px;background:linear-gradient(135deg,#856220,#f6cba2,#9d6939,#e9a363);color:#2a1f3a;border-radius:8px;font-size:12px;padding:.5px 5px;font-weight:700;transition:border .3s ease-in-out}.card .link{right:8px;width:20px;height:20px}.content-before{height:100px;display:flex;align-items:center;justify-content:center}.coin98_logo,.logo{height:85px;object-fit:contain}.coin98_logo{margin-left:0}.content-before:hover{cursor:pointer}.search-builders-input{height:10px;width:95%}.search-builders-tier{height:100px;width:95%}.search-builders-tier-btn{background:#16132b;padding:15px;border-radius:10px;display:flex;flex-direction:column;gap:10px;width:95%;height:180px}.filter-header{display:flex;justify-content:space-between;align-items:center;font-weight:700}.reset-btn{background:0 0;color:#a0a0a0;border:1px solid #a0a0a0;padding:5px 10px;border-radius:10px;cursor:pointer;font-size:12px}.reset-btn:hover{color:#fff;border-color:#fff}.filter-item{display:flex;justify-content:space-between;align-items:center;font-size:14px;height:30px}.switch,.tier-icon{display:inline-block}.tier-icon{width:12px;height:12px;border-radius:3px;margin-right:10px}.switch{position:relative;width:34px;height:20px}.switch input{opacity:0;width:0;height:0}.slider,.slider:before{position:absolute;transition:.3s}.slider{cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#555;border-radius:20px}.slider:before{content:\"\";height:14px;width:14px;left:3px;bottom:3px;background-color:#bababa;border-radius:50%}input:checked+.slider{background-color:#b084e9}input:checked+.slider:before{transform:translateX(14px)}.search-builders-network{background:#16132b;padding:15px;border-radius:10px;display:flex;flex-direction:column;gap:10px;width:95%;height:540px}.network-icon{width:18px;height:18px;border-radius:3px;display:inline-block;margin-right:10px}}:root{--home-text-muted:rgb(148, 163, 184);--home-border:rgba(148, 163, 184, 0.15);--home-hero-bg:linear-gradient(\n 135deg,\n rgba(170, 92, 248, 0.06) 0%,\n rgba(170, 92, 248, 0.14) 100%\n );--home-hero-shadow:0 20px 45px rgba(0, 0, 0, 0.2)}:root:not(.dark){--home-text-muted:rgb(100, 116, 139);--home-border:rgba(148, 163, 184, 0.22);--home-hero-bg:linear-gradient(135deg, rgba(15, 23, 42, 0.04) 0%, rgba(170, 92, 248, 0.08) 100%);--home-hero-shadow:0 20px 45px rgba(15, 23, 42, 0.08)}html:not(.dark) .card.block{background-color:#fff!important;border-color:rgba(148,163,184,.25)!important}html:not(.dark) .card.block:hover{border-color:#aa5cf8!important}@media screen and (max-width:768px){.card,.container{display:flex;flex-direction:column}.container{gap:10px}.card{position:relative;border:1px solid #2a1f3a;padding:16px;border-radius:12px;background-color:#16132b;margin-bottom:12px;box-shadow:0 4px 8px rgba(0,0,0,.15);align-items:center;transition:transform .2s ease}.card:active{transform:scale(.98)}.card .bronze,.card .gold,.card .silver{position:absolute;top:8px;left:8px;border-radius:8px;font-size:12px;padding:2px 6px;font-weight:700;color:#2a1f3a}.gold{background:linear-gradient(135deg,#856220,#f4e683,#bf923d,#f1ea82,#4e341b)}.silver{background:linear-gradient(135deg,#856220,#c9c9c9,#7d7d7d,#a5a5a5)}.bronze{background:linear-gradient(135deg,#856220,#f6cba2,#9d6939,#e9a363)}.card .link{position:absolute;top:8px;right:8px;width:20px;height:20px;display:block}.card a img,.card img{pointer-events:none;cursor:default}.content-before{display:flex;justify-content:center;align-items:center;width:100%;min-height:80px}.coin98_logo,.logo{max-height:65px;min-height:40px;max-width:100%;object-fit:contain}.search-builders-input,.search-builders-network,.search-builders-tier{width:100%;border-radius:8px}.search-builders-tier-btn{background:#16132b;padding:15px;border-radius:10px;display:flex;flex-direction:column;gap:10px;width:100%;height:auto}.filter-item{font-size:14px;padding:5px 0}}"}],"page":{"pagePath":"build-on-omnichain/websocket-api/error-response","slug":"/build-on-omnichain/websocket-api/error-response","pageMetadata":{"title":"Error Response","description":"Format and example of WebSocket error responses, including the client ID mapping pattern.","href":"/build-on-omnichain/websocket-api/error-response"},"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: \"Format and example of WebSocket error responses, including the client ID mapping pattern.\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Error responses follow the same format as successful responses, with `,_jsx(_components.code,{children:`success`}),` set to `,_jsx(_components.code,{children:`false`}),` and an `,_jsx(_components.code,{children:`errorMsg`}),` field explaining the issue. You can use the `,_jsx(_components.code,{children:`id`}),` field to map the error response with the corresponding request.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"clientID7\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"subscribe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1614141150601`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorMsg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invalid symbol PERP_BTC_USDC\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`common-error-messages`,children:`Common error messages`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Error message`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid symbol \u003csymbol>`})}),_jsx(_components.td,{children:`The requested symbol does not exist`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid topic \u003ctopic>`})}),_jsx(_components.td,{children:`The requested topic is not supported`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`auth failed`})}),_jsx(_components.td,{children:`Authentication failed due to invalid credentials`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`missing required parameter \u003cparam>`})}),_jsx(_components.td,{children:`A required parameter is missing`})]})]})]})]})}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":"Error Response","description":"Format and example of WebSocket error responses, including the client ID mapping pattern.","href":"/build-on-omnichain/websocket-api/error-response"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Common error messages","slug":"common-error-messages","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orderly-network-staging","siteName":"Orderly","title":"Error Response - Orderly","navMaps":{"firstHrefInVersion":{"latest":{"href":"/build-on-omnichain/websocket-api/error-response","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-03-23T01:47:28.334Z","originalFileLocation":"build-on-omnichain/websocket-api/error-response.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=\"dark\"}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=\"Format and example of WebSocket error responses, including the client ID mapping pattern.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orderly\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_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/orderly-network-staging/XHlLD0IGik6x_eVv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Error Response - Orderly\">\u003cmeta data-mint-head property=\"og:description\" content=\"Format and example of WebSocket error responses, including the client ID mapping pattern.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orderly\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orderly-network-staging.mintlify.app/_mintlify/api/og/v2?division=Websocket+API\u0026amp;title=Error+Response\u0026amp;description=Format+and+example+of+WebSocket+error+responses%2C+including+the+client+ID+mapping+pattern.\u0026amp;theme=ccdcad4c7ba74ae6dad1d78c\u0026amp;signature=2b3edffad5ae277748839af725f8d6ff8fb763eb60e82e21eadf09afbe620f2c\">\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=\"Error Response - Orderly\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Format and example of WebSocket error responses, including the client ID mapping pattern.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orderly-network-staging.mintlify.app/_mintlify/api/og/v2?division=Websocket+API\u0026amp;title=Error+Response\u0026amp;description=Format+and+example+of+WebSocket+error+responses%2C+including+the+client+ID+mapping+pattern.\u0026amp;theme=ccdcad4c7ba74ae6dad1d78c\u0026amp;signature=2b3edffad5ae277748839af725f8d6ff8fb763eb60e82e21eadf09afbe620f2c\">\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/orderly-network-staging/XHlLD0IGik6x_eVv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orderly\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#aa5cf8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/build-on-omnichain/websocket-api/error-response.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://staging-docs.orderly.network/#organization\",\"name\":\"Orderly\",\"url\":\"https://staging-docs.orderly.network\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orderly-network-staging/GoLgfYba1CLV7Hn-/logo/light.svg?fit=max\u0026auto=format\u0026n=GoLgfYba1CLV7Hn-\u0026q=85\u0026s=a284c772cd7a2d9d12e66558986910ba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://staging-docs.orderly.network#website\",\"name\":\"Orderly\",\"url\":\"https://staging-docs.orderly.network\",\"publisher\":{\"@id\":\"https://staging-docs.orderly.network/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response#webpage\",\"url\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response\",\"name\":\"Error Response\",\"description\":\"Format and example of WebSocket error responses, including the client ID mapping pattern.\",\"dateModified\":\"2026-03-23T01:47:28.334Z\",\"isPartOf\":{\"@id\":\"https://staging-docs.orderly.network#website\"},\"breadcrumb\":{\"@id\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Websocket API\",\"item\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Error Response\",\"item\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response#article\",\"headline\":\"Error Response\",\"name\":\"Error Response\",\"description\":\"Format and example of WebSocket error responses, including the client ID mapping pattern.\",\"url\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response\",\"mainEntityOfPage\":{\"@id\":\"https://staging-docs.orderly.network/build-on-omnichain/websocket-api/error-response#webpage\"},\"dateModified\":\"2026-03-23T01:47:28.334Z\",\"publisher\":{\"@id\":\"https://staging-docs.orderly.network/#organization\"},\"isPartOf\":{\"@id\":\"https://staging-docs.orderly.network#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orderly\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Orderly","nav":{"global":null,"versions":[{"version":"latest","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Introduction","pages":[{"title":"Introduction","href":"/introduction/getting-started/what-is-orderly"}]},{"tab":"Build on Omnichain","groups":[{"group":"Builder quickstart","pages":[{"title":"Building on Orderly","href":"/build-on-omnichain/building-on-omnichain"},{"title":"Smart Contract Overview","href":"/build-on-omnichain/overview"},{"title":"Smart Contract Addresses","href":"/build-on-omnichain/addresses"},{"title":"Integration Checklist","href":"/build-on-omnichain/integration-checklist"},{"title":"Agent CLI (`orderly`)","href":"/build-on-omnichain/agent-cli"}]},{"group":"Partner onboarding \u0026 support","pages":[{"title":"Partner Support","href":"/build-on-omnichain/partner-support"},{"title":"Integration FAQs","href":"/build-on-omnichain/integration-faqs"}]},{"group":"Core integration flows","pages":[{"title":"Accounts","href":"/build-on-omnichain/user-flows/accounts"},{"title":"Wallet Authentication","href":"/build-on-omnichain/user-flows/wallet-authentication"},{"title":"Deposit/Withdrawal","href":"/build-on-omnichain/user-flows/withdrawal-deposit"},{"title":"Exclusive Receiver Address","href":"/build-on-omnichain/user-flows/deposit-by-transfer"},{"title":"Settle PnL","href":"/build-on-omnichain/user-flows/settle-pnl"},{"title":"Order Management","href":"/build-on-omnichain/user-flows/order-management"},{"title":"Isolated Margin","href":"/build-on-omnichain/user-flows/isolated-margin"},{"title":"Custom Fee Structure","href":"/build-on-omnichain/user-flows/custom-fees"},{"title":"Custom Trading Fee Per Order","href":"/build-on-omnichain/user-flows/order-enum-integration-guide"},{"title":"Delegate Signer","href":"/build-on-omnichain/user-flows/delegate-signer"},{"title":"Algo Order Sample Requests","href":"/build-on-omnichain/user-flows/algo-order-samples"},{"title":"Internal Transfer","href":"/build-on-omnichain/user-flows/internal-transfer"},{"title":"User Flow Walkthrough","href":"/build-on-omnichain/user-flow-walkthrough"}]},{"group":"Perp Anything","pages":[{"title":"Introduction","href":"/build-on-omnichain/perp-anything/introduction"},{"title":"Market Operations","href":"/build-on-omnichain/perp-anything/market-operations"},{"title":"Builder Oracle","href":"/build-on-omnichain/user-flows/builder-oracle"},{"title":"RWA Markets","href":"/build-on-omnichain/perp-anything/rwa-markets"},{"title":"Pre-TGE Listing","href":"/build-on-omnichain/perp-anything/pre-tge-listing"}]},{"group":"Orderly Predict","pages":[{"title":"Introduction","href":"/build-on-omnichain/orderly-predict/introduction"},{"title":"Market Data","href":"/build-on-omnichain/orderly-predict/market-data"},{"title":"Order Management","href":"/build-on-omnichain/orderly-predict/order-management"},{"title":"Positions and Settlement","href":"/build-on-omnichain/orderly-predict/positions-and-settlement"}]},{"group":"Builders Marketplace","pages":[{"title":"Introduction","href":"/build-on-omnichain/builder-marketplace/introduction"},{"group":"Plugin Developer Handbook","pages":[{"title":"Orderly Plugin Developer Handbook","href":"/build-on-omnichain/builder-marketplace/plugin-developer-handbook"},{"title":"Getting started","href":"/build-on-omnichain/builder-marketplace/getting-started"},{"title":"Skills-first workflow (recommended)","href":"/build-on-omnichain/builder-marketplace/skills-first"},{"group":"Tutorials","pages":[{"title":"Tutorial 1: First plugin from the template","href":"/build-on-omnichain/builder-marketplace/first-plugin"},{"title":"Tutorial 2: Integrate a plugin into the host app","href":"/build-on-omnichain/builder-marketplace/integrate-host"},{"title":"Tutorial 3: Submit a plugin to the Orderly Builders Marketplace","href":"/build-on-omnichain/builder-marketplace/marketplace-submission"},{"title":"Tutorial 4: One plugin, multiple interceptor targets","href":"/build-on-omnichain/builder-marketplace/multi-interceptor-targets"}]},{"group":"How-to guides","pages":[{"title":"How to choose a plugin type: Widget, Page, or Layout","href":"/build-on-omnichain/builder-marketplace/plugin-types"},{"title":"How to implement interceptor strategies","href":"/build-on-omnichain/builder-marketplace/interceptor-strategies"},{"title":"How to wire plugin packages in a host (workspace, path, npm)","href":"/build-on-omnichain/builder-marketplace/host-integration-patterns"},{"title":"How to write `usagePrompt` and the GitHub README","href":"/build-on-omnichain/builder-marketplace/usage-prompt-and-readme"}]},{"group":"Reference","pages":[{"title":"CLI reference (`orderly-devkit`)","href":"/build-on-omnichain/builder-marketplace/cli-reference"},{"title":"Interceptor targets: runtime vs CLI template","href":"/build-on-omnichain/builder-marketplace/interceptors"},{"title":"Runtime injector targets (handbook reference)","href":"/build-on-omnichain/builder-marketplace/runtime-injector-targets"},{"title":"Manifest and Builders Marketplace submit","href":"/build-on-omnichain/builder-marketplace/manifest-and-submit"},{"title":"Orderly SDK Docs MCP (`orderly-sdk-docs`)","href":"/build-on-omnichain/builder-marketplace/mcp-sdk-docs"},{"title":"Agent skills and upstream documentation alignment","href":"/build-on-omnichain/builder-marketplace/agent-skills-alignment"}]},{"group":"Recipes","pages":[{"title":"Recipe: Quick start checklist","href":"/build-on-omnichain/builder-marketplace/quickstart-recipe"},{"title":"Recipe: Marketplace submit checklist","href":"/build-on-omnichain/builder-marketplace/marketplace-submit-recipe"}]}]}]},{"group":"API fundamentals","pages":[{"title":"Introduction","href":"/build-on-omnichain/introduction"},{"title":"API Authentication","href":"/build-on-omnichain/api-authentication"},{"title":"Error Codes","href":"/build-on-omnichain/error-codes"}]},{"group":"Public Info API","pages":[{"title":"Introduction","href":"/build-on-omnichain/public-info-api/overview"},{"group":"Market data","pages":[{"title":"Candles","href":"/build-on-omnichain/public-info-api/market/candles"},{"title":"Funding comparison","href":"/build-on-omnichain/public-info-api/market/funding-comparison"},{"title":"Funding rate history","href":"/build-on-omnichain/public-info-api/market/funding-rate-history"},{"title":"Liquidations","href":"/build-on-omnichain/public-info-api/market/liquidations"},{"title":"Market detail","href":"/build-on-omnichain/public-info-api/market/market-detail"},{"title":"Market summary","href":"/build-on-omnichain/public-info-api/market/market-summary"},{"title":"Market trades","href":"/build-on-omnichain/public-info-api/market/market-trades"},{"title":"Orderbook","href":"/build-on-omnichain/public-info-api/market/orderbook"}]},{"group":"Account data","pages":[{"title":"Account state","href":"/build-on-omnichain/public-info-api/account/account-state"},{"title":"Accounts","href":"/build-on-omnichain/public-info-api/account/accounts"},{"title":"Agent context","href":"/build-on-omnichain/public-info-api/account/agent-context"},{"title":"Fee rate","href":"/build-on-omnichain/public-info-api/account/fee-rate"},{"title":"Funding payments","href":"/build-on-omnichain/public-info-api/account/funding-payments"},{"title":"Historical orders","href":"/build-on-omnichain/public-info-api/account/historical-orders"},{"title":"Open orders","href":"/build-on-omnichain/public-info-api/account/open-orders"},{"title":"Order status","href":"/build-on-omnichain/public-info-api/account/order-status"},{"title":"Portfolio","href":"/build-on-omnichain/public-info-api/account/portfolio"},{"title":"Position context","href":"/build-on-omnichain/public-info-api/account/position-context"},{"title":"Trades","href":"/build-on-omnichain/public-info-api/account/trades"},{"title":"Deposits and withdrawals","href":"/build-on-omnichain/public-info-api/account/user-deposits-withdrawals"},{"title":"Whale context","href":"/build-on-omnichain/public-info-api/account/whale-context"}]},{"group":"Platform data","pages":[{"title":"Platform positions","href":"/build-on-omnichain/public-info-api/platform/platform-positions"},{"title":"Top addresses","href":"/build-on-omnichain/public-info-api/platform/top-addresses"}]}]},{"group":"General API","pages":[{"group":"Builder info","pages":[{"openapi":"orderly.openapi get /v1/public/volume/stats","title":"Get builder volume","href":"/build-on-omnichain/restful-api/public/get-builder-volume"},{"openapi":"orderly.openapi get /md/volume/builder/daily_stats","title":"Get builder daily volume","href":"/build-on-omnichain/restful-api/public/get-builder-daily-volume"},{"openapi":"orderly.openapi get /v1/public/broker/daily_fee_revenue","title":"Get builder daily revenue settlement history (public)","href":"/build-on-omnichain/restful-api/public/get-builder-daily-revenue-settlement-history-public"},{"openapi":"orderly.openapi get /orderly/api/v1/data/convert_volume","title":"Get daily conversion volume","href":"/build-on-omnichain/restful-api/public/get-daily-conversion-volume"},{"openapi":"orderly.openapi get /orderly/api/v1/data/convert_volume/historical","title":"Get historical conversion volume","href":"/build-on-omnichain/restful-api/public/get-historical-conversion-volume"},{"openapi":"orderly.openapi get /v1/public/broker/name","title":"Get builder list","href":"/build-on-omnichain/restful-api/public/get-builder-list"},{"openapi":"orderly.openapi get /v1/public/broker/stats","title":"Get builder stats","href":"/build-on-omnichain/restful-api/public/get-builder-stats"},{"openapi":"orderly.openapi get /v1/public/chain_info","title":"Get supported chains per builder","href":"/build-on-omnichain/restful-api/public/get-supported-chains-per-builder"},{"openapi":"orderly.openapi get /v1/public/futures_market","title":"Get market volume by builder","href":"/build-on-omnichain/restful-api/public/get-market-volume-by-builder"},{"openapi":"orderly.openapi get /v1/public/balance/stats","title":"Get TVL by builder","href":"/build-on-omnichain/restful-api/public/get-tvl-by-builder"}]},{"group":"System info","pages":[{"openapi":"orderly.openapi get /v1/public/system_info","title":"Get system maintenance status","href":"/build-on-omnichain/restful-api/public/get-system-maintenance-status"},{"openapi":"orderly.openapi get /v1/public/vault_balance","title":"Get vault balance","href":"/build-on-omnichain/restful-api/public/get-vault-balance"},{"openapi":"orderly.openapi get /v1/public/insurancefund","title":"Get insurance fund info","href":"/build-on-omnichain/restful-api/public/get-insurance-fund-info"},{"title":"Get announcements (Legacy)","openapi":"orderly.openapi get /v1/public/announcement","href":"/build-on-omnichain/restful-api/public/get-announcements"},{"openapi":"orderly.openapi get /v2/public/announcement","title":"Get announcements (v2)","href":"/build-on-omnichain/restful-api/public/get-announcements-v2"},{"openapi":"orderly.openapi get /v1/ip_info","title":"Get IP info","href":"/build-on-omnichain/restful-api/public/get-ip-info"},{"openapi":"orderly.openapi get /v1/product_restricted_areas","title":"Get restricted areas by product","href":"/build-on-omnichain/restful-api/public/get-restricted-areas-by-product"}]},{"group":"USDC faucet","pages":[{"openapi":"orderly.openapi post /v1/faucet/usdc","title":"Get faucet usdc(testnet only)","href":"/build-on-omnichain/restful-api/public/get-faucet-usdctestnet-only"}]}]},{"group":"User API","pages":[{"group":"Registration","pages":[{"openapi":"orderly.openapi get /v1/public/account","title":"Check if account exists","href":"/build-on-omnichain/restful-api/public/check-if-account-exists"},{"openapi":"orderly.openapi get /v1/get_account","title":"Check if wallet is registered","href":"/build-on-omnichain/restful-api/public/check-if-wallet-is-registered"},{"openapi":"orderly.openapi get /v1/get_broker","title":"Check if address is registered","href":"/build-on-omnichain/restful-api/public/check-if-address-is-registered"},{"openapi":"orderly.openapi get /v1/registration_nonce","title":"Get registration nonce","href":"/build-on-omnichain/restful-api/public/get-registration-nonce"},{"openapi":"orderly.openapi post /v1/register_account","title":"Register account","href":"/build-on-omnichain/restful-api/public/register-account"}]},{"group":"Key management","pages":[{"openapi":"orderly.openapi get /v1/get_orderly_key","title":"Get Orderly key","href":"/build-on-omnichain/restful-api/public/get-orderly-key"},{"openapi":"orderly.openapi post /v1/orderly_key","title":"Add Orderly key","href":"/build-on-omnichain/restful-api/public/add-orderly-key"},{"openapi":"orderly.openapi post /v1/client/remove_orderly_key","title":"Remove Orderly key","href":"/build-on-omnichain/restful-api/private/remove-orderly-key"},{"openapi":"orderly.openapi get /v1/client/key_info","title":"Get current Orderly key info","href":"/build-on-omnichain/restful-api/private/get-current-orderly-key-info"},{"openapi":"orderly.openapi get /v1/client/orderly_key_ip_restriction","title":"Get Orderly key IP restriction","href":"/build-on-omnichain/restful-api/private/get-orderly-key-ip-restriction"},{"openapi":"orderly.openapi post /v1/client/set_orderly_key_ip_restriction","title":"Set Orderly key IP restriction","href":"/build-on-omnichain/restful-api/private/set-orderly-key-ip-restriction"},{"openapi":"orderly.openapi post /v1/client/reset_orderly_key_ip_restriction","title":"Reset Orderly key IP restriction","href":"/build-on-omnichain/restful-api/private/reset-orderly-key-ip-restriction"}]},{"group":"Account/user info","pages":[{"openapi":"orderly.openapi get /v1/volume/user/daily","title":"Get user daily volume","href":"/build-on-omnichain/restful-api/private/get-user-daily-volume"},{"openapi":"orderly.openapi get /v1/volume/user/stats","title":"Get user volume statistics","href":"/build-on-omnichain/restful-api/private/get-user-volume-statistics"},{"openapi":"orderly.openapi get /v1/client/statistics","title":"Get user statistics","href":"/build-on-omnichain/restful-api/private/get-user-statistics"},{"openapi":"orderly.openapi get /v1/account_info","title":"Get account overview info","href":"/build-on-omnichain/restful-api/private/get-account-overview-info"},{"openapi":"orderly.openapi get /v1/client/info","title":"Get account information","href":"/build-on-omnichain/restful-api/private/get-account-information"},{"openapi":"orderly.openapi get /v1/client/statistics/daily","title":"Get user daily statistics","href":"/build-on-omnichain/restful-api/private/get-user-daily-statistics"}]},{"group":"Account notifications","pages":[{"openapi":"orderly.openapi get /v1/notification/inbox/notifications","title":"Get all notifications","href":"/build-on-omnichain/restful-api/private/get-all-notifications"},{"openapi":"orderly.openapi get /v1/notification/inbox/unread","title":"Get unread notifications","href":"/build-on-omnichain/restful-api/private/get-unread-notifications"},{"openapi":"orderly.openapi post /v1/notification/inbox/mark_read","title":"Set read status of notifications","href":"/build-on-omnichain/restful-api/private/set-read-status-of-notifications"},{"openapi":"orderly.openapi post /v1/notification/inbox/mark_read_all","title":"Set read status of all notifications","href":"/build-on-omnichain/restful-api/private/set-read-status-of-all-notifications"}]},{"group":"Account config","pages":[{"openapi":"orderly.openapi get /v1/client/leverage","title":"Get leverage setting","href":"/build-on-omnichain/restful-api/private/get-leverage-setting"},{"openapi":"orderly.openapi get /v1/client/leverages","title":"Get all leverage settings","href":"/build-on-omnichain/restful-api/private/get-all-leverage-settings"},{"openapi":"orderly.openapi post /v1/client/leverages","title":"Update leverage setting","href":"/build-on-omnichain/restful-api/private/update-leverage-setting"},{"openapi":"orderly.openapi get /v1/client/margin_modes","title":"Get margin modes","href":"/build-on-omnichain/restful-api/private/get-margin-modes"},{"openapi":"orderly.openapi post /v1/client/margin_mode","title":"Update margin mode","href":"/build-on-omnichain/restful-api/private/update-margin-mode"},{"openapi":"orderly.openapi post /v1/position_margin","title":"Add or reduce position margin","href":"/build-on-omnichain/restful-api/private/add-or-reduce-position-margin"},{"openapi":"orderly.openapi get /v1/public/leverage","title":"Get max leverage setting","href":"/build-on-omnichain/restful-api/public/get-max-leverage-setting"},{"openapi":"orderly.openapi get /v1/public/config","title":"Get leverage configuration","href":"/build-on-omnichain/restful-api/public/get-leverage-configuration"},{"openapi":"orderly.openapi post /v1/client/maintenance_config","title":"Configure auto-cancel during maintenance","href":"/build-on-omnichain/restful-api/private/configure-auto-cancel-during-maintenance"}]},{"group":"Delegate signer","pages":[{"openapi":"orderly.openapi post /v1/delegate_signer","title":"Delegate signer","href":"/build-on-omnichain/restful-api/public/delegate-signer"},{"openapi":"orderly.openapi post /v1/delegate_orderly_key","title":"Add delegate signer Orderly key","href":"/build-on-omnichain/restful-api/public/add-delegate-signer-orderly-key"},{"openapi":"orderly.openapi post /v1/delegate_settle_pnl","title":"Delegate signer settle PnL","href":"/build-on-omnichain/restful-api/private/delegate-signer-settle-pnl"},{"openapi":"orderly.openapi post /v1/delegate_withdraw_request","title":"Delegate signer withdraw request","href":"/build-on-omnichain/restful-api/private/delegate-signer-withdraw-request"}]},{"group":"Sub-account","pages":[{"openapi":"orderly.openapi post /v1/client/add_sub_account","title":"Add sub account","href":"/build-on-omnichain/restful-api/private/add-sub-account"},{"openapi":"orderly.openapi get /v1/client/sub_account","title":"Get sub account list","href":"/build-on-omnichain/restful-api/private/get-sub-account-list"},{"openapi":"orderly.openapi post /v1/client/update_sub_account","title":"Update sub account","href":"/build-on-omnichain/restful-api/private/update-sub-account"},{"openapi":"orderly.openapi get /v1/client/aggregate/positions","title":"Get aggregate positions","href":"/build-on-omnichain/restful-api/private/get-aggregate-positions"},{"openapi":"orderly.openapi get /v1/client/aggregate/holding","title":"Get aggregate holding","href":"/build-on-omnichain/restful-api/private/get-aggregate-holding"},{"openapi":"orderly.openapi post /v1/sub_account_settle_pnl","title":"Settle sub account PnL","href":"/build-on-omnichain/restful-api/private/settle-sub-account-pnl"}]}]},{"group":"Trading API","pages":[{"group":"Order management","pages":[{"openapi":"orderly.openapi post /v1/order","title":"Create order","href":"/build-on-omnichain/restful-api/private/create-order"},{"openapi":"orderly.openapi post /v1/batch-order","title":"Batch create order","href":"/build-on-omnichain/restful-api/private/batch-create-order"},{"openapi":"orderly.openapi post /v1/algo/order","title":"Create algo order","href":"/build-on-omnichain/restful-api/private/create-algo-order"},{"openapi":"orderly.openapi put /v1/order","title":"Edit order","href":"/build-on-omnichain/restful-api/private/edit-order"},{"openapi":"orderly.openapi put /v1/algo/order","title":"Edit algo order","href":"/build-on-omnichain/restful-api/private/edit-algo-order"},{"openapi":"orderly.openapi delete /v1/order","title":"Cancel order","href":"/build-on-omnichain/restful-api/private/cancel-order"},{"openapi":"orderly.openapi delete /v1/algo/order","title":"Cancel algo order","href":"/build-on-omnichain/restful-api/private/cancel-algo-order"},{"openapi":"orderly.openapi delete /v1/client/order","title":"Cancel order by client_order_id","href":"/build-on-omnichain/restful-api/private/cancel-order-by-client_order_id"},{"openapi":"orderly.openapi delete /v1/algo/client/order","title":"Cancel algo order by client_order_id","href":"/build-on-omnichain/restful-api/private/cancel-algo-order-by-client_order_id"},{"openapi":"orderly.openapi delete /v1/algo/orders","title":"Cancel all pending algo orders","href":"/build-on-omnichain/restful-api/private/cancel-all-pending-algo-orders"},{"openapi":"orderly.openapi delete /v1/orders","title":"Cancel all pending orders","href":"/build-on-omnichain/restful-api/private/cancel-all-pending-orders"},{"openapi":"orderly.openapi post /v1/order/cancel_all_after","title":"Cancel all after","href":"/build-on-omnichain/restful-api/private/cancel-all-after"},{"openapi":"orderly.openapi delete /v1/batch-order","title":"Batch cancel orders","href":"/build-on-omnichain/restful-api/private/batch-cancel-orders"},{"openapi":"orderly.openapi delete /v1/client/batch-order","title":"Batch cancel orders by client_order_id","href":"/build-on-omnichain/restful-api/private/batch-cancel-orders-by-client_order_id"},{"openapi":"orderly.openapi get /v1/order/{order_id}","title":"Get order by order_id","href":"/build-on-omnichain/restful-api/private/get-order-by-order_id"},{"openapi":"orderly.openapi get /v1/client/order/{client_order_id}","title":"Get order by client_order_id","href":"/build-on-omnichain/restful-api/private/get-order-by-client_order_id"},{"openapi":"orderly.openapi get /v1/algo/order/{order_id}","title":"Get algo order by order_id","href":"/build-on-omnichain/restful-api/private/get-algo-order-by-order_id"},{"openapi":"orderly.openapi get /v1/algo/client/order/{client_order_id}","title":"Get algo order by client_order_id","href":"/build-on-omnichain/restful-api/private/get-algo-order-by-client_order_id"},{"openapi":"orderly.openapi get /v1/orders","title":"Get orders","href":"/build-on-omnichain/restful-api/private/get-orders"},{"openapi":"orderly.openapi get /v1/algo/orders","title":"Get algo orders","href":"/build-on-omnichain/restful-api/private/get-algo-orders"},{"openapi":"orderly.openapi get /v1/trades","title":"Get trades","href":"/build-on-omnichain/restful-api/private/get-trades"},{"openapi":"orderly.openapi get /v1/trade/{trade_id}","title":"Get trade","href":"/build-on-omnichain/restful-api/private/get-trade"},{"openapi":"orderly.openapi get /v1/order/{order_id}/trades","title":"Get all trades of specific order","href":"/build-on-omnichain/restful-api/private/get-all-trades-of-specific-order"},{"openapi":"orderly.openapi get /v1/algo/order/{order_id}/trades","title":"Get all trades of specific algo order","href":"/build-on-omnichain/restful-api/private/get-all-trades-of-specific-algo-order"},{"openapi":"orderly.openapi get /v1/public/broker/order_enums","title":"List order tags for a broker","href":"/build-on-omnichain/restful-api/public/list-order-tags-for-a-broker"},{"openapi":"orderly.openapi get /v1/public/broker/order_enum","title":"Get one order tag for a broker","href":"/build-on-omnichain/restful-api/public/get-one-order-tag-for-a-broker"}]},{"group":"Liquidations","pages":[{"openapi":"orderly.openapi get /v1/public/liquidation","title":"Get positions under liquidation","href":"/build-on-omnichain/restful-api/public/get-positions-under-liquidation"},{"openapi":"orderly.openapi get /v1/public/liquidated_positions","title":"Get liquidated positions info","href":"/build-on-omnichain/restful-api/public/get-liquidated-positions-info"},{"openapi":"orderly.openapi get /v1/client/liquidator_liquidations","title":"Get liquidated positions by liquidator","href":"/build-on-omnichain/restful-api/private/get-liquidated-positions-by-liquidator"},{"openapi":"orderly.openapi get /v1/liquidations","title":"Get liquidated positions of account","href":"/build-on-omnichain/restful-api/private/get-liquidated-positions-of-account"},{"openapi":"orderly.openapi post /v1/liquidation","title":"Claim liquidated positions","href":"/build-on-omnichain/restful-api/private/claim-liquidated-positions"},{"openapi":"orderly.openapi post /v1/claim_insurance_fund","title":"Claim insurance fund","href":"/build-on-omnichain/restful-api/private/claim-insurance-fund"}]},{"group":"Assets/withdraw/settle PnL","pages":[{"openapi":"orderly.openapi get /v1/asset/history","title":"Get asset history","href":"/build-on-omnichain/restful-api/private/get-asset-history"},{"openapi":"orderly.openapi get /v1/client/holding","title":"Get current holding","href":"/build-on-omnichain/restful-api/private/get-current-holding"},{"openapi":"orderly.openapi get /v1/withdraw_nonce","title":"Get withdrawal nonce","href":"/build-on-omnichain/restful-api/private/get-withdrawal-nonce"},{"openapi":"orderly.openapi post /v1/withdraw_request","title":"Create withdraw request","href":"/build-on-omnichain/restful-api/private/create-withdraw-request"},{"openapi":"orderly.openapi get /v1/settle_nonce","title":"Get settle PnL nonce","href":"/build-on-omnichain/restful-api/private/get-settle-pnl-nonce"},{"openapi":"orderly.openapi post /v1/settle_pnl","title":"Request PnL settlement","href":"/build-on-omnichain/restful-api/private/request-pnl-settlement"},{"openapi":"orderly.openapi get /v1/pnl_settlement/history","title":"Get PnL settlement history","href":"/build-on-omnichain/restful-api/private/get-pnl-settlement-history"},{"openapi":"orderly.openapi post /v1/internal_transfer","title":"Create internal transfer","href":"/build-on-omnichain/restful-api/private/create-internal-transfer"},{"openapi":"orderly.openapi post /v2/internal_transfer","title":"Create internal transfer with wallet signature","href":"/build-on-omnichain/restful-api/private/create-internal-transfer-with-wallet-signature"},{"openapi":"orderly.openapi get /v1/transfer_nonce","title":"Get transfer nonce","href":"/build-on-omnichain/restful-api/private/get-transfer-nonce"},{"openapi":"orderly.openapi get /v1/internal_transfer_history","title":"Get internal transfer history","href":"/build-on-omnichain/restful-api/private/get-internal-transfer-history"},{"openapi":"orderly.openapi get /v1/client/asset/receiver_address","title":"Get receiver address","href":"/build-on-omnichain/restful-api/private/get-receiver-address"},{"openapi":"orderly.openapi get /v1/client/asset/receiver_events","title":"Get receiver events","href":"/build-on-omnichain/restful-api/private/get-receiver-events"}]},{"group":"Positions","pages":[{"openapi":"orderly.openapi get /v1/positions","title":"Get all positions info","href":"/build-on-omnichain/restful-api/private/get-all-positions-info"},{"openapi":"orderly.openapi get /v1/positions_lite","title":"Get lite positions info","href":"/build-on-omnichain/restful-api/private/get-lite-positions-info"},{"openapi":"orderly.openapi get /v1/position/{symbol}","title":"Get one position info","href":"/build-on-omnichain/restful-api/private/get-one-position-info"},{"openapi":"orderly.openapi get /v1/position_history","title":"Get position history","href":"/build-on-omnichain/restful-api/private/get-position-history"}]},{"group":"Funding","pages":[{"openapi":"orderly.openapi get /v1/funding_fee/history","title":"Get funding fee history","href":"/build-on-omnichain/restful-api/private/get-funding-fee-history"}]}]},{"group":"Strategy vault API","pages":[{"group":"Account","pages":[{"openapi":"orderly.openapi get /v1/public/sv_nonce","title":"Get strategy vault nonce for account transaction","href":"/build-on-omnichain/restful-api/public/get-strategy-vault-nonce-for-account-transaction"},{"openapi":"orderly.openapi post /v1/sv_operation_request","title":"Create strategy vault deposit/withdrawal request with account","href":"/build-on-omnichain/restful-api/public/create-strategy-vault-depositwithdrawal-request-with-account"},{"openapi":"orderly.openapi get /v1/account_sv_transaction_history","title":"Get account’s strategy vault transaction history","href":"/build-on-omnichain/restful-api/public/get-account’s-strategy-vault-transaction-history"}]}]},{"group":"Staking \u0026 VALOR API","pages":[{"group":"Staking","pages":[{"openapi":"orderly.openapi get /v1/staking/balance","title":"Get wallet's current staked balance","href":"/build-on-omnichain/restful-api/private/get-wallets-current-staked-balance"},{"openapi":"orderly.openapi get /v1/staking/unstake_details","title":"Get unstaking order details","href":"/build-on-omnichain/restful-api/private/get-unstaking-order-details"},{"openapi":"orderly.openapi get /v1/staking/overview","title":"Get staking overview","href":"/build-on-omnichain/restful-api/public/get-staking-overview"},{"openapi":"orderly.openapi get /v1/staking/esorder/vesting_list","title":"Get esorder vesting list","href":"/build-on-omnichain/restful-api/private/get-esorder-vesting-list"}]},{"group":"VALOR","pages":[{"openapi":"orderly.openapi get /v1/staking/valor/batch_info","title":"Get valor batch info","href":"/build-on-omnichain/restful-api/public/get-valor-batch-info"},{"openapi":"orderly.openapi get /v1/staking/valor/pool_info","title":"Get valor pool info","href":"/build-on-omnichain/restful-api/public/get-valor-pool-info"},{"openapi":"orderly.openapi get /v1/staking/valor/redeem","title":"Get valor redeem info","href":"/build-on-omnichain/restful-api/private/get-valor-redeem-info"},{"openapi":"orderly.openapi get /v1/staking/valor2/pool_info","title":"Get valor2 pool info","href":"/build-on-omnichain/restful-api/public/get-valor2-pool-info"},{"openapi":"orderly.openapi get /v1/staking/valor2/batch_info","title":"Get valor2 batch info","href":"/build-on-omnichain/restful-api/public/get-valor2-batch-info"},{"openapi":"orderly.openapi get /v1/staking/valor2/redeem","title":"Get valor2 redeem info","href":"/build-on-omnichain/restful-api/private/get-valor2-redeem-info"},{"openapi":"orderly.openapi get /v1/staking/valor2/revenue_buyback","title":"Get valor2 revenue buyback","href":"/build-on-omnichain/restful-api/public/get-valor2-revenue-buyback"}]}]},{"group":"Builder API","pages":[{"group":"Blogpost","pages":[{"title":"Blogpost API","href":"/build-on-omnichain/blogpost/overview"},{"title":"Writing and formatting blogposts","href":"/build-on-omnichain/blogpost/markdown-guide"},{"openapi":"orderly.openapi get /api/public/v1/blogposts","title":"List published blogposts","href":"/build-on-omnichain/blogpost/list-published-blogposts"},{"openapi":"orderly.openapi get /api/public/v1/blogposts/{slug}","title":"Get published blogpost","href":"/build-on-omnichain/blogpost/get-published-blogpost"}]},{"group":"User data","pages":[{"openapi":"orderly.openapi get /v1/volume/broker/daily","title":"Get builder's users' volumes","href":"/build-on-omnichain/restful-api/private/get-builders-users-volumes"},{"openapi":"orderly.openapi get /v1/broker/leaderboard/daily","title":"Get builder's leaderboard","href":"/build-on-omnichain/restful-api/private/get-builders-leaderboard"}]},{"group":"Trading campaigns","pages":[{"openapi":"orderly.openapi get /v1/public/campaign/ranking","title":"Get campaign ranking","href":"/build-on-omnichain/restful-api/public/get-campaign-ranking"},{"openapi":"orderly.openapi get /v1/public/campaign/stats","title":"Get campaign statistics","href":"/build-on-omnichain/restful-api/public/get-campaign-statistics"},{"openapi":"orderly.openapi get /v1/public/campaign/user","title":"Get campaign user info","href":"/build-on-omnichain/restful-api/public/get-campaign-user-info"},{"openapi":"orderly.openapi get /v1/public/campaign/stats/details","title":"Get detailed campaign info","href":"/build-on-omnichain/restful-api/public/get-detailed-campaign-info"},{"openapi":"orderly.openapi get /v1/public/campaigns","title":"Get list of campaigns","href":"/build-on-omnichain/restful-api/public/get-list-of-campaigns"},{"openapi":"orderly.openapi get /v1/public/campaign/check","title":"Get campaign verification","href":"/build-on-omnichain/restful-api/public/get-campaign-verification"},{"openapi":"orderly.openapi post /v1/client/campaign/sign_up","title":"Sign up campaign","href":"/build-on-omnichain/restful-api/private/sign-up-campaign"}]},{"group":"Referral program","pages":[{"group":"Referral code management (legacy)","pages":[{"openapi":"orderly.openapi get /v1/public/referral/check_ref_code","title":"Check referral code","href":"/build-on-omnichain/restful-api/public/check-referral-code"},{"openapi":"orderly.openapi get /v1/public/referral/verify_ref_code","title":"Verify referral code","href":"/build-on-omnichain/restful-api/public/verify-referral-code"},{"openapi":"orderly.openapi post /v1/referral/bind","title":"Bind referral code","href":"/build-on-omnichain/restful-api/private/bind-referral-code"},{"openapi":"orderly.openapi post /v1/referral/edit_referral_code","title":"Edit referral code","href":"/build-on-omnichain/restful-api/private/edit-referral-code"}]},{"group":"User statistics (legacy)","pages":[{"openapi":"orderly.openapi get /v1/referral/info","title":"Get referral info","href":"/build-on-omnichain/restful-api/private/get-referral-info"},{"openapi":"orderly.openapi get /v1/referral/referee_info","title":"Get referee info","href":"/build-on-omnichain/restful-api/private/get-referee-info"},{"openapi":"orderly.openapi get /v1/referral/referral_history","title":"Get referral history","href":"/build-on-omnichain/restful-api/private/get-referral-history"},{"openapi":"orderly.openapi get /v1/referral/rebate_summary","title":"Get referral rebate summary","href":"/build-on-omnichain/restful-api/private/get-referral-rebate-summary"},{"openapi":"orderly.openapi get /v1/referral/referee_rebate_summary","title":"Get referee rebate summary","href":"/build-on-omnichain/restful-api/private/get-referee-rebate-summary"},{"openapi":"orderly.openapi get /v1/referral/referee_history","title":"Get referee history","href":"/build-on-omnichain/restful-api/private/get-referee-history"},{"openapi":"orderly.openapi get /v1/client/distribution_history","title":"Get distribution history","href":"/build-on-omnichain/restful-api/private/get-distribution-history"}]},{"group":"Referral admin (legacy)","pages":[{"openapi":"orderly.openapi post /v1/referral/create","title":"Create referral code","href":"/build-on-omnichain/restful-api/private/create-referral-code"},{"openapi":"orderly.openapi get /v1/referral/admin_info","title":"Get referral code info","href":"/build-on-omnichain/restful-api/private/get-referral-code-info"},{"openapi":"orderly.openapi post /v1/referral/update","title":"Update referral code","href":"/build-on-omnichain/restful-api/private/update-referral-code"},{"openapi":"orderly.openapi post /v1/referral/edit_split","title":"Edit referral code split","href":"/build-on-omnichain/restful-api/private/edit-referral-code-split"},{"openapi":"orderly.openapi post /v1/referral/edit_description","title":"Edit referral description","href":"/build-on-omnichain/restful-api/private/edit-referral-description"},{"openapi":"orderly.openapi post /v1/referral/auto_referral/update","title":"Builder admin update auto referral","href":"/build-on-omnichain/restful-api/private/builder-admin-update-auto-referral"},{"openapi":"orderly.openapi get /v1/referral/auto_referral/info","title":"Builder admin get auto referral info","href":"/build-on-omnichain/restful-api/private/builder-admin-get-auto-referral-info"},{"openapi":"orderly.openapi get /v1/referral/auto_referral/progress","title":"Get auto referral progress","href":"/build-on-omnichain/restful-api/private/get-auto-referral-progress"}]},{"group":"Multilevel referral","pages":[{"openapi":"orderly.openapi get /v1/public/referral/check_ref_code","title":"Check referral code","href":"/build-on-omnichain/restful-api/public/check-multilevel-referral-code"},{"openapi":"orderly.openapi get /v1/public/referral/verify_ref_code","title":"Verify referral code","href":"/build-on-omnichain/restful-api/public/verify-multilevel-referral-code"},{"openapi":"orderly.openapi post /v1/referral/bind","title":"Bind referral code","href":"/build-on-omnichain/restful-api/private/bind-multilevel-referral-code"},{"openapi":"orderly.openapi post /v1/referral/edit_referral_code","title":"Edit referral code","href":"/build-on-omnichain/restful-api/private/edit-multilevel-referral-code"},{"openapi":"orderly.openapi get /v1/referral/referral_history","title":"Get referral history","href":"/build-on-omnichain/restful-api/private/get-multilevel-referral-history"},{"openapi":"orderly.openapi get /v1/referral/rebate_summary","title":"Get referral rebate summary","href":"/build-on-omnichain/restful-api/private/get-multilevel-referral-rebate-summary"},{"openapi":"orderly.openapi get /v1/referral/multi_level/max_rebate_rate","title":"Get max rebate rate","href":"/build-on-omnichain/restful-api/private/get-max-rebate-rate"},{"openapi":"orderly.openapi post /v1/referral/multi_level/claim_code","title":"Claim referral code","href":"/build-on-omnichain/restful-api/private/claim-referral-code"},{"openapi":"orderly.openapi get /v1/referral/multi_level/rebate_info","title":"Get rebate info","href":"/build-on-omnichain/restful-api/private/get-rebate-info"},{"openapi":"orderly.openapi post /v1/referral/multi_level/rebate_rate/update","title":"Update referee rebate rate","href":"/build-on-omnichain/restful-api/private/update-referee-rebate-rate"},{"openapi":"orderly.openapi post /v1/referral/multi_level/rebate_rate/set_default","title":"Reset referee rebate rate","href":"/build-on-omnichain/restful-api/private/reset-referee-rebate-rate"},{"openapi":"orderly.openapi get /v1/referral/multi_level/statistics","title":"Get multilevel statistics","href":"/build-on-omnichain/restful-api/private/get-multilevel-statistics"},{"openapi":"orderly.openapi get /v1/referral/multi_level/referee_list","title":"Get referee list","href":"/build-on-omnichain/restful-api/private/get-referee-list"},{"openapi":"orderly.openapi post /v1/referral/edit_referee_description","title":"Edit direct referee description","href":"/build-on-omnichain/restful-api/private/edit-direct-referee-description"},{"openapi":"orderly.openapi get /v1/referral/multi_level/volume_prerequisite","title":"Get volume prerequisite","href":"/build-on-omnichain/restful-api/private/get-volume-prerequisite"}]}]},{"group":"Builder admin","pages":[{"group":"Builder info","pages":[{"openapi":"orderly.openapi get /v1/broker/broker_info","title":"Get builder fee tier information","href":"/build-on-omnichain/restful-api/private/get-builder-fee-tier-information"},{"openapi":"orderly.openapi get /v1/broker/daily_fee_revenue","title":"Get builder's daily revenue settlement history","href":"/build-on-omnichain/restful-api/private/get-builders-daily-revenue-settlement-history"}]},{"group":"User data","pages":[{"openapi":"orderly.openapi get /v1/admin/client/info","title":"Get account information","href":"/build-on-omnichain/restful-api/private/get-account-information-1"},{"openapi":"orderly.openapi get /v1/admin/client/holding","title":"Get current holding","href":"/build-on-omnichain/restful-api/private/get-current-holding-1"},{"openapi":"orderly.openapi get /v1/admin/internal_transfer_history","title":"Get internal transfer history","href":"/build-on-omnichain/restful-api/private/get-internal-transfer-history-1"},{"openapi":"orderly.openapi get /v1/admin/asset/history","title":"Get asset history","href":"/build-on-omnichain/restful-api/private/get-asset-history-1"},{"openapi":"orderly.openapi get /v1/admin/asset/convert_history","title":"Get asset conversion history","href":"/build-on-omnichain/restful-api/private/get-asset-conversion-history"},{"openapi":"orderly.openapi get /v1/admin/client/leverage","title":"Get leverage setting","href":"/build-on-omnichain/restful-api/private/get-leverage-setting-1"},{"openapi":"orderly.openapi get /v1/admin/orders","title":"Get orders","href":"/build-on-omnichain/restful-api/private/get-orders-1"},{"openapi":"orderly.openapi get /v1/admin/position/{symbol}","title":"Get one position info","href":"/build-on-omnichain/restful-api/private/get-one-position-info-1"},{"openapi":"orderly.openapi get /v1/admin/positions","title":"Get all positions info","href":"/build-on-omnichain/restful-api/private/get-all-positions-info-1"},{"openapi":"orderly.openapi get /v1/admin/funding_fee/history","title":"Get funding fee history","href":"/build-on-omnichain/restful-api/private/get-funding-fee-history-1"},{"openapi":"orderly.openapi get /v1/admin/volume/user/stats","title":"Get user volume statistics","href":"/build-on-omnichain/restful-api/private/get-user-volume-statistics-1"},{"openapi":"orderly.openapi get /v1/admin/liquidations","title":"Get liquidated positions (admin)","href":"/build-on-omnichain/restful-api/private/get-liquidated-positions-admin"},{"openapi":"orderly.openapi get /v1/admin/algo/orders","title":"Get algo orders (admin)","href":"/build-on-omnichain/restful-api/private/get-algo-orders-admin"},{"openapi":"orderly.openapi get /v1/admin/trades","title":"Get trades (admin)","href":"/build-on-omnichain/restful-api/private/get-trades-admin"}]},{"group":"Multilevel referral admin","pages":[{"openapi":"orderly.openapi post /v1/referral/multi_level/admin","title":"Enable or configure multilevel referral","href":"/build-on-omnichain/restful-api/private/enable-or-configure-multilevel-referral"},{"openapi":"orderly.openapi get /v1/referral/multi_level/admin","title":"Get multilevel referral config","href":"/build-on-omnichain/restful-api/private/get-multilevel-referral-config"},{"openapi":"orderly.openapi post /v1/referral/multi_level/admin/update","title":"Update multilevel referral config","href":"/build-on-omnichain/restful-api/private/update-multilevel-referral-config"},{"openapi":"orderly.openapi post /v1/referral/multi_level/admin/update/affiliate","title":"Update L1 affiliate rebate rate","href":"/build-on-omnichain/restful-api/private/update-l1-affiliate-rebate-rate"},{"openapi":"orderly.openapi post /v1/referral/multi_level/admin/reset/affiliate","title":"Reset L1 affiliate rebate rate","href":"/build-on-omnichain/restful-api/private/reset-l1-affiliate-rebate-rate"},{"openapi":"orderly.openapi get /v1/referral/multi_level/admin/info","title":"Get multilevel info","href":"/build-on-omnichain/restful-api/private/get-multilevel-info"},{"openapi":"orderly.openapi get /v1/referral/multi_level/admin/referee_list","title":"Get admin referee list","href":"/build-on-omnichain/restful-api/private/get-admin-referee-list"},{"openapi":"orderly.openapi get /v1/referral/multi_level/admin/summary","title":"Get multilevel summary info","href":"/build-on-omnichain/restful-api/private/get-multilevel-summary-info"},{"openapi":"orderly.openapi post /v1/referral/multi_level/admin/create/affiliate","title":"Create multilevel referral code on affiliate's behalf","href":"/build-on-omnichain/restful-api/private/create-multilevel-referral-code-on-affiliates-behalf"}]},{"group":"Fee settings","pages":[{"openapi":"orderly.openapi post /v1/broker/fee_rate/set","title":"Update user fee rate","href":"/build-on-omnichain/restful-api/private/update-user-fee-rate"},{"openapi":"orderly.openapi post /v1/broker/fee_rate/set_default","title":"Reset user fee rate","href":"/build-on-omnichain/restful-api/private/reset-user-fee-rate"},{"openapi":"orderly.openapi get /v1/broker/fee_rate/default","title":"Get default builder fee","href":"/build-on-omnichain/restful-api/private/get-default-builder-fee"},{"openapi":"orderly.openapi post /v1/broker/fee_rate/default","title":"Update default builder fee","href":"/build-on-omnichain/restful-api/private/update-default-builder-fee"},{"openapi":"orderly.openapi get /v1/broker/user_info","title":"Get user fee rates","href":"/build-on-omnichain/restful-api/private/get-user-fee-rates"}]},{"group":"Order tag admin","pages":[{"openapi":"orderly.openapi post /v1/broker/order_enum","title":"Create order tag","href":"/build-on-omnichain/restful-api/private/create-order-tag"},{"openapi":"orderly.openapi put /v1/broker/order_enum/{enum_id}","title":"Update order tag","href":"/build-on-omnichain/restful-api/private/update-order-tag"},{"openapi":"orderly.openapi get /v1/broker/order_enums","title":"List all order tags for a builder","href":"/build-on-omnichain/restful-api/private/list-all-order-tags-for-a-builder"},{"openapi":"orderly.openapi get /v1/broker/order_enum/{enum_id}","title":"Get single order tag with stats","href":"/build-on-omnichain/restful-api/private/get-single-order-tag-with-stats"},{"openapi":"orderly.openapi post /v1/broker/order_enum/archive","title":"Archive an order tag","href":"/build-on-omnichain/restful-api/private/archive-an-order-tag"},{"openapi":"orderly.openapi post /v1/broker/order_enum/unarchive","title":"Unarchive an order tag","href":"/build-on-omnichain/restful-api/private/unarchive-an-order-tag"}]}]}]},{"group":"Points module","pages":[{"group":"Public API","pages":[{"openapi":"orderly.openapi get /v1/public/points/stages","title":"Get information about stages","href":"/build-on-omnichain/restful-api/public/get-information-about-stages"},{"openapi":"orderly.openapi get /v1/public/points/rankings","title":"Get stage rankings","href":"/build-on-omnichain/restful-api/public/get-stage-rankings"}]},{"group":"Admin API","pages":[{"openapi":"orderly.openapi post /v1/admin/points/stage","title":"Create/update stage parameters","href":"/build-on-omnichain/restful-api/private/createupdate-stage-parameters"},{"openapi":"orderly.openapi get /v1/admin/points/stage","title":"Get stage parameters","href":"/build-on-omnichain/restful-api/private/get-stage-parameters"},{"openapi":"orderly.openapi delete /v1/admin/points/stage","title":"Delete stage","href":"/build-on-omnichain/restful-api/admin/delete-stage"}]}]},{"group":"Market data API","pages":[{"group":"Tradingview","pages":[{"openapi":"orderly.openapi get /v1/tv/config","title":"Get tradingview localized config info","href":"/build-on-omnichain/restful-api/public/get-tradingview-localized-config-info"},{"openapi":"orderly.openapi get /v1/tv/history","title":"Get tradingview history bars","href":"/build-on-omnichain/restful-api/public/get-tradingview-history-bars"},{"openapi":"orderly.openapi get /v1/tv/symbol_info","title":"Get tradingview symbol info","href":"/build-on-omnichain/restful-api/public/get-tradingview-symbol-info"}]},{"group":"Funding rates","pages":[{"openapi":"orderly.openapi get /v1/public/funding_rate_history","title":"Get funding rate history for one market","href":"/build-on-omnichain/restful-api/public/get-funding-rate-history-for-one-market"},{"openapi":"orderly.openapi get /v1/public/funding_rate/{symbol}","title":"Get predicted funding rate for one market","href":"/build-on-omnichain/restful-api/public/get-predicted-funding-rate-for-one-market"},{"openapi":"orderly.openapi get /v1/public/funding_rates","title":"Get predicted funding rates for all markets","href":"/build-on-omnichain/restful-api/public/get-predicted-funding-rates-for-all-markets"},{"openapi":"orderly.openapi get /v1/public/market_info/funding_history","title":"Get funding rate for all markets","href":"/build-on-omnichain/restful-api/public/get-funding-rate-for-all-markets"}]},{"group":"Market info","pages":[{"openapi":"orderly.openapi get /v1/public/token","title":"Get supported collateral info","href":"/build-on-omnichain/restful-api/public/get-supported-collateral-info"},{"openapi":"orderly.openapi get /v1/public/info/{symbol}","title":"Get order rules per symbol","href":"/build-on-omnichain/restful-api/public/get-order-rules-per-symbol"},{"openapi":"orderly.openapi get /v1/public/info","title":"Get available symbols","href":"/build-on-omnichain/restful-api/public/get-available-symbols"},{"openapi":"orderly.openapi get /v1/public/market_trades","title":"Get market trades","href":"/build-on-omnichain/restful-api/public/get-market-trades"},{"openapi":"orderly.openapi get /v1/public/market_info/price_changes","title":"Get price info for all symbols","href":"/build-on-omnichain/restful-api/public/get-price-info-for-all-symbols"},{"openapi":"orderly.openapi get /v1/public/market_info/traders_open_interests","title":"Get open interests for all symbols","href":"/build-on-omnichain/restful-api/public/get-open-interests-for-all-symbols"},{"openapi":"orderly.openapi get /v1/public/futures","title":"Get market info for all symbols","href":"/build-on-omnichain/restful-api/public/get-market-info-for-all-symbols"},{"openapi":"orderly.openapi get /v1/public/futures/{symbol}","title":"Get market info for one symbol","href":"/build-on-omnichain/restful-api/public/get-market-info-for-one-symbol"},{"openapi":"orderly.openapi get /v1/public/binary/info","title":"Get Orderly Predict round info for all rounds","href":"/build-on-omnichain/restful-api/public/get-orderly-predict-round-info-for-all-rounds"},{"openapi":"orderly.openapi get /v1/public/binary/info/{symbol}","title":"Get Orderly Predict round info for one round","href":"/build-on-omnichain/restful-api/public/get-orderly-predict-round-info-for-one-round"},{"openapi":"orderly.openapi get /v1/public/index_price_source","title":"Get index price source","href":"/build-on-omnichain/restful-api/public/get-index-price-source"},{"openapi":"orderly.openapi get /v1/public/index_price","title":"Get index price history","href":"/build-on-omnichain/restful-api/public/get-index-price-history"},{"openapi":"orderly.openapi get /v1/public/market_info/history_charts","title":"Get historical price list for all symbols","href":"/build-on-omnichain/restful-api/public/get-historical-price-list-for-all-symbols"},{"openapi":"orderly.openapi get /v1/orderbook/{symbol}","title":"Orderbook snapshot","href":"/build-on-omnichain/restful-api/private/orderbook-snapshot"},{"openapi":"orderly.openapi get /v1/kline","title":"Get kline","href":"/build-on-omnichain/restful-api/public/get-kline"},{"openapi":"orderly.openapi get /v1/tv/kline_history","title":"Get kline history","href":"/build-on-omnichain/restful-api/public/get-kline-history"}]}]},{"group":"Websocket API","pages":[{"title":"Websocket API","sidebarTitle":"Introduction","href":"/build-on-omnichain/websocket-api/introduction"},{"title":"PING/PONG","href":"/build-on-omnichain/websocket-api/ping-pong"},{"title":"Authentication","description":"How to authenticate WebSocket private stream connections using orderly-key and orderly-secret.","href":"/build-on-omnichain/websocket-api/authentication"},{"title":"Error Response","href":"/build-on-omnichain/websocket-api/error-response"},{"group":"Public market data","pages":[{"title":"Request orderbook","description":"Request a one-time orderbook snapshot for a symbol via WebSocket instead of subscribing to updates.","href":"/build-on-omnichain/websocket-api/public/request-orderbook"},{"title":"Orderbook","href":"/build-on-omnichain/websocket-api/public/orderbook"},{"title":"Order book update","href":"/build-on-omnichain/websocket-api/public/order-book-update"},{"title":"Trade","href":"/build-on-omnichain/websocket-api/public/trade"},{"title":"24h ticker","href":"/build-on-omnichain/websocket-api/public/24-hour-ticker"},{"title":"24h tickers","href":"/build-on-omnichain/websocket-api/public/24-hour-tickers"},{"title":"24h ticker by builder","href":"/build-on-omnichain/websocket-api/public/24-hour-ticker-by-builder"},{"title":"24h tickers by builder","href":"/build-on-omnichain/websocket-api/public/24-hour-tickers-by-builder"},{"title":"bbo","href":"/build-on-omnichain/websocket-api/public/bbo"},{"title":"bbos","href":"/build-on-omnichain/websocket-api/public/bbos"},{"title":"k-line","href":"/build-on-omnichain/websocket-api/public/k-line"},{"title":"Market Price Changes Info","href":"/build-on-omnichain/websocket-api/public/price-changes"},{"title":"Traders Open Interest","href":"/build-on-omnichain/websocket-api/public/traders-open-interests"},{"title":"Price for Small Charts","href":"/build-on-omnichain/websocket-api/public/price-for-small-charts"},{"title":"Index price","href":"/build-on-omnichain/websocket-api/public/index-price"},{"title":"Index prices","href":"/build-on-omnichain/websocket-api/public/index-prices"},{"title":"Mark price","href":"/build-on-omnichain/websocket-api/public/mark-price"},{"title":"Mark prices","href":"/build-on-omnichain/websocket-api/public/mark-prices"},{"title":"Open interest","href":"/build-on-omnichain/websocket-api/public/open-interest"},{"title":"Estimated funding rate","href":"/build-on-omnichain/websocket-api/public/estimated-funding-rate"},{"title":"Liquidation push","href":"/build-on-omnichain/websocket-api/public/liquidation-push"},{"title":"System maintenance status","href":"/build-on-omnichain/websocket-api/public/system-maintenance-status"},{"title":"Announcement","href":"/build-on-omnichain/websocket-api/public/announcement"}]},{"group":"Private user data","pages":[{"title":"Account","href":"/build-on-omnichain/websocket-api/private/account"},{"title":"Balance","href":"/build-on-omnichain/websocket-api/private/balance"},{"title":"Execution Report","href":"/build-on-omnichain/websocket-api/private/execution-report"},{"title":"Algo Execution Report","href":"/build-on-omnichain/websocket-api/private/algo-execution-report"},{"title":"Algo Execution Report v2","href":"/build-on-omnichain/websocket-api/private/algo-execution-report-v2"},{"title":"Position push","href":"/build-on-omnichain/websocket-api/private/position-push"},{"title":"Liquidation on account push","href":"/build-on-omnichain/websocket-api/private/liquidation-account-push"},{"title":"Liquidator liquidations push","href":"/build-on-omnichain/websocket-api/private/liquidator"},{"title":"PnL Settlement","href":"/build-on-omnichain/websocket-api/private/pnl-settlement"},{"title":"Wallet Transactions","href":"/build-on-omnichain/websocket-api/private/wallet-transactions"},{"title":"Asset Convert","href":"/build-on-omnichain/websocket-api/private/asset-convert"}]}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Strategy vault","pages":[{"title":"Strategy vault","href":"/introduction/orderly-omniVault/overview"}]},{"tab":"Troubleshooting","pages":[{"title":"Troubleshooting","href":"/troubleshooting/introduction"}]},{"tab":"Release notes","pages":[{"title":"Release notes","href":"/release-notes/omnichain"}]}]},{"version":"pre-release","href":"https://staging-docs.orderly.network"}]},"title":"Error Response - Orderly","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}