Our WebSocket-based streaming service provides real-time access to conference call transcripts, press releases, and more through a secure connection. Using an API token for authentication, you can subscribe to live transcripts, manage active streams, and test connectivity seamlessly. This service ensures you have up-to-the-second insights.
We hope this guide helps you get started with our Websockets. If you have any questions, please don’t hesitate to reach out to our support team. We’re here to assist you in setting up and optimizing your WebSocket connection!
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Finvera API Documentation","colors":{"primary":"#000000","light":"#d4d4d4","dark":"#000000"},"logo":{"light":"https://mintcdn.com/finvera/_kqdIAiytg7rcIvP/logo/light.svg?fit=max\u0026auto=format\u0026n=_kqdIAiytg7rcIvP\u0026q=85\u0026s=3a3618dd3aaa2b38e19fef12ce065bd3","dark":"https://mintcdn.com/finvera/_kqdIAiytg7rcIvP/logo/dark.svg?fit=max\u0026auto=format\u0026n=_kqdIAiytg7rcIvP\u0026q=85\u0026s=ba2f9e2b7d94388a0b7e1f703a6d5e13"},"favicon":"https://mintcdn.com/finvera/X8K9GU6Pq9b6T-6l/assets/favicon.svg?fit=max\u0026auto=format\u0026n=X8K9GU6Pq9b6T-6l\u0026q=85\u0026s=dd7eb4eddf39d34e51371768ff94103b","navbar":{"links":[{"href":"mailto:[email protected]","label":"Email Support"}],"primary":{"type":"button","label":"API Key Dashboard","href":"https://dashboard.finvera.ai/sign-up"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/finvera-ai","x":"https://x.com/finvera_ai"}},"integrations":{"ga4":{"measurementId":"G-RBKLTQKVYY"}},"contextual":{"options":["copy","view","cursor","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.finvera.ai/api-reference/introduction"},{"anchor":"Main Site","icon":"gear","href":"https://finvera.ai"},{"anchor":"Demo Site","icon":"newspaper","href":"https://news.finvera.ai"},{"anchor":"Dashboard","icon":"key","href":"https://dashboard.finvera.ai/sign-up"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finvera","hasAudioNarration":false,"actualSubdomain":"finvera","customDomains":["docs.finvera.ai"],"gitSource":{"type":"github","owner":"tjccapital","repo":"finvera-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a6ca8a3d399925cdfe49deb","collectionId":"42b2e2aa-88a3-491d-932e-6940729c73da","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a6ca8a3d399925cdfe49deb"},"entitlements":{},"buildId":"6ae926ab9c1b040527dfdaf2:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Websocket Reference","count":9},{"language":"default","tag":"Conference Call Transcripts","count":5},{"language":"default","tag":"Company Fundamentals","count":4},{"language":"default","tag":"Market Data","count":4},{"language":"default","tag":"Documentation","count":4},{"language":"default","tag":"API Documentation","count":3},{"language":"default","tag":"Company Logos","count":3},{"language":"default","tag":"Events","count":3},{"language":"default","tag":"Get Started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"ws-reference/stream-ws","slug":"/ws-reference/stream-ws","pageMetadata":{"title":"Streaming Introduction","description":"Real-time transcripts via WebSocket.","href":"/ws-reference/stream-ws"},"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: \"Real-time transcripts via WebSocket.\"\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`,strong:`strong`,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:[_jsx(Heading,{level:`1`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Our WebSocket-based streaming service provides real-time access to conference call transcripts, press releases, and more through a secure connection. Using an API token for authentication, you can subscribe to live transcripts, manage active streams, and test connectivity seamlessly. This service ensures you have up-to-the-second insights.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsx(Heading,{level:`3`,id:`1-establish-a-websocket-connection`,children:`1. Establish a WebSocket Connection`}),`\n`,_jsx(_components.p,{children:`Connect to our WebSocket endpoint using your preferred client:`}),`\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:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`wss://api.finvera.news`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`2-authenticate-your-session`,children:`2. Authenticate Your Session`}),`\n`,_jsx(_components.p,{children:`Include your API key as a query parameter in the connection URL:`}),`\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:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`wss://api.finvera.news?apikey`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`=yourApiKeyHere`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`3-establish-a-stable-connection`,children:`3. Establish a Stable Connection`}),`\n`,_jsxs(_components.p,{children:[`To ensure a stable connection, use the `,_jsx(_components.strong,{children:`ping`}),` action periodically to keep the WebSocket session active:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"action\"`}),_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:` }`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`You can also send an echo action to verify that the connection is responsive:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"echo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hello, World!\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`4-subscribe-to-a-symbol`,children:`4. Subscribe to a Symbol`}),`\n`,_jsx(_components.p,{children:`To start receiving real-time transcripts for a specific stock, use the subscribe action:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"action\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"symbol\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AAPL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`To subscribe to all available transcripts, use:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"action\"`}),_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:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"symbol\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`5-confirm-your-subscriptions`,children:`5. Confirm Your Subscriptions`}),`\n`,_jsx(_components.p,{children:`To check which transcripts you are actively subscribed to, use the subscribed action:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"subscribed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`supported-actions`,children:`Supported Actions`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Action`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Example Request`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`list`})}),_jsx(_components.td,{children:`Retrieve available transcripts`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"list\" }`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`subscribe`})}),_jsx(_components.td,{children:`Subscribe to a specific transcript`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"subscribe\", \"symbol\": \"AAPL\" }`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`subscribe`}),` (all)`]}),_jsx(_components.td,{children:`Subscribe to all available transcripts`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"subscribe\", \"symbol\": \"*\" }`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`subscribed`})}),_jsx(_components.td,{children:`Get a list of active subscriptions`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"subscribed\" }`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`unsubscribe`})}),_jsx(_components.td,{children:`Unsubscribe from a specific transcript`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"unsubscribe\", \"symbol\": \"AAPL\" }`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`unsubscribe`}),` (all)`]}),_jsx(_components.td,{children:`Unsubscribe from all transcripts`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"unsubscribe\", \"symbol\": \"*\" }`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`echo`})}),_jsx(_components.td,{children:`Test the connection`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"echo\", \"message\": \"test\" }`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`ping`})}),_jsx(_components.td,{children:`Maintain an active WebSocket session`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`{ \"action\": \"ping\" }`})})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`need-help`,children:`Need Help?`}),`\n`,_jsx(_components.p,{children:`We hope this guide helps you get started with our Websockets. If you have any questions, please don’t hesitate to reach out to our support team. We’re here to assist you in setting up and optimizing your WebSocket connection!`})]})}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":"Streaming Introduction","description":"Real-time transcripts via WebSocket.","href":"/ws-reference/stream-ws"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":1,"children":[]},{"title":"Getting Started","slug":"getting-started","depth":2,"children":[{"title":"1. Establish a WebSocket Connection","slug":"1-establish-a-websocket-connection","depth":3,"children":[]},{"title":"2. Authenticate Your Session","slug":"2-authenticate-your-session","depth":3,"children":[]},{"title":"3. Establish a Stable Connection","slug":"3-establish-a-stable-connection","depth":3,"children":[]},{"title":"4. Subscribe to a Symbol","slug":"4-subscribe-to-a-symbol","depth":3,"children":[]},{"title":"5. Confirm Your Subscriptions","slug":"5-confirm-your-subscriptions","depth":3,"children":[]}]},{"title":"Supported Actions","slug":"supported-actions","depth":2,"children":[{"title":"Need Help?","slug":"need-help","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"finvera","siteName":"Finvera API Documentation","title":"Streaming Introduction - Finvera API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-26T19:21:25.595Z","originalFileLocation":"ws-reference/stream-ws.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Real-time transcripts via WebSocket.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finvera API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_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/finvera/xZsNG5LLWKNjwfFG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Streaming Introduction - Finvera API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Real-time transcripts via WebSocket.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finvera API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.finvera.ai/ws-reference/stream-ws\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finvera.mintlify.app/_mintlify/api/og/v2?division=WSS+Documentation\u0026amp;title=Streaming+Introduction\u0026amp;description=Real-time+transcripts+via+WebSocket.\u0026amp;theme=3e9df35d5ed69abd67153d59\u0026amp;signature=2db1ad926586bb2a7cf6430d16a35a3398be26f79cade531ab70f87f6ae925d3\">\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=\"Streaming Introduction - Finvera API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Real-time transcripts via WebSocket.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finvera.mintlify.app/_mintlify/api/og/v2?division=WSS+Documentation\u0026amp;title=Streaming+Introduction\u0026amp;description=Real-time+transcripts+via+WebSocket.\u0026amp;theme=3e9df35d5ed69abd67153d59\u0026amp;signature=2db1ad926586bb2a7cf6430d16a35a3398be26f79cade531ab70f87f6ae925d3\">\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/finvera/xZsNG5LLWKNjwfFG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finvera API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.finvera.ai/ws-reference/stream-ws\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ws-reference/stream-ws.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.finvera.ai/#organization\",\"name\":\"Finvera API Documentation\",\"url\":\"https://docs.finvera.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finvera/_kqdIAiytg7rcIvP/logo/light.svg?fit=max\u0026auto=format\u0026n=_kqdIAiytg7rcIvP\u0026q=85\u0026s=3a3618dd3aaa2b38e19fef12ce065bd3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.finvera.ai#website\",\"name\":\"Finvera API Documentation\",\"url\":\"https://docs.finvera.ai\",\"publisher\":{\"@id\":\"https://docs.finvera.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.finvera.ai/ws-reference/stream-ws#webpage\",\"url\":\"https://docs.finvera.ai/ws-reference/stream-ws\",\"name\":\"Streaming Introduction\",\"description\":\"Real-time transcripts via WebSocket.\",\"dateModified\":\"2026-01-26T19:21:25.595Z\",\"isPartOf\":{\"@id\":\"https://docs.finvera.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.finvera.ai/ws-reference/stream-ws#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.finvera.ai/ws-reference/stream-ws#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Finvera API Documentation\",\"item\":\"https://docs.finvera.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Streaming Introduction\",\"item\":\"https://docs.finvera.ai/ws-reference/stream-ws\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.finvera.ai/ws-reference/stream-ws#article\",\"headline\":\"Streaming Introduction\",\"name\":\"Streaming Introduction\",\"description\":\"Real-time transcripts via WebSocket.\",\"url\":\"https://docs.finvera.ai/ws-reference/stream-ws\",\"mainEntityOfPage\":{\"@id\":\"https://docs.finvera.ai/ws-reference/stream-ws#webpage\"},\"dateModified\":\"2026-01-26T19:21:25.595Z\",\"publisher\":{\"@id\":\"https://docs.finvera.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.finvera.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Finvera API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Finvera API Documentation","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.finvera.ai/api-reference/introduction"},{"anchor":"Main Site","icon":"gear","href":"https://finvera.ai"},{"anchor":"Demo Site","icon":"newspaper","href":"https://news.finvera.ai"},{"anchor":"Dashboard","icon":"key","href":"https://dashboard.finvera.ai/sign-up"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Websocket Reference","groups":[{"group":"WSS Documentation","pages":[{"title":"Streaming Introduction","href":"/ws-reference/stream-ws"}]},{"group":"Real time Press Releases","pages":[{"title":"Low Latency Press Releases","description":"Unprocessed PRs that stream in the original (non-standard) format as to not add any additional latency for formatting processing. Expect ~5ms latency from publish timestamp to transmission.","asyncapi":"asyncapi/press-release-raw.yaml rawfeed","href":"/ws-reference/press-releases/ultrafast-low-latency-press-releases"},{"title":"Press Releases","asyncapi":"asyncapi/press-release.yaml feed","href":"/ws-reference/press-releases/get-real-time-press-releases"}]},{"group":"Real time Transcripts","pages":[{"title":"Real Time Transcripts","asyncapi":"asyncapi/transcripts.yaml stream","href":"/ws-reference/transcripts/get-real-time-transcripts"}]},{"group":"Real time Stocks","pages":[{"title":"Real Time Trades","asyncapi":"asyncapi/realtime-trades-quotes.yaml trades","href":"/ws-reference/market-data/realtime-trades"},{"title":"Real Time Quotes","asyncapi":"asyncapi/realtime-trades-quotes.yaml quotes","href":"/ws-reference/market-data/realtime-quotes"}]},{"group":"Delayed Stocks","pages":[{"title":"Delayed Trades","asyncapi":"asyncapi/delayed-trades-quotes.yaml trades","href":"/ws-reference/market-data/delayed-trades"},{"title":"Delayed Quotes","asyncapi":"asyncapi/delayed-trades-quotes.yaml quotes","href":"/ws-reference/market-data/delayed-quotes"}]},{"group":"True Value","pages":[{"title":"True Value","asyncapi":"asyncapi/true-value.yaml fmv","href":"/ws-reference/market-data/true-value"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Streaming Introduction - Finvera API Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}