Skip to main content

​
Overview

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.

​
Getting Started

​
1. Establish a WebSocket Connection

Connect to our WebSocket endpoint using your preferred client: 
wss://api.finvera.news

​
2. Authenticate Your Session

Include your API key as a query parameter in the connection URL: 
wss://api.finvera.news?apikey=yourApiKeyHere

​
3. Establish a Stable Connection

To ensure a stable connection, use the ping action periodically to keep the WebSocket session active: 
{ "action": "ping" }
You can also send an echo action to verify that the connection is responsive: 
{ "action": "echo", "data": "Hello, World!" }

​
4. Subscribe to a Symbol

To start receiving real-time transcripts for a specific stock, use the subscribe action: 
{ "action": "subscribe", "symbol": "AAPL" }
To subscribe to all available transcripts, use: 
{ "action": "subscribe", "symbol": "*" }

​
5. Confirm Your Subscriptions

To check which transcripts you are actively subscribed to, use the subscribed action: 
{ "action": "subscribed" }

​
Supported Actions

ActionDescriptionExample Request
listRetrieve available transcripts{ "action": "list" }
subscribeSubscribe to a specific transcript{ "action": "subscribe", "symbol": "AAPL" }
subscribe (all)Subscribe to all available transcripts{ "action": "subscribe", "symbol": "*" }
subscribedGet a list of active subscriptions{ "action": "subscribed" }
unsubscribeUnsubscribe from a specific transcript{ "action": "unsubscribe", "symbol": "AAPL" }
unsubscribe (all)Unsubscribe from all transcripts{ "action": "unsubscribe", "symbol": "*" }
echoTest the connection{ "action": "echo", "message": "test" }
pingMaintain an active WebSocket session{ "action": "ping" }

​
Need Help?

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!