Quickstart - Byul

WebSocket Connection Setup

Connect to real-time financial news streams using WebSocket API. Setup Steps:

Configure WebSocket client with API key authentication
Subscribe to filtered news streams
Handle real-time data events
Implement error handling and reconnection logic

Prerequisites

WebSocket requires Pro Plan ($99/month) or Enterprise Plan. Upgrade your plan if needed.

Step 1: Get Your API Key

Login to Byul API Dashboard
Your API key is automatically generated and displayed
Copy your API key (starts with byul_v2_)

Step 2: Install Dependencies

Node.js
Python
React

npm install socket.io-client

pip install python-socketio[asyncio-client]

npm install socket.io-client

Step 3: Create Your First Connection

Node.js
Python
React

const { io } = require('socket.io-client');

// Replace with your actual API key
const API_KEY = 'byul_api_key';

// Connect to WebSocket
const socket = io('wss://api.byul.ai/news-v2', {
  auth: { apiKey: API_KEY }
});

// Handle connection
socket.on('connect', () => {
  console.log('Connected to Byul WebSocket');
  
  // Subscribe to high-importance news
  socket.emit('news:subscribe', {
    minImportance: 7,
    startDate: '2024-01-01T00:00:00.000Z'
  });
});


// Handle incoming news
socket.on('news:data', (response) => {
  const { news } = response.data;
  
  news.forEach(article => {
    console.log(article.title);
    console.log(`Importance: ${article.importanceScore}/10`);
    console.log(`Category: ${article.category}`);
    console.log('---');
  });
});

// Handle authentication success
socket.on('auth:success', (data) => {
  console.log('Authenticated successfully:', data.user.plan);
});

// Handle errors
socket.on('news:error', (error) => {
  console.error('Error:', error.message);
});

console.log('Connecting to Byul WebSocket...');

import asyncio
import socketio


# Replace with your actual API key
API_KEY = 'byul_api_key'

sio = socketio.AsyncClient()

@sio.event
async def connect():
    print('Connected to Byul WebSocket')
    
    # Subscribe to high-importance news
    await sio.emit('news:subscribe', {
        'minImportance': 7,
        'startDate': '2024-01-01T00:00:00.000Z'
    })


@sio.on('news:data')
async def handle_news(response):
    news = response['data']['news']
    
    for article in news:
        print(article['title'])
        print(f"Importance: {article['importanceScore']}/10")
        print(f"Category: {article['category']}")
        print('---')

@sio.on('auth:success')
async def auth_success(data):
    print(f"Authenticated successfully: {data['user']['plan']}")

@sio.on('news:error')
async def news_error(error):
    print(f"Error: {error['message']}")

async def main():
    print('Connecting to Byul WebSocket...')
    
    await sio.connect('wss://api.byul.ai/news-v2', 
                      auth={'apiKey': API_KEY})
    await sio.wait()

if __name__ == '__main__':
    asyncio.run(main())

import React, { useState, useEffect } from 'react';
import { io } from 'socket.io-client';

// Replace with your actual API key
const API_KEY = 'byul_api_key';

function QuickstartNews() {
  const [news, setNews] = useState([]);
  const [status, setStatus] = useState('Connecting...');

  useEffect(() => {
    console.log('Connecting to Byul WebSocket...');
    
    const socket = io('wss://api.byul.ai/news-v2', {
      auth: { apiKey: API_KEY }
    });

    socket.on('connect', () => {
      console.log('Connected to Byul WebSocket');
      setStatus('Connected');
      
      // Subscribe to high-importance news
      socket.emit('news:subscribe', {
        minImportance: 7,
        startDate: '2024-01-01T00:00:00.000Z'
      });
    });


    socket.on('news:data', (response) => {
      const { news: newNews } = response.data;
      setNews(prev => [...newNews, ...prev].slice(0, 20)); // Keep latest 20
    });

    socket.on('auth:success', (data) => {
      console.log('Authenticated successfully:', data.user.plan);
      setStatus(`Connected (${data.user.plan})`);
    });

    socket.on('news:error', (error) => {
      console.error('Error:', error.message);
      setStatus(`Error: ${error.message}`);
    });

    return () => socket.close();
  }, []);

  return (
    <div style={{ padding: '20px', fontFamily: 'Arial, sans-serif' }}>
      <h2>Byul WebSocket Quickstart</h2>
      <p><strong>Status:</strong> <span style={{ 
        color: status.includes('Connected') ? 'green' : 
               status.includes('Error') ? 'red' : 'orange' 
      }}>{status}</span></p>
      
      <h3>Latest News ({news.length})</h3>
      {news.map(article => (
        <div key={article._id} style={{
          border: '1px solid #ddd',
          padding: '10px',
          margin: '10px 0',
          borderRadius: '5px'
        }}>
          <h4>{article.title}</h4>
          <p>Importance: {article.importanceScore}/10 | Category: {article.category}</p>
          <small>{new Date(article.date).toLocaleString()}</small>
        </div>
      ))}
      
      {news.length === 0 && status.includes('Connected') && (
        <p style={{ color: '#666' }}>Waiting for news updates...</p>
      )}
    </div>
  );
}

export default QuickstartNews;

Step 4: Run Your Code

Node.js
Python
React

node your-websocket-app.js

Expected output:

Connecting to Byul WebSocket...
Connected to Byul WebSocket!
Authenticated successfully: pro
Breaking: Fed Issues Emergency Statement
Importance: 10/10
Category: fed
---

python your-websocket-app.py

Expected output:

Connecting to Byul WebSocket...
Connected to Byul WebSocket!
Authenticated successfully: pro
Breaking: Fed Issues Emergency Statement
Importance: 10/10
Category: fed
---

npm start

Your browser will show a live-updating news feed with connection status.

Connection Complete

WebSocket connection established and receiving real-time news updates.

What’s Next?

Authentication

Learn about API key authentication and security best practices

Filtering News

Filter news by importance, symbols, and categories

Error Handling

Handle connection errors and implement retry logic

Production Examples

See production-ready implementation examples

Troubleshooting

Common Issues

Authentication Failed

Verify API key format (starts with byul_v2_)
Check API key at Dashboard
Confirm Pro or Enterprise plan access

WebSocket Not Supported

Requires Pro or Enterprise plan
Check current plan status

Connection Timeout

Verify network connectivity
Check firewall settings
Test from different network if needed

Additional Resources

Security: Use environment variables in production to store API keys securely:

export BYUL_API_KEY=byul_api_key

Getting Started

Connection

News

Error Handling

Examples

​WebSocket Connection Setup

​Prerequisites

​Step 1: Get Your API Key

​Step 2: Install Dependencies

​Step 3: Create Your First Connection

​Step 4: Run Your Code

​Connection Complete

​What’s Next?

Authentication

Filtering News

Error Handling

Production Examples

​Troubleshooting

​Common Issues

​Additional Resources

WebSocket Connection Setup

Prerequisites

Step 1: Get Your API Key

Step 2: Install Dependencies

Step 3: Create Your First Connection

Step 4: Run Your Code

Connection Complete

What’s Next?

Troubleshooting

Common Issues

Additional Resources