Skip to main content

WebSocket API

Real-time financial news streaming through WebSocket connections. Endpoint: wss://api.byul.ai/news-v2

Features

  • Real-time news delivery
  • Event-based messaging
  • Subscription filtering
  • Automatic reconnection
  • Error handling

Authentication

Authenticate using your API key in the connection options:

Events

Client to Server:
  • news:subscribe - Subscribe to news stream
  • news:unsubscribe - Unsubscribe from stream
  • news:unsubscribe:all - Unsubscribe from all
Server to Client:
  • auth:success - Authentication confirmed
  • news:data - Real-time news articles
  • news:subscribed - Subscription confirmed
  • news:error - Error notifications

Plan Requirements

WebSocket streaming requires Pro or Enterprise plan.

Quick Example

Next Steps

Quickstart

Connect and start streaming

Examples

Code examples in multiple languages

Authentication

API key authentication setup

Connection

Connection management guide