API Documentation

Welcome to the Stock Stream Financial API eXchange documentation. Our API provides real-time and historical market data for stocks, ETFs, and indices from major exchanges worldwide.

Base URL

https://api.ssfax.cc/v1

Quick Start

Get started with SSFAX API in 3 simple steps:

  1. Sign up for an API key at ssfax.cc/signup
  2. Include your API key in the Authorization header
  3. Make your first API call

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.ssfax.cc/v1/quote/AAPL

Rate Limits

API rate limits vary by subscription plan:

Plan Requests/Day Requests/Second WebSocket Connections
Free 500 1 0
Professional 50,000 10 5
Enterprise Unlimited 100 Unlimited

Real-time Quote

Get the latest price and quote data for a specific symbol.

GET /quote/{symbol}

Parameters

Parameter Type Required Description
symbol string Yes Stock ticker symbol (e.g., AAPL, MSFT)

Example Request

GET https://api.ssfax.cc/v1/quote/AAPL

Example Response

{
  "symbol": "AAPL",
  "name": "Apple Inc.",
  "price": 182.63,
  "change": 2.15,
  "changePercent": 1.19,
  "volume": 48293847,
  "marketCap": 2845000000000,
  "open": 180.95,
  "high": 183.12,
  "low": 180.42,
  "previousClose": 180.48,
  "timestamp": "2025-01-15T16:00:00Z"
}

Historical Data

Retrieve historical price data for a symbol within a specified date range.

GET /historical/{symbol}

Parameters

Parameter Type Required Description
symbol string Yes Stock ticker symbol
from date Yes Start date (YYYY-MM-DD)
to date Yes End date (YYYY-MM-DD)
interval string No Data interval: 1d, 1h, 5m (default: 1d)

Technical Indicators

Access over 100 technical indicators calculated on our servers for optimal performance.

GET /indicators/{indicator}/{symbol}

Available Indicators

  • SMA (Simple Moving Average)
  • EMA (Exponential Moving Average)
  • RSI (Relative Strength Index)
  • MACD
  • Bollinger Bands
  • Stochastic Oscillator
  • ATR (Average True Range)
  • Volume Weighted Average Price
  • Fibonacci Retracement
  • And 90+ more...

WebSocket Streaming

Connect to our WebSocket API for real-time streaming market data with sub-second latency.

wss://stream.ssfax.cc/v1/stream?token=YOUR_API_KEY

Subscribe to Symbols

{
  "action": "subscribe",
  "symbols": ["AAPL", "GOOGL", "MSFT"],
  "channels": ["trades", "quotes", "bars"]
}

Message Format

{
  "type": "trade",
  "symbol": "AAPL",
  "price": 182.63,
  "size": 100,
  "timestamp": "2025-01-15T10:30:45.123Z",
  "exchange": "NASDAQ"
}

Python SDK

Install our official Python SDK for easy integration:

pip install ssfax-api

Quick Example

from ssfax import SSFAXClient

client = SSFAXClient(api_key="YOUR_API_KEY")

# Get real-time quote
quote = client.get_quote("AAPL")
print(f"AAPL Price: ${quote.price}")

# Get historical data
history = client.get_historical(
    symbol="AAPL",
    start="2025-01-01",
    end="2025-01-15"
)

# Stream real-time data
def on_trade(trade):
    print(f"{trade.symbol}: ${trade.price}")

client.stream(
    symbols=["AAPL", "GOOGL"],
    on_trade=on_trade
)