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.
- Endpoints
- 4
- Auth
- API key
- Status
- Preview
Programmatic access to the same measured data the site runs on. Key-based, scoped, rate-limited — currently in preview while plans are finalized.
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.
# every request carries your key curl https://heriux.com/api/v1/public/prices/crypto/bitcoin \\ -H "X-API-Key: YOUR_KEY"
/api/v1/public/prices/{category}/{slug}pricesLatest price, 24h change, volume and market cap for one asset, with its freshness classification./api/v1/public/ohlcv/{category}/{slug}?timeframe=1d&limit=100ohlcvStored candles (1h / 4h / 1d), up to 500 per request./api/v1/public/score/{category}/{slug}scoreHeriux Market Score with full component breakdown and algorithm version./api/v1/public/patterns?category=crypto&timeframe=4HpatternsQuality-gated confirmed chart patterns with backtested statistics.{ "error": { "code": "...", "message": "..." } }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.
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.