Developer API
Programmatic access to the same measured data the site runs on. Key-based, scoped, rate-limited — currently in preview while plans are finalized.
Authentication
Every request carries your key in the X-API-Key header. Keys are scoped — a key minted for prices cannot read patterns — and rate-limited per minute according to plan. Keys are issued by the Heriux team during the preview; request one through the contact page.
Endpoints
| Endpoint | Scope | Returns |
|---|---|---|
GET /api/v1/public/prices/{category}/{slug} | prices | Latest price, 24h change, volume and market cap for one asset, with its freshness classification. |
GET /api/v1/public/ohlcv/{category}/{slug}?timeframe=1d&limit=100 | ohlcv | Stored candles (1h / 4h / 1d), up to 500 per request. |
GET /api/v1/public/score/{category}/{slug} | score | Heriux Market Score with full component breakdown and algorithm version. |
GET /api/v1/public/patterns?category=crypto&timeframe=4H | patterns | Quality-gated confirmed chart patterns with backtested statistics. |
Errors and limits
Every error uses one shape: { "error": { "code": "...", "message": "..." } }. Missing key → 401 missing_api_key; wrong scope → 403 insufficient_scope; over budget → 429 rate_limited. Usage is metered per endpoint per day and visible to us both — the future billing model will be built on those meters, not on surprises.
Data honesty
The API serves exactly what the site serves: freshness-labeled prices, statistics with sample sizes and baselines, patterns only after the quality gate. Nothing in this API is investment advice.