API Reference

The Quantum Trader API provides programmatic access to stock data, strategy management, backtesting, and portfolio tracking.

Base URL

http://localhost:8501/api/v1

Interactive Documentation

Swagger UI

Interactive API explorer at /api/v1/docs

ReDoc

Beautiful API documentation at /api/v1/redoc

API Sections

Authentication

JWT-based authentication with access and refresh tokens. Learn more →

Stock Data

OHLCV data with automatic interval aggregation. Learn more →

Indicators

Technical indicators with customizable parameters. Learn more →

Strategies

Create and manage trading strategies. Learn more →

Backtests

Run and analyze strategy backtests. Learn more →

Portfolios

Manage portfolios and positions. Learn more →

Tickers

Manage tracked symbols and data collection. Learn more →

Task Queue

Background task management and monitoring. Learn more →

Quick Start

1. Authenticate

curl -X POST http://localhost:8501/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "[email protected]", "password": "your_password"}'

2. Use the Access Token

curl http://localhost:8501/api/v1/strategies \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

3. Fetch Stock Data

curl "http://localhost:8501/api/v1/stocks/AAPL/ohlcv?interval=1d&limit=100"

Response Format

All responses are JSON with consistent structure:

Success

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Strategy",
  "created_at": "2025-01-15T10:30:00Z"
}

Error

{
  "detail": "Strategy not found"
}

Paginated

{
  "items": [...],
  "total": 100,
  "limit": 50,
  "offset": 0
}

HTTP Status Codes

Code	Description
200	Success
201	Created
204	No Content (successful deletion)
400	Bad Request (validation error)
401	Unauthorized (invalid/missing token)
403	Forbidden (insufficient permissions)
404	Not Found
422	Unprocessable Entity
429	Too Many Requests (rate limited)
500	Internal Server Error

Rate Limiting

Caution

Data provider rate limits apply when fetching market data:

• Massive (Polygon): 5 calls/min
• Alpha Vantage: 5 calls/min, 25/day
• yfinance: Variable (frequently limited)

SDK Examples

JavaScript

import axios from 'axios';

const api = axios.create({
  baseURL: 'http://localhost:8501/api/v1',
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

// Fetch strategies
const { data: strategies } = await api.get('/strategies');

// Create backtest
const { data: backtest } = await api.post('/backtests', {
  strategy_id: strategies[0].id,
  symbols: ['AAPL'],
  start_date: '2024-01-01',
  end_date: '2024-12-31',
  initial_capital: 100000
});

Python

import requests

BASE_URL = "http://localhost:8501/api/v1"
headers = {"Authorization": f"Bearer {access_token}"}

# Fetch strategies
strategies = requests.get(
    f"{BASE_URL}/strategies",
    headers=headers
).json()

# Create backtest
backtest = requests.post(
    f"{BASE_URL}/backtests",
    headers=headers,
    json={
        "strategy_id": strategies[0]["id"],
        "symbols": ["AAPL"],
        "start_date": "2024-01-01",
        "end_date": "2024-12-31",
        "initial_capital": 100000
    }
).json()

cURL

# Login
TOKEN=$(curl -s -X POST http://localhost:8501/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "[email protected]", "password": "pass"}' \
  | jq -r '.access_token')

# Fetch strategies
curl http://localhost:8501/api/v1/strategies \
  -H "Authorization: Bearer $TOKEN"

# Create backtest
curl -X POST http://localhost:8501/api/v1/backtests \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "strategy_id": "UUID_HERE",
    "symbols": ["AAPL"],
    "start_date": "2024-01-01",
    "end_date": "2024-12-31",
    "initial_capital": 100000
  }'

Next Steps

• Authentication → - Set up JWT authentication
• Stock Data → - Fetch market data
• Strategies → - Create trading strategies
• Best Practices → - Learn API best practices