QuantSynergy API Documentation

Introduction

QuantSynergy API provides programmatic access to real-time and historical cryptocurrency market data, advanced quantitative metrics, and multi-exchange aggregation services. Our API enables developers to build sophisticated trading applications, analytics dashboards, and financial services platforms.

Key Features

• Real-time Market Data: Live prices, volumes, and market metrics from multiple exchanges
• Historical Data: OHLCV candlestick data with multiple timeframes
• Multi-Exchange Aggregation: Unified data from Binance, Bybit, Bitget, and Kraken
• Advanced Analytics: Quantitative metrics, correlation analysis, and market dynamics
• Futures Data: Open interest and funding rates across exchanges

Authentication

QuantSynergy API uses API Key authentication. All requests must include valid authentication headers.

Getting Your API Key

Once registered on QuantSynergy, go to your Account Settings to find your Free tier API key, which is automatically generated when you create your account.

Request Headers

All API requests must include:

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/currencies" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Rate Limits

To ensure fair usage and system stability, QuantSynergy API implements rate limiting on all endpoints.

When you exceed your rate limit, you'll receive a 429 Too Many Requests response. Implement exponential backoff when receiving 429 responses.

Currencies API

List Currencies

Retrieve a list of all available cryptocurrencies with real-time prices and market data.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/currencies?exchange=all" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Markets (Paginated)

Retrieve paginated market data with comprehensive cryptocurrency information. Results are automatically sorted by market cap in descending order.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/currencies/markets?page=1&per_page=100&exchange=all" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Global Market Cap

Retrieve global cryptocurrency market cap with 7-day trend data.

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/currencies/global-market-cap" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Sparkline Data

Retrieve 7-day sparkline price data for a specific cryptocurrency.

Path Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/currencies/sparklines/BTC" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Batch Sparkline Data

Retrieve sparkline data for multiple cryptocurrencies in a single request.

Request Body

{
  "symbols": ["BTC", "ETH", "ADA", "SOL"]
}

Example Request

curl -X POST "https://api.quantsynergy.xyz/api/currencies/sparklines-batch" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"symbols": ["BTC", "ETH", "ADA"]}'

Pair API

Get OHLCV Data

Retrieve historical OHLCV (Open, High, Low, Close, Volume) candlestick data for a trading pair.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/pair?base=BTC&quote=USDT&timeframe=1d&exchange=binance&fullHistory=true" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Markets API

Get Real-Time Prices

Retrieve real-time prices for all or specific cryptocurrencies.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/markets?symbol=BTC" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Compare Prices Across Exchanges

Compare prices for a cryptocurrency across all supported exchanges.

Path Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/markets/compare/BTC" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Market Statistics

Retrieve statistics about market coverage and exchange distribution.

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/markets/stats" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Synergy Metrics API

Get Comprehensive Metrics

Retrieve comprehensive quantitative metrics and market analysis for a cryptocurrency.

Path Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/synergy-metrics/comprehensive/BTC" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Futures Data (All Exchanges)

Retrieve aggregated futures data (open interest and funding rates) from all supported exchanges.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/synergy-metrics/futures/all-exchanges?symbol=BTC" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Datafeed API (TradingView Integration)

The Datafeed API provides TradingView UDF (Universal Data Feed) compatibility for integrating QuantSynergy data with TradingView charts.

Get Configuration

Retrieve TradingView UDF datafeed configuration.

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/datafeed/config" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Get Historical Data

Retrieve historical OHLCV data in TradingView format.

Query Parameters

Example Request

curl -X GET "https://api.quantsynergy.xyz/api/datafeed/history?symbol=BTCUSDT&from=1705276800&to=1705363200&resolution=D" \
  -H "Authorization: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

Error Handling

All API errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {
      "field": "additional error details"
    }
  }
}

HTTP Status Codes

Error Codes