DOCUMENTATION

Complete guide to QuantRegime platform and APIs

Categories

QUICK START

WebSocket Connection

// Connect to QuantRegime WebSocket
const ws = new WebSocket('wss://api.quantregime.ai/ws');

ws.on('open', () => {
  // Subscribe to price updates
  ws.send(JSON.stringify({
    action: 'subscribe',
    channels: ['trades', 'orderbook'],
    symbols: ['BTCUSDT', 'ETHUSDT']
  }));
});

ws.on('message', (data) => {
  const update = JSON.parse(data);
  console.log('Price update:', update);
});

REST API

// REST API Example
import axios from 'axios';

const API_KEY = 'your-api-key';
const BASE_URL = 'https://api.quantregime.ai/v1';

// Get market data
const getMarketData = async (symbol) => {
  const response = await axios.get(`${BASE_URL}/market/${symbol}`, {
    headers: { 'X-API-Key': API_KEY }
  });
  return response.data;
};

// Place order
const placeOrder = async (order) => {
  const response = await axios.post(`${BASE_URL}/orders`, order, {
    headers: { 'X-API-Key': API_KEY }
  });
  return response.data;
};

API ENDPOINTS

GET/market/tickerGet current ticker prices
GET/market/orderbook/:symbolGet order book depth
GET/market/trades/:symbolGet recent trades
POST/ordersPlace a new order
DELETE/orders/:idCancel an order
GET/account/balanceGet account balance
GET/account/positionsGet open positions
GET/account/historyGet trade history

RATE LIMITS

REST API

1200/min

Per IP address

WebSocket

100 streams

Per connection

Order Placement

10/sec

Per account

AVAILABLE SDKs

FREQUENTLY ASKED QUESTIONS

How do I get started with the API?

First, create an account and generate an API key from your dashboard settings. Then install our SDK using npm or pip and follow the quick start guide above.

What exchanges are supported?

We currently support Binance, Coinbase Pro, Kraken, and 10+ other major exchanges. Full list available in the exchange integration section.

Is there a sandbox environment for testing?

Yes, we provide a full sandbox environment with simulated trading. Use the sandbox API endpoint and test API keys to develop without risk.

How do WebSocket subscriptions work?

WebSocket connections allow real-time data streaming. Connect to our WebSocket endpoint, authenticate with your API key, and subscribe to specific data channels.