API Reference Documentation

The QuantSignal Research REST API provides high-frequency access to quantitative ML signals, orderflow metrics, backtesting performance, and real-time market data.

All request bodies should be JSON formatted, and responses return application/json with standard HTTP status codes.

Authentication

All authenticated endpoints require an HTTP Bearer Token header using the JWT retrieved from the /api/v1/login endpoint or your dashboard API Key.

Authorization: Bearer <YOUR_API_TOKEN>

POST /api/v1/login

Authenticate with email and password to receive a Bearer session token.

Request Parameters

FieldTypeDescription
email string Registered work email address (Required)
password string Account password (Required)
two_factor_code string 6-digit 2FA authenticator code if enabled

POST /api/v1/register

Create a new trader account and initiate a 14-day free trial tier.

Request Parameters

FieldTypeDescription
name string Trader or Fund full name
email string Valid email address
password string Password (min 8 chars)
plan string starter, pro, or enterprise

GET /api/v1/signals

Retrieve active high-confidence trading signals generated by the machine learning engine.

Query Parameters

ParameterTypeDescription
symbol string Filter by trading pair (e.g. BTC/USDT)
min_confidence float Minimum confidence score threshold (e.g. 80.0)
limit integer Number of records returned (default 50, max 200)

WebSocket Live Stream

For high-frequency algorithmic trading, connect to our low-latency WebSocket endpoint:

wss://quant-signal-research.com/ws/v1/signals

HTTP Response & Error Codes

CodeStatusMeaning
200 OK Success Request processed successfully.
400 Bad Request Validation Error Missing parameters or malformed JSON payload.
401 Unauthorized Auth Failed Invalid API Key or expired Bearer token.
429 Rate Limit Throttled API limit exceeded for active subscription tier.
Request & Response
# Fetch active BTC/USDT signals curl -X GET "https://quant-signal-research.com/api/v1/signals?symbol=BTC/USDT&min_confidence=85.0" \ -H "Authorization: Bearer qs_live_99f24e10b4a" \ -H "Accept: application/json" # 200 OK Response Payload: { "status": "success", "timestamp": 1776412934, "count": 1, "data": [ { "id": "sig_btc_9942a", "symbol": "BTC/USDT", "side": "LONG", "entry_price": 67420.00, "target_price": 69500.00, "stop_loss": 66200.00, "confidence": 94.2, "timeframe": "15m", "status": "ACTIVE" } ] }