Full REST API reference
Each endpoint documents its parameters, responses, error codes and three ready-to-paste code samples (cURL, Python, JavaScript). The reference is rebuilt on every release from the OpenAPI specification — no manual counts, no hardcoded dates.
Common authentication: every endpoint returning tier-gated data accepts the X-API-Key header or a Clerk JWT. See Authentication and Rate limits.
Alerts (legacy)
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/alerts/{alert_id} | Delete Alert | Key |
| GET | /api/v1/alerts | List Alerts | Key |
| GET | /api/v1/alerts/stream | Stream Alerts | Key |
| GET | /api/v1/alerts/stream/status | Stream Status | Key |
| PATCH | /api/v1/alerts/{alert_id} | Update Alert | Key |
| POST | /api/v1/alerts | Create Alert | Key |
Alerts (v2)
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/alerts/v2/{alert_id} | Delete Alert | Key |
| DELETE | /api/v1/alerts/v2/channels/{channel_type} | Delete Channel | Key |
| GET | /api/v1/alerts/v2 | List Alerts | Key |
| GET | /api/v1/alerts/v2/{alert_id} | Get Alert | Key |
| GET | /api/v1/alerts/v2/{alert_id}/history | Get Alert History | Key |
| GET | /api/v1/alerts/v2/channels | List Channels | Key |
API keys
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/users/me/api-keys/{key_id} | Revoke API key | Key |
| GET | /api/v1/users/me/api-keys | List my API keys | Key |
| POST | /api/v1/users/me/api-keys | Create API key | Key |
| POST | /api/v1/users/me/api-keys/{key_id}/rotate | Rotate API key | Key |
Ask Trinity
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/ask/suggestions | Get Suggestions | Public |
| POST | /api/v1/ask | Ask | Key |
Backtest
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/backtest/runs | List Backtest Runs | Key |
| POST | /api/v1/backtest/run | Run Backtest | Key |
Checkout
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/invoices | List Invoices | Key |
| GET | /api/v1/paddle/prices | Get Paddle Prices | Public |
| POST | /api/v1/billing-portal | Create Billing Portal | Key |
| POST | /api/v1/paddle/ensure-customer | Ensure Paddle Customer | Key |
Cointime
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/cointime/metrics | List Cointime Metrics | Key |
| GET | /api/v1/cointime/metrics/{metric_id}/data | Get Cointime Metric Data | Key |
Consent
| Method | Path | Summary | Auth |
|---|---|---|---|
| POST | /api/v1/consent | Record Consent | Key |
Conviction
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/conviction/current | Get Current Conviction | Key |
| GET | /api/v1/conviction/history | Get Conviction History Endpoint | Key |
| POST | /api/v1/conviction/compute | Trigger Conviction Compute | Key |
Cycle (compat)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/cycle/compare | Compare Cycles | Key |
| GET | /api/v1/cycle/history | Get Cycle History | Key |
| GET | /api/v1/cycle/position | Get Cycle Position | Key |
Cycle intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/cycle-intelligence/catalog | List Cycle Catalog | Key |
| GET | /api/v1/cycle-intelligence/categories | List Cycle Categories | Key |
| GET | /api/v1/cycle-intelligence/metrics/{metric_id}/data | Get Cycle Metric Data | Key |
| GET | /api/v1/cycle-intelligence/pipeline/status | Get Cycle Pipeline Status | Key |
Dashboard features
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/dashboards/{dashboard_id}/comments/{comment_id} | Delete a comment | Key |
| DELETE | /api/v1/dashboards/{dashboard_id}/follow | Unfollow a public dashboard | Key |
| DELETE | /api/v1/dashboards/{dashboard_id}/journal/{entry_id} | Delete journal entry | Key |
| GET | /api/v1/dashboards/{dashboard_id}/briefing | Get morning briefing (top changes) | Key |
| GET | /api/v1/dashboards/{dashboard_id}/comments | List dashboard comments | Key |
| GET | /api/v1/dashboards/{dashboard_id}/journal | List journal entries | Key |
Dashboards
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/dashboards/{dashboard_id} | Delete a dashboard | Key |
| GET | /api/v1/dashboards | List user dashboards | Key |
| GET | /api/v1/dashboards/{dashboard_id} | Get a dashboard by ID | Key |
| GET | /api/v1/dashboards/public | List public dashboards (gallery) | Public |
| GET | /api/v1/dashboards/share/{slug} | Get a public dashboard by share slug | Public |
| POST | /api/v1/dashboards | Create a new dashboard | Key |
Factors
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/factor/saved | List Saved Factors | Key |
| POST | /api/v1/factor/generate | Generate Factor | Key |
Foresight
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/foresight/calibration/{asset}/{timeframe} | Get Foresight Calibration | Key |
| GET | /api/v1/foresight/chunks/{chunk_id} | Get Foresight Chunk | Key |
| GET | /api/v1/foresight/history/{asset}/{timeframe} | Get Foresight History | Key |
| GET | /api/v1/foresight/manifest/{asset}/{timeframe} | Get Foresight Manifest | Key |
Hyperliquid
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/all | All Hyperliquid data in one call — tier-filtered | Key |
| GET | /api/v1/hyperliquid/btc-price-history | BTC/USD price history — Binance public API (commercial use OK) | Key |
| GET | /api/v1/hyperliquid/clearinghouse | Hyperliquid clearinghouse state — institutional solvency monitor | Key |
| GET | /api/v1/hyperliquid/fear-greed/history | HL Fear & Greed Index historical scores for charting | Key |
| GET | /api/v1/hyperliquid/funding | Hyperliquid full funding rate matrix + extremes detection | Key |
| GET | /api/v1/hyperliquid/hip3 | HIP-3 tokenized stocks & ETFs — 24/7 price discovery | Key |
Indicators
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/indicators | List Indicators | Key |
| GET | /api/v1/indicators/{slug} | Get Indicator | Key |
| GET | /api/v1/indicators/{slug}/data | Get Indicator Data | Key |
Insights Lab (compat)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/insights-lab | Get Insights Lab | Key |
Macro (compat)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/macro/business-cycle | Get Business Cycle | Public |
| GET | /api/v1/macro/business-cycle/history | Get Business Cycle History | Public |
| GET | /api/v1/macro/correlations | List Correlations | Key |
| GET | /api/v1/macro/correlations/{pair} | Get Correlation Detail | Key |
| POST | /api/v1/macro/compute | Trigger Correlation Compute | Key |
Macro intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/macro-intelligence/catalog | List Macro Catalog | Key |
| GET | /api/v1/macro-intelligence/categories | List Macro Categories | Key |
| GET | /api/v1/macro-intelligence/events | List Macro Events | Key |
| GET | /api/v1/macro-intelligence/metrics/{metric_id}/data | Get Macro Metric Data | Key |
| GET | /api/v1/macro-intelligence/pipeline/status | Get Macro Pipeline Status | Key |
| GET | /api/v1/macro-intelligence/sentinel/status | Get Sentinel Macro Status | Key |
MCP proxy
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/mcp/tools | Discover available MCP tools | Key |
| POST | /api/v1/mcp/call | Invoke an MCP tool | Key |
Old coins
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/old-coins/count | Old Coin Count | Key |
| GET | /api/v1/old-coins/events | Old Coin Events | Key |
On-chain Bitcoin
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/onchain/catalog | List Onchain Catalog | Key |
| GET | /api/v1/onchain/categories | List Onchain Categories | Public |
| GET | /api/v1/onchain/events | List Onchain Events | Key |
| GET | /api/v1/onchain/metrics/{metric_id}/data | Get Onchain Metric Data | Key |
| GET | /api/v1/onchain/pipeline/status | Get Pipeline Status | Key |
Price intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/price-intelligence/{asset}/{metric_id} | Get Metric Data | Key |
| GET | /api/v1/price-intelligence/{asset}/ohlcv | Get Ohlcv | Key |
| GET | /api/v1/price-intelligence/assets | List Assets | Public |
| GET | /api/v1/price-intelligence/categories | List Categories | Public |
| GET | /api/v1/price-intelligence/cross/{metric_id} | Get Cross Asset Metric | Key |
Prices
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/prices/ohlc/{asset} | Get Price Ohlc | Key |
Referrals
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/referrals/code | Get Referral Code | Key |
| GET | /api/v1/referrals/stats | Get Stats | Key |
| POST | /api/v1/referrals/link | Link To Referrer | Key |
Market regime
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/regime/current | Get Current Regime | Key |
| GET | /api/v1/regime/history | Get Regime History | Key |
Aggregate scores
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/scores/{indicator}/history | Get Indicator History | Key |
| GET | /api/v1/scores/{indicator}/latest | Get Indicator Latest | Key |
| GET | /api/v1/scores/detailed | Get Detailed Scores | Key |
| GET | /api/v1/scores/insights-lab | Get Insights Lab | Key |
| GET | /api/v1/scores/latest | Get Latest Scores | Key |
Scores (compat)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/scores/{indicator}/history | Get Indicator History | Key |
| GET | /api/scores/{indicator}/latest | Get Indicator Latest | Key |
| GET | /api/scores/detailed | Get Detailed Scores | Key |
| GET | /api/scores/insights-lab | Get Insights Lab | Key |
| GET | /api/scores/latest | Get Latest Scores | Key |
Real-time streaming
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/stream/scores | Stream Scores | Key |
| GET | /api/v1/stream/scores/snapshot | Scores Snapshot | Key |
Trial
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/trial/status | Trial Status | Key |
User accounts
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/users/me | Delete My Data | Key |
| GET | /api/v1/users/me | Get Me | Key |
| GET | /api/v1/users/me/export | Export My Data | Key |
Webhooks
| Method | Path | Summary | Auth |
|---|---|---|---|
| POST | /api/v1/webhooks/clerk | Clerk Webhook | Public |
| POST | /api/v1/webhooks/paddle | Paddle Webhook | Public |
Institutional disclaimer
Trinity Insights is an educational and analytical tool. Content does not constitute investment advice. Trinity Insights is not a Crypto-Asset Service Provider (CASP) registered under MiCA Regulation (EU) 2023/1114. See the full disclaimer.