Introduction

A brief introduction to real-time data streaming WebSocket API.

Welcome to WebSocket API documentation. This guide will help you get started with accessing real-time data streams, enabling you to subscribe to continuous updates on Conference Calls and other key insights.

WebSocket Endpoint

All WebSocket connections can be established using the following endpoint:

wss://api.getaltdata.com

Authentication

The WebSocket API requires apikey authentication. When initiating a WebSocket connection, include your API token in the connection URL as a query parameter. Include your API token in the apikey query param in the format:

apikey: <token>.

Subscribing to Streams

Once connected, you can subscribe to specific data streams based on your requirements, such as stock quotes, trade data, or news updates. Each subscription requires a unique identifier and specific parameters depending on the data type.

Example Subscription Message

To subscribe to a live stock quote stream, send a JSON message formatted as follows:

{
  "action": "subscribe",
  "symbol": "AAPL",
  "type": "quote"
}

---

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.