Getting Started
Quick Start Guide
Get up and running with the Nexus Glass API in under 5 minutes.
Prerequisites
Create an account & get your API key
Sign up for free and choose your tier: STREAM, QUANT, PULSE, or ORACLE. Your API key is generated instantly.
Authenticate with X-API-Key header
All authenticated endpoints require the X-API-Key header.
Authentication
Include your API key in every request using the X-API-Key header. The system health endpoint (/api/health) is the only unauthenticated endpoint.
X-API-Key: your_api_key_here
Security: Never share your API key in client-side code, public repositories, or URLs. Use environment variables and server-side proxies.
Make Your First Request
Let's fetch real-time open interest data for BTC. This STREAM-tier endpoint returns aggregated OI from all 11 connected exchanges.
curl -s "https://nexusglass.live/api/v1/oi/BTCUSDT" \ -H "X-API-Key: YOUR_API_KEY" | jq .
Example Response
{
"symbol": "BTCUSDT",
"total_oi_usd": 42500000000,
"oi_change_1h_pct": 1.2,
"oi_change_24h_pct": -3.5,
"breakdown": [
{ "exchange": "Binance", "oi_usd": 12500000000 },
{ "exchange": "Bybit", "oi_usd": 8200000000 },
{ "exchange": "OKX", "oi_usd": 6800000000 }
]
}Explore Endpoints
Here are some popular endpoints to try next:
/api/v1/real-liquidations/recentSTREAM/api/v1/market/funding/BTCUSDTSTREAM/api/v1/whale-hunter/statsQUANT/api/v1/heatmap?symbol=BTCUSDTQUANT/api/v1/intelligence/summary?symbol=BTCUSDTPULSEBase URL & Response Format
Base URL
https://nexusglass.liveWebSocket
wss://nexusglass.live/wsAll responses are JSON with Content-Type: application/json.
Timestamps follow ISO 8601 format (2026-03-17T10:30:00Z).
Gzip compression is applied automatically. Response payloads are ~4x smaller.