RabbitStockAPI 🐰📈

A high-performance stock API built with Bun that fetches real-time stock data from Trading212 and serves it through both REST API and WebSocket connections.

Features

• 🚀 Blazing Fast - Built with Bun for optimal performance
• 📊 Real-time Data - Automatically updates stock prices every 10 seconds
• 🔌 WebSocket Support - Live streaming of price updates via WebSocket
• 🔐 Secure - Proper authentication with Trading212 API
• 🐳 Docker Ready - Easy deployment with Docker and Docker Compose
• 🏥 Health Checks - Built-in monitoring and health endpoints
• 💰 Multi-currency - Supports stocks from different currencies
• 🔄 Auto-restart - Automatic recovery on failures

Quick Start

Prerequisites

• Docker and Docker Compose
• Trading212 API credentials

Environment Variables

Create a .env file in your project root:

# Server Configuration
SERVER_HOST="0.0.0.0"
SERVER_PORT=3000

# Trading212 API Credentials
# Get these from your Trading212 account dashboard
TRADING212_API_KEY=your_trading212_api_key_here
TRADING212_API_SECRET=your_trading212_api_secret_here

# Trading212 API Update Interval (in milliseconds)
# Minimum: 5000 (5 seconds) due to Trading212 API limits
# Default: 10000
UPDATE_INTERVAL=10000

# Logging Configuration
# 0 = ERROR, 1 = WARN, 2 = AUDIT, 3 = INFO, 4 = HTTP, 5 = DEBUG, 6 = VERBOSE, 7 = SILLY
# Default: 3 (INFO) - Recommended: 3 for production, 5 for development
LOGGER_LEVEL=3

# Proxy Configuration
# Important: Set this to match your deployment environment to prevent IP spoofing
# Options: "aws" (AWS ELB/ALB), "azure" (Azure), "cloudflare" (Cloudflare),
#          "gcp" (Google Cloud), "nginx" (Nginx), "vercel" (Vercel),
#          "direct" (no proxy/development), "development" (dev with proxy headers)
# Default: "direct"
PROXY=direct

Running with Docker Compose

services:
  rabbitstockapi:
    image: rabbitcompany/rabbitstockapi:latest
    container_name: rabbitstockapi
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - TRADING212_API_KEY
      - TRADING212_API_SECRET
      - UPDATE_INTERVAL
      - LOGGER_LEVEL
      - PROXY
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3000"]
      interval: 10s
      timeout: 3s
      retries: 3
      start_period: 5s

Run the service:

docker-compose up -d

Manual Docker Run

docker run -d \
  --name rabbitstockapi \
  -p 3000:3000 \
  -e TRADING212_API_KEY=your_key \
  -e TRADING212_API_SECRET=your_secret \
	-e UPDATE_INTERVAL=10000 \
	-e LOGGER_LEVEL=3 \
	-e PROXY=direct \
  rabbitcompany/rabbitstockapi:latest

API Endpoints

GET /

Health Check

{
	"program": "RabbitStockAPI",
	"version": "4.0.0",
	"sourceCode": "https://github.com/Rabbit-Company/RabbitStockAPI",
	"monitorStats": {
		"stocksCount": 22,
		"instrumentsCount": 12810,
		"updateInterval": "10000ms"
	},
	"httpStats": {
		"pendingRequests": 1
	},
	"websocketStats": {
		"connections": 2,
		"subscribers": {
			"VOW3d": 0,
			"NET": 2,
			"MSFT": 0,
			"ASMLa": 0,
			"V": 1,
			"UBNT": 2,
			"SMSDl": 0,
			"FB": 0,
			"DAId": 0,
			"TSLA": 1,
			"AMZN": 0,
			"AMD": 1,
			"AAPL": 0,
			"GOOGL": 0,
			"WISEl": 0,
			"NVDA": 0,
			"MMM": 0,
			"OXLC": 0,
			"STX": 1,
			"GGRGl": 0,
			"CCIV": 0,
			"MO": 0
		}
	},
	"lastUpdate": "2025-11-01T22:38:14.552Z"
}

GET /prices

Stock prices data (REST API)

{
	"stocks": {
		"VOW3d": {
			"price": 89.93,
			"currency": "EUR",
			"updated": 1761918633611
		},
		"NET": {
			"price": 241.77,
			"currency": "USD",
			"updated": 1761918633611
		},
		"UBNT": {
			"price": 785.08,
			"currency": "USD",
			"updated": 1761918633611
		},
		"AMD": {
			"price": 258.66,
			"currency": "USD",
			"updated": 1761918633611
		},
		"STX": {
			"price": 260.59,
			"currency": "USD",
			"updated": 1761918633611
		}
	}
}

WebSocket /ws

Real-time stock price streaming via WebSocket

Connect

ws://your-server:3000/ws

Welcome message (on open)

When you connect, the server will send a welcome message:

{
	"event": "connected",
	"message": "Welcome! Use { action: 'subscribe', symbols: ['UBNT', 'NET'] } to receive price updates for specified symbols."
}

Supported client actions

Clients send JSON messages to the server to control subscriptions or check health:

1) Subscribe

Client to Server

{
	"action": "subscribe",
	"symbols": ["UBNT", "NET"]
}

Server to Client response (successful subscribe):

{
	"event": "subscribed",
	"symbols": ["UBNT", "NET"]
}

If any supplied symbols are invalid (unknown), they are filtered out of the symbols list in the response. If symbols is missing or not an array, server returns an error object.

2) Unsubscribe

Client to Server

{
	"action": "unsubscribe",
	"symbols": ["NET"]
}

Server to Client response (successful unsubscribe):

{
	"event": "unsubscribed",
	"symbols": ["NET"]
}

3) Ping (health check)

Client to Server

{ "action": "ping" }

Server to Client

{ "event": "pong", "timestamp": 1003104000000 }

Error responses

If the message is invalid JSON or missing required fields, the server replies:

{ "event": "error", "message": "Invalid JSON" }
{ "event": "error", "message": "Missing 'action' field" }
{ "event": "error", "message": "Expected 'symbols' array" }
{ "event": "error", "message": "Unknown action" }

On close, the server may send:

{ "event": "disconnected", "message": "Connection closed." }

Update messages (server to subscribers)

The server publishes updates per symbol using the event: "update" envelope. Example per-symbol publish:

{
	"event": "update",
	"symbol": "UBNT",
	"data": {
		"price": 785.97,
		"currency": "USD",
		"updated": 1003104000000
	}
}

Example WebSocket client

const ws = new WebSocket("ws://localhost:3000/ws");

ws.onopen = () => {
	console.log("Connected to RabbitStockAPI WebSocket");
	ws.send(JSON.stringify({ action: "subscribe", symbols: ["UBNT", "NET"] }));
};

ws.onmessage = (event) => {
	const data = JSON.parse(event.data);
	console.log("WS message:", data);
	// handle event: "connected", "subscribed", "update", "error", "pong", ...
};

ws.onclose = () => console.log("Disconnected from RabbitStockAPI");