A client IP can establish a maximum of 100 connections every 5 minutes. Exceeding this will result in rejected attempts and a cooldown period.A client IP can maintain up to 100 active WebSocket connections at any given time. Any attempt to exceed this will result in new connections being denied.Note: Extensive retries after hitting limits will result in an IP ban.
Each connection can subscribe to a maximum of 100 live topics simultaneously. Further subscription attempts will be rejected once this limit is reached.When submitting batch subscriptions, the server processes them sequentially. If the subscription limit is reached mid-way, the server will accept subscriptions until the limit is met. Any subscriptions that exceed the limit will be rejected. The maximum number of topics to subscribe per request is 20.While subscribing to topics within a single connection, it is not recommended to exceed 200 TPS.
The server supports a Ping-Pong mechanism for clients to verify connectivity and measure round-trip latency. This is not required for keep-alive purposes.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"WOO","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"favicon":"/logo/WOO_X_Additional.svg","logo":{"light":"https://mintcdn.com/woox/K2XdG05Z-vdskkFd/logo/WOO_X_Additional.svg?fit=max\u0026auto=format\u0026n=K2XdG05Z-vdskkFd\u0026q=85\u0026s=4afc80edc3a14e5b302d69018a31c992","dark":"https://mintcdn.com/woox/K2XdG05Z-vdskkFd/logo/WOO_X_Flat.svg?fit=max\u0026auto=format\u0026n=K2XdG05Z-vdskkFd\u0026q=85\u0026s=7b261f334a5a81ecbf30dda02c580aa9"},"api":{"openapi":["openapi-merged.json"]},"navbar":{"links":[{"label":"Support","href":"https://support.woox.io/hc/en-us"}],"primary":null},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"woox","hasAudioNarration":false,"actualSubdomain":"woox","customDomains":["developer.woox.io"],"gitSource":{"type":"gitlab","owner":"woonetwork/woo-techsupp","repo":"woo","projectId":68149621,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92406c5b843216cbd9fb0:success","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"V3 API","count":85},{"language":"default","tag":"Websocket Streams","count":22},{"language":"default","tag":"Trading","count":17},{"language":"default","tag":"Public Data","count":14},{"language":"default","tag":"Public Market Data","count":12},{"language":"default","tag":"Account","count":9},{"language":"default","tag":"Assets","count":8},{"language":"default","tag":"Futures","count":6},{"language":"default","tag":"Spot Margin","count":5},{"language":"default","tag":"Private User Data","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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/websocket_introduction","slug":"/api-reference/websocket_introduction","pageMetadata":{"title":"Introduction","description":null,"href":"/api-reference/websocket_introduction"},"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={br:`br`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`public-streams`,children:`Public streams`}),`\n`,_jsx(_components.p,{children:`wss://wss.woox.io/v3/public (Production)`}),`\n`,_jsx(_components.p,{children:`wss://wss.staging.woox.io/v3/public (Staging)`}),`\n`,_jsx(Heading,{level:`3`,id:`private-streams`,children:`Private streams`}),`\n`,_jsx(_components.p,{children:`wss://wss.woox.io/v3/private (Production)`}),`\n`,_jsx(_components.p,{children:`wss://wss.staging.woox.io/v3/private (Staging)`}),`\n`,_jsx(Heading,{level:`3`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Public market data topics do not require authentication.`})}),`\n`,_jsx(_components.p,{children:`Authentication is required for subscribing to private user data streams (e.g., order updates, account info).`}),`\n`,_jsx(_components.p,{children:`To authenticate:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Obtain a listen key`}),_jsx(_components.br,{}),`\n`,`Call the following `,_jsx(`a`,{href:`endpoint/account/listen_key`,target:`_self`,children:`endpoint`}),` to get your listenKey.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Connect to the WebSocket`}),_jsx(_components.br,{}),`\n`,`Use the WebSocket base URL and append your listen key as a query parameter at `,_jsx(_components.code,{children:`{base_wss_url}`}),`?key=`,_jsx(_components.code,{children:`\u003clistenKey>`}),`.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Once connected, you may subscribe to various private topics using subscription commands. See `,_jsx(`a`,{href:`endpoint/websocket/subscribe`,target:`_self`,children:`subscription commands`}),` for full details.`]}),`\n`,_jsx(Heading,{level:`2`,id:`additional-information`,children:`Additional information`}),`\n`,_jsx(Heading,{level:`3`,id:`general`,children:`General`}),`\n`,_jsx(_components.p,{children:`Each WebSocket connection is valid for a maximum of 24 hours. Expect automatic disconnection at the 24-hour mark.`}),`\n`,_jsx(Heading,{level:`3`,id:`connection-limits`,children:`Connection limits`}),`\n`,_jsx(_components.p,{children:`A client IP can establish a maximum of 100 connections every 5 minutes. Exceeding this will result in rejected attempts and a cooldown period.`}),`\n`,_jsx(_components.p,{children:`A client IP can maintain up to 100 active WebSocket connections at any given time. Any attempt to exceed this will result in new connections being denied.`}),`\n`,_jsx(_components.p,{children:`Note: Extensive retries after hitting limits will result in an IP ban.`}),`\n`,_jsx(Heading,{level:`3`,id:`subscription-limits`,children:`Subscription limits`}),`\n`,_jsx(_components.p,{children:`Each connection can subscribe to a maximum of 100 live topics simultaneously. Further subscription attempts will be rejected once this limit is reached.`}),`\n`,_jsx(_components.p,{children:`When submitting batch subscriptions, the server processes them sequentially. If the subscription limit is reached mid-way, the server will accept subscriptions until the limit is met. Any subscriptions that exceed the limit will be rejected. The maximum number of topics to subscribe per request is 20.`}),`\n`,_jsx(_components.p,{children:`While subscribing to topics within a single connection, it is not recommended to exceed 200 TPS.`}),`\n`,_jsx(Heading,{level:`3`,id:`ping-pong-mechanism`,children:`Ping-Pong mechanism`}),`\n`,_jsx(_components.p,{children:`The server supports a Ping-Pong mechanism for clients to verify connectivity and measure round-trip latency. This is not required for keep-alive purposes.`}),`\n`,_jsx(Heading,{level:`4`,id:`example`,children:`Example`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Client sends:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cmd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PING\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: 1750641291182 } `})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Server responds:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cmd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PONG\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: true, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: 1750641291322 } `})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":null,"href":"/api-reference/websocket_introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Public streams","slug":"public-streams","depth":3,"children":[]},{"title":"Private streams","slug":"private-streams","depth":3,"children":[]},{"title":"Authentication","slug":"authentication","depth":3,"children":[]},{"title":"Additional information","slug":"additional-information","depth":2,"children":[{"title":"General","slug":"general","depth":3,"children":[]},{"title":"Connection limits","slug":"connection-limits","depth":3,"children":[]},{"title":"Subscription limits","slug":"subscription-limits","depth":3,"children":[]},{"title":"Ping-Pong mechanism","slug":"ping-pong-mechanism","depth":3,"children":[]},{"title":"Example","slug":"example","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/woox/3effc90d96fd4baf/merge-openapi.js"],"subdomain":"woox","siteName":"WOO","title":"Introduction - WOO","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-20T11:53:49.365Z","originalFileLocation":"api-reference/websocket_introduction.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=\"application-name\" content=\"WOO\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_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/woox/i5AO74-cLQcbsrkM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - WOO\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WOO\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.woox.io/api-reference/websocket_introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://woox.mintlify.site/_mintlify/api/og/v2?division=Websocket+Streams\u0026amp;title=Introduction\u0026amp;theme=14761b6e54ca88333e98fbd0\u0026amp;signature=de139fad2622c32f0995f9af03b2a5221267d7487883e19c0f1074e99d10c043\">\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=\"Introduction - WOO\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://woox.mintlify.site/_mintlify/api/og/v2?division=Websocket+Streams\u0026amp;title=Introduction\u0026amp;theme=14761b6e54ca88333e98fbd0\u0026amp;signature=de139fad2622c32f0995f9af03b2a5221267d7487883e19c0f1074e99d10c043\">\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/woox/i5AO74-cLQcbsrkM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WOO\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.woox.io/api-reference/websocket_introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/websocket_introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.woox.io/#organization\",\"name\":\"WOO\",\"url\":\"https://developer.woox.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/woox/K2XdG05Z-vdskkFd/logo/WOO_X_Additional.svg?fit=max\u0026auto=format\u0026n=K2XdG05Z-vdskkFd\u0026q=85\u0026s=4afc80edc3a14e5b302d69018a31c992\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.woox.io#website\",\"name\":\"WOO\",\"url\":\"https://developer.woox.io\",\"publisher\":{\"@id\":\"https://developer.woox.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.woox.io/api-reference/websocket_introduction#webpage\",\"url\":\"https://developer.woox.io/api-reference/websocket_introduction\",\"name\":\"Introduction\",\"dateModified\":\"2025-10-20T11:53:49.365Z\",\"isPartOf\":{\"@id\":\"https://developer.woox.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.woox.io/api-reference/websocket_introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.woox.io/api-reference/websocket_introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WOO\",\"item\":\"https://developer.woox.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://developer.woox.io/api-reference/websocket_introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.woox.io/api-reference/websocket_introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://developer.woox.io/api-reference/websocket_introduction\",\"mainEntityOfPage\":{\"@id\":\"https://developer.woox.io/api-reference/websocket_introduction#webpage\"},\"dateModified\":\"2025-10-20T11:53:49.365Z\",\"publisher\":{\"@id\":\"https://developer.woox.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.woox.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WOO\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"WOO\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/websocket_introduction.md","siteName":"WOO","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"V3 API","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Integration guide","href":"/api-reference/guide"},{"title":"Migration guide","href":"/api-reference/migration_guide"},{"title":null,"href":"/api-reference/error_code"}]},{"group":"Public Data","pages":[{"title":"Get system maintenance status","openapi":"GET /v3/public/systemInfo","href":"/api-reference/endpoint/public_data/systemInfo"},{"title":"Get instruments","openapi":"GET /v3/public/instruments","href":"/api-reference/endpoint/public_data/instruments"},{"title":"Available token","openapi":"GET /v3/public/token","href":"/api-reference/endpoint/public_data/token"},{"title":"Token network","openapi":"GET /v3/public/tokenNetwork","href":"/api-reference/endpoint/public_data/tokenNetwork"},{"title":"Get token info","openapi":"GET /v3/public/tokenInfo","href":"/api-reference/endpoint/public_data/tokenInfo"},{"title":"Market trades","openapi":"GET /v3/public/marketTrades","href":"/api-reference/endpoint/public_data/marketTrades"},{"title":"Market trades history","openapi":"GET /v3/public/marketTradesHistory","href":"/api-reference/endpoint/public_data/marketTradesHistory"},{"title":"Orderbook snapshot","openapi":"GET /v3/public/orderbook","href":"/api-reference/endpoint/public_data/orderbook"},{"title":"Kline","openapi":"GET /v3/public/kline","href":"/api-reference/endpoint/public_data/kline"},{"title":"Kline history","openapi":"GET /v3/public/klineHistory","href":"/api-reference/endpoint/public_data/klineHistory"},{"title":"Get futures info","openapi":"GET /v3/public/futures","href":"/api-reference/endpoint/public_data/futures"},{"title":"Get predicted funding rate","openapi":"GET /v3/public/fundingRate","href":"/api-reference/endpoint/public_data/fundingRate"},{"title":"Get funding rate history for one market","openapi":"GET /v3/public/fundingRateHistory","href":"/api-reference/endpoint/public_data/fundingRateHistory"},{"title":"Get insurance fund","openapi":"GET /v3/public/insuranceFund","href":"/api-reference/endpoint/public_data/insuranceFund"}]},{"group":"Trading","pages":[{"title":"Place order","openapi":"POST /v3/trade/order","href":"/api-reference/endpoint/trading/post_order"},{"title":"Cancel order","openapi":"DELETE /v3/trade/order","href":"/api-reference/endpoint/trading/cancel_order"},{"title":"Cancel multiple orders","openapi":"DELETE /v3/trade/orders","href":"/api-reference/endpoint/trading/cancel_all_order"},{"title":"Get order","openapi":"GET /v3/trade/order","href":"/api-reference/endpoint/trading/get_order"},{"title":"Get orders","openapi":"GET /v3/trade/orders","href":"/api-reference/endpoint/trading/get_orders"},{"title":"Edit order","openapi":"PUT /v3/trade/order","href":"/api-reference/endpoint/trading/edit_order"},{"title":"Place algo order","openapi":"POST /v3/trade/algoOrder","href":"/api-reference/endpoint/trading/post_algo_order"},{"title":"Cancel algo order","openapi":"DELETE /v3/trade/algoOrder","href":"/api-reference/endpoint/trading/cancel_algo_order"},{"title":"Cancel multiple algo orders","openapi":"DELETE /v3/trade/algoOrders","href":"/api-reference/endpoint/trading/cancel_algo_orders"},{"title":"Cancel all orders by symbol ","openapi":"DELETE /v3/trade/allOrders","href":"/api-reference/endpoint/trading/cancel_orders_by_symbol"},{"title":"Get algo order","openapi":"GET /v3/trade/algoOrder","href":"/api-reference/endpoint/trading/get_algo_order"},{"title":"Get algo orders","openapi":"GET /v3/trade/algoOrders","href":"/api-reference/endpoint/trading/get_algo_orders"},{"title":"Edit algo order","openapi":"PUT /v3/trade/algoOrder","href":"/api-reference/endpoint/trading/edit_algo_order"},{"title":"Get transaction by trade id (last 3 months) ","openapi":"GET /v3/trade/transaction","href":"/api-reference/endpoint/trading/get_transaction"},{"title":"Get transaction history (in the past 2 years) ","openapi":"GET /v3/trade/transactionHistory","href":"/api-reference/endpoint/trading/get_transactions"},{"title":"Get trading fee","openapi":"GET /v3/trade/tradingFee","href":"/api-reference/endpoint/trading/get_tradingFee"},{"title":"Cancel all after","openapi":"POST /v3/trade/cancelAllAfter","href":"/api-reference/endpoint/trading/cancel_all_after"}]},{"group":"Account","pages":[{"title":"Get account information","openapi":"GET /v3/account/info","href":"/api-reference/endpoint/account/get_account_info"},{"title":"Token config","openapi":"GET /v3/account/tokenConfig","href":"/api-reference/endpoint/account/get_token_config"},{"title":"Symbol config","openapi":"GET /v3/account/symbolConfig","href":"/api-reference/endpoint/account/get_symbol_config"},{"title":"Set account trading mode","openapi":"POST /v3/account/tradingMode","href":"/api-reference/endpoint/account/trading_mode"},{"title":"Get sub accounts","openapi":"GET /v3/account/subAccounts/all","href":"/api-reference/endpoint/account/sub_accounts"},{"title":"Get referral summary","openapi":"GET /v3/account/referral/summary","href":"/api-reference/endpoint/account/summary"},{"title":"Get referral reward history","openapi":"GET /v3/account/referral/rewardHistory","href":"/api-reference/endpoint/account/get_referral_reward_history"},{"title":"Get account api key permission","openapi":"GET /v3/account/credentials","href":"/api-reference/endpoint/account/credentials"},{"title":"Get listen key","openapi":"POST /v3/account/listenKey","href":"/api-reference/endpoint/account/listen_key"}]},{"group":"Assets","pages":[{"title":"Get balances","openapi":"GET /v3/asset/balances","href":"/api-reference/endpoint/assets/get_balances"},{"title":"Get token history","openapi":"GET /v3/asset/token/history","href":"/api-reference/endpoint/assets/token_history"},{"title":"Get transfer history","openapi":"GET /v3/asset/transfer/history","href":"/api-reference/endpoint/assets/get_transfer_history"},{"title":"Transfer assets","openapi":"POST /v3/asset/transfer","href":"/api-reference/endpoint/assets/transfer"},{"title":"Get wallet history","openapi":"GET /v3/asset/wallet/history","href":"/api-reference/endpoint/assets/get_wallet_history"},{"title":"Token withdraw","openapi":"POST /v3/asset/wallet/withdraw","href":"/api-reference/endpoint/assets/wallet_withdraw"},{"title":"Get token deposit address","openapi":"GET /v3/asset/wallet/deposit","href":"/api-reference/endpoint/assets/get_wallet_deposit"},{"title":"Get staking yield history","openapi":"GET /v3/asset/staking/yieldHistory","href":"/api-reference/endpoint/assets/get_yield_history"}]},{"group":"Futures","pages":[{"title":"Get positions","openapi":"GET /v3/futures/positions","href":"/api-reference/endpoint/futures/get_positions"},{"title":"Get futures leverage","openapi":"GET /v3/futures/leverage","href":"/api-reference/endpoint/futures/get_leverage"},{"title":"Set futures leverage","openapi":"PUT /v3/futures/leverage","href":"/api-reference/endpoint/futures/set_leverage"},{"title":"Set position mode","openapi":"PUT /v3/futures/positionMode","href":"/api-reference/endpoint/futures/position_mode"},{"title":"Get default margin mode","openapi":"GET /v3/futures/defaultMarginMode","href":"/api-reference/endpoint/futures/defaultMarginMode"},{"title":"Get funding fee history","openapi":"GET /v3/futures/fundingFee/history","href":"/api-reference/endpoint/futures/get_fundingFee_history"}]},{"group":"Spot Margin","pages":[{"title":"Set leverage","openapi":"POST /v3/spotMargin/leverage","href":"/api-reference/endpoint/spot_margin/set_leverage"},{"title":"Get margin interest rates","openapi":"GET /v3/spotMargin/interestRate","href":"/api-reference/endpoint/spot_margin/get_interest_rate"},{"title":"Get interest history","openapi":"GET /v3/spotMargin/interestHistory","href":"/api-reference/endpoint/spot_margin/get_interest_history"},{"title":"Repay interest ","openapi":"POST /v3/spotMargin/interestRepay","href":"/api-reference/endpoint/spot_margin/interest_repay"},{"title":"Get available margin","openapi":"GET /v3/spotMargin/maxMargin","description":"Get max available margin for a given spot instrument.","href":"/api-reference/endpoint/spot_margin/get_max_margin"}]},{"group":"Websocket Streams","pages":[{"title":"Introduction","href":"/api-reference/websocket_introduction"},{"group":"Public Market Data","pages":[{"title":"Orderbook update","description":null,"href":"/api-reference/endpoint/websocket/Orderbook_update"},{"title":"Orderbook update (RPI)","href":"/api-reference/endpoint/websocket/Orderbook_update_rpi"},{"title":"Orderbook","href":"/api-reference/endpoint/websocket/ORDERBOOK10"},{"title":"BBO","href":"/api-reference/endpoint/websocket/BBO"},{"title":"BBO (RPI)","href":"/api-reference/endpoint/websocket/BBO_rpi"},{"title":"Trade","href":"/api-reference/endpoint/websocket/TRADE"},{"title":"Ticker","href":"/api-reference/endpoint/websocket/TICKER"},{"title":"Kline","href":"/api-reference/endpoint/websocket/KLINE"},{"title":"Index price","href":"/api-reference/endpoint/websocket/INDEX_PRICE"},{"title":"Mark price","href":"/api-reference/endpoint/websocket/MARKET_PRICE"},{"title":"Estimated funding rate","href":"/api-reference/endpoint/websocket/FUNDING_RATE"},{"title":"Open interest","href":"/api-reference/endpoint/websocket/OPEN_INTEREST"}]},{"group":"Private User Data","pages":[{"title":"Account","href":"/api-reference/endpoint/websocket/private/Account"},{"title":"Balance","href":"/api-reference/endpoint/websocket/private/Balance"},{"title":"Position","href":"/api-reference/endpoint/websocket/private/Position"},{"title":"Execution report","href":"/api-reference/endpoint/websocket/private/Execution_report"},{"title":"Algo execution report","href":"/api-reference/endpoint/websocket/private/Algo_execution_report"}]},{"group":"Commands","pages":[{"title":"Subscribe","href":"/api-reference/endpoint/websocket/subscribe"},{"title":"Unsubscribe","href":"/api-reference/endpoint/websocket/Unsubscribe"},{"title":"Unsubscribe all","href":"/api-reference/endpoint/websocket/Unsubscribe_all"},{"title":"List subscription","href":"/api-reference/endpoint/websocket/List_subscription"}]}]}]},{"tab":"Legacy API","pages":[{"title":"Legacy API","href":"/legacy-api-reference/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/release_note_v3"}]}]},"basePath":"","title":"Introduction - WOO","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}