Skip to main content (press enter to focus)

Capital at risk -- demo environment only.

This public experience streams signed, sandboxed market data for illustrative purposes. No live trading or performance guarantees.

<>
{}
()
[]
//
&&
API
>>
Back to Docs
RESTful API v1.0

API Reference

Build powerful trading automations with Hyper Trading's comprehensive REST API. Full documentation for programmatic access to strategies, bots, and analytics.

8+
Endpoints
<50ms
Latency
99.9%
Uptime
api-request.sh
$curl -X GET https://api.hyper-quant.tech/v1/status
{
"status": "operational",
"uptime": 99.98,
"latency_ms": 42
}

API Key Authentication

Secure API keys with customizable permissions and IP whitelisting.

Low Latency

Average response time under 50ms for real-time trading operations.

Rate Limiting

Generous rate limits with 1000 requests/minute for Pro users.

Webhooks

Real-time notifications for trades, signals, and system events.

Quick Start

1

Check API Status

curl -X GET https://api.hyper-quant.tech/v1/status
2

Authenticate with API Key

curl -X GET https://api.hyper-quant.tech/v1/strategies \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
3

Deploy a Strategy

curl -X POST https://api.hyper-quant.tech/v1/strategies/momentum-alpha/deploy \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pair": "BTC/USDT",
    "exchange": "binance",
    "risk_level": "medium",
    "position_size": 0.1
  }'

Authentication

API Key Security

All authenticated requests require a valid API key in the Authorization header. API keys can be created in your dashboard with granular permissions:

  • Read-only: View strategies, bots, and performance data
  • Trade: Start/stop bots and deploy strategies
  • Admin: Full API access including webhooks and settings

API Endpoints

MethodEndpointDescriptionAuth
GET/v1/statusCheck API status and get server time
GET/v1/strategiesList all available trading strategies
POST/v1/strategies/{id}/deployDeploy a strategy with custom parameters
GET/v1/botsList all active trading bots
POST/v1/bots/{id}/startStart a trading bot
POST/v1/bots/{id}/stopStop a trading bot
GET/v1/performanceGet performance metrics and statistics
GET/v1/tradesList trade history with filtering

Rate Limits

Free

100 requests/min

Burst: 10/sec

Pro

1,000 requests/min

Burst: 50/sec

Enterprise

10,000 requests/min

Burst: 500/sec

Official SDKs

Use our official SDKs for faster integration. Available for Python, JavaScript/TypeScript, and Go.

Python SDKJavaScript SDKGo SDK

📝 Full API Documentation Coming Soon: Complete endpoint documentation with request/response schemas, error codes, and interactive API explorer.Contact us to request early API access.