The HyperBasis API exposes the same data the terminal shows: 45 REST endpoints, a WebSocket stream, and HMAC-signed webhooks.
| Group | Endpoints |
|---|---|
| Deviation | /deviation, /deviation/batch, /deviation/history, /export/deviation.csv |
| Signals | /leaderboard, /yield, /alerts/extreme, /gap-risk |
| Market data | /assets, /microstructure, /risk_flags/{asset}, /borrow-costs, /macro-events |
| Funding & capacity | /oi-funding/history, /capacity/history |
| Whale & liquidation | /whale/positions, /whale/addresses, /whale/flows, /liquidation/map, /liquidation/vulnerability, /liquidation/events |
| Analytics | /backtest, /analytics/correlation, /analytics/regime |
| Platform | auth, webhooks, credits, billing, health, coverage |
wss://…/ws/v1/stream?api_key=…&assets=TSLA,NVDA streams live updates; usage is metered at 10 credits/hour.
Register a callback URL for events like extreme percentile alerts. Every delivery carries X-HyperBasis-Signature: sha256=HMAC-SHA256(secret, body) — verify it before trusting the payload.
Free tier: 100 requests/day. PRO: 10,000/day. Errors: 401 invalid key, 402 insufficient credits, 403 inactive/CORS, 422 bad parameters, 429 rate limited. Full reference in the API guide and Swagger docs.