To help you get started quickly, we provide complete client examples for connecting to our WebSocket API, handling authentication, subscribing to channels, and parsing the optimized message formats.Choose your preferred environment below:
JavaScript
Browser-native implementation using the WebSocket API.
NodeJS
Server-side implementation using the ws library.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"xChangeApi.com","colors":{"primary":"#b75fe3","light":"#9938CA","dark":"#9938CA"},"logo":{"light":"https://mintcdn.com/xchangeapi/wjluIIKvOZxjEvik/logo/light.png?fit=max\u0026auto=format\u0026n=wjluIIKvOZxjEvik\u0026q=85\u0026s=29907fdc32b4f908b7b0cbcaaf707ddd","dark":"https://mintcdn.com/xchangeapi/wjluIIKvOZxjEvik/logo/light.png?fit=max\u0026auto=format\u0026n=wjluIIKvOZxjEvik\u0026q=85\u0026s=29907fdc32b4f908b7b0cbcaaf707ddd"},"favicon":"/favicon.svg","api":{"mdx":{"auth":{"method":"key","name":"api-key"},"server":"https://api.xchangeapi.com/"}},"navbar":{"primary":{"type":"button","label":"Sign in","href":"https://xchangeapi.com/sign-in"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"xchangeapi","hasAudioNarration":false,"actualSubdomain":"xchangeapi","customDomains":["xchangeapi.com"],"gitSource":{"type":"github","owner":"rrosmus","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae942ae8b3a7fe7583a0bb9:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"HTTP API Reference","count":8},{"language":"default","tag":"Getting Started","count":6},{"language":"default","tag":"Guides \u0026 Recipes","count":5},{"language":"default","tag":"Historical Data","count":3},{"language":"default","tag":"Live Data","count":3},{"language":"default","tag":"Quickstart","count":3},{"language":"default","tag":"Websocket API Reference","count":3},{"language":"default","tag":"Currency Tools","count":1},{"language":"default","tag":"Metadata","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"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":"site-roles","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},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"websocket/example-implementation","slug":"/websocket/example-implementation","pageMetadata":{"title":"Example implementation","description":null,"href":"/websocket/example-implementation"},"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`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To help you get started quickly, we provide complete client examples for connecting to our WebSocket API, handling authentication, subscribing to channels, and parsing the optimized message formats.`}),`\n`,_jsx(_components.p,{children:`Choose your preferred environment below:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`JavaScript`,icon:`js`,href:`/websocket/example-implementation/javascript`,children:_jsxs(_components.p,{children:[`Browser-native implementation using the `,_jsx(_components.code,{children:`WebSocket`}),` API.`]})}),_jsx(Card,{title:`NodeJS`,icon:`node`,href:`/websocket/example-implementation/nodejs`,children:_jsxs(_components.p,{children:[`Server-side implementation using the `,_jsx(_components.code,{children:`ws`}),` library.`]})})]})]})}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":"Example implementation","description":null,"href":"/websocket/example-implementation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/xchangeapi/495ba753a52db71e/websocket/example-implementation/js/websocket.js","/docs/_mintlify/custom/xchangeapi/48911bb8c68ad74b/websocket/example-implementation/node/client.js"],"subdomain":"xchangeapi","siteName":"xChangeApi.com","title":"Example implementation - xChangeApi.com","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-28T22:45:32.969Z","originalFileLocation":"websocket/example-implementation.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=\"xChangeApi.com\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_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=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Example implementation - xChangeApi.com\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"xChangeApi.com\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://xchangeapi.com/docs/websocket/example-implementation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://xchangeapi.mintlify.site/docs/_mintlify/api/og/v2?division=Websocket+API+Reference\u0026amp;title=Example+implementation\u0026amp;theme=9ac6bf1a0da426ccc92107b9\u0026amp;signature=36f2f98e77a2014263047da7552f61979ab0699f708f4a407d461a60e962ba77\">\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=\"Example implementation - xChangeApi.com\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://xchangeapi.mintlify.site/docs/_mintlify/api/og/v2?division=Websocket+API+Reference\u0026amp;title=Example+implementation\u0026amp;theme=9ac6bf1a0da426ccc92107b9\u0026amp;signature=36f2f98e77a2014263047da7552f61979ab0699f708f4a407d461a60e962ba77\">\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=\"/docs/mintlify-assets/_mintlify/favicons/xchangeapi/wHHzBy3GmlwqcEnG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"xChangeApi.com\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#b75fe3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://xchangeapi.com/docs/websocket/example-implementation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/websocket/example-implementation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://xchangeapi.com/#organization\",\"name\":\"xChangeApi.com\",\"url\":\"https://xchangeapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/xchangeapi/wjluIIKvOZxjEvik/logo/light.png?fit=max\u0026auto=format\u0026n=wjluIIKvOZxjEvik\u0026q=85\u0026s=29907fdc32b4f908b7b0cbcaaf707ddd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://xchangeapi.com/docs#website\",\"name\":\"xChangeApi.com\",\"url\":\"https://xchangeapi.com/docs\",\"publisher\":{\"@id\":\"https://xchangeapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://xchangeapi.com/docs/websocket/example-implementation#webpage\",\"url\":\"https://xchangeapi.com/docs/websocket/example-implementation\",\"name\":\"Example implementation\",\"dateModified\":\"2025-12-28T22:45:32.969Z\",\"isPartOf\":{\"@id\":\"https://xchangeapi.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://xchangeapi.com/docs/websocket/example-implementation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://xchangeapi.com/docs/websocket/example-implementation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Websocket API Reference\",\"item\":\"https://xchangeapi.com/docs/websocket/protocol\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Example implementation\",\"item\":\"https://xchangeapi.com/docs/websocket/example-implementation\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://xchangeapi.com/docs/websocket/example-implementation#article\",\"headline\":\"Example implementation\",\"name\":\"Example implementation\",\"url\":\"https://xchangeapi.com/docs/websocket/example-implementation\",\"mainEntityOfPage\":{\"@id\":\"https://xchangeapi.com/docs/websocket/example-implementation#webpage\"},\"dateModified\":\"2025-12-28T22:45:32.969Z\",\"publisher\":{\"@id\":\"https://xchangeapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://xchangeapi.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"xChangeApi.com\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"xChangeApi.com\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/websocket/example-implementation.md","siteName":"xChangeApi.com","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"group":"Quickstart","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"HTTP API Quickstart","href":"/quickstart/http-api"},{"title":"WebSocket API Quickstart","href":"/quickstart/websocket-api"}]},{"title":"Authentication","href":"/authentication"},{"title":"Rate Limits","href":"/rate-limits"}]},{"group":"HTTP API Reference","pages":[{"group":"Live Data","pages":[{"title":"Latest rates","api":"GET latest?base={base}","href":"/http/live-data/latest"},{"title":"Single currency rate","api":"GET {format}/currencies/{currency-pair}","href":"/http/live-data/single-currency"},{"title":"Multiple currencies rates","api":"GET {format}/currencies?pairs={currency-pairs}","href":"/http/live-data/many-currencies"},{"title":"Symbols","href":"/http/metadata/symbols"}]},{"group":"Historical Data","pages":[{"title":"Historical rates","api":"GET historical/{date}","href":"/http/historical-data/historical"},{"title":"OHLC chart data for date range","api":"GET {format}/chart/{currency-pair}?starttime={starttime}\u0026endtime={endtime}","href":"/http/historical-data/ohlc-date-range"},{"title":"OHLC chart data for selected period","api":"GET {format}/chart/{currency-pair}/{period}","href":"/http/historical-data/ohlc-period"}]},{"group":"Currency Tools","pages":[{"title":"Currency conversion","api":"GET convert?amount={amount}\u0026from={from}\u0026to={to}","href":"/http/currency-tools/convert"}]},{"group":"Metadata","pages":[{"title":"Multipliers","api":"GET currencies/multipliers","href":"/http/metadata/multipliers"}]}]},{"group":"Websocket API Reference","pages":[{"title":"Protocol description","href":"/websocket/protocol"},{"title":"Available message codes","description":null,"href":"/websocket/message-codes"},{"title":"Example implementation","href":"/websocket/example-implementation"}]},{"group":"Guides \u0026 Recipes","pages":[{"title":"Available Currencies","description":"List of supported currency codes","href":"/guides/available-currencies"},{"title":"Available Cryptocurrencies","href":"/guides/available-cryptocurrencies"},{"title":"Data Formats","href":"/guides/response-formatting"},{"title":"Response Structures","href":"/guides/data-properties"},{"title":"Developer Best Practices","href":"/guides/best-practices"}]}]},"basePath":"","title":"Example implementation - xChangeApi.com","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}