Full REST API reference
Base URL: https://api.trinityinsights.io. The paths below are absolute on this host and already carry the /api/v1 prefix.
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 |
catalog-public
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/catalog/metric/{slug}/full | Get Metric Full | Public |
| GET | /api/v1/catalog/metrics/sitemap | List Metrics For Sitemap | Public |
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/billing/withdrawal-request | Request Withdrawal | 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 |
cross-rubric
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/cross-rubric/alerts | Get Cross Rubric Alerts | Key |
| GET | /api/v1/cross-rubric/insight/{metric_id} | Get Cross Rubric Insight | 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 |
data-export
| Method | Path | Summary | Auth |
|---|---|---|---|
| POST | /api/v1/account/data-export | Request Data Export | Key |
| POST | /api/v1/account/data-export/download | Download Data Export | Key |
exchange-intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/exchange-intelligence/families | List Families | Key |
| GET | /api/v1/exchange-intelligence/families/{family} | List Family Charts | Key |
| GET | /api/v1/exchange-intelligence/metrics | List Metrics | Key |
| GET | /api/v1/exchange-intelligence/metrics/{metric_id}/data | Get Metric Data | Key |
| GET | /api/v1/exchange-intelligence/metrics/{metric_id}/metadata | Get Metric Metadata | 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 |
founding
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/founding/availability | Get Founding Availability | Public |
Hyperliquid
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/all | All Hyperliquid data in one call - tier-filtered | Key |
| GET | /api/v1/hyperliquid/book-depth | Near-mid order-book depth - Hyperliquid vs Binance | 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/flippenings | HL vs CEX flippening registry - BTC-perp open interest per venue | Key |
Hyperliquid (protocol economics)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/economics/overview | Protocol economics - measured AF buyback, implied revenue, supply dynamics | Key |
| GET | /api/v1/hyperliquid/economics/segments | Where protocol revenue comes from - measured total split by weighted segment volumes | Key |
| GET | /api/v1/hyperliquid/economics/valuation | HYPE valuation - buyback yield, P/S multiples, implied price bands | Key |
Hyperliquid (HYPE ETFs)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/etf/dashboard | HYPE spot ETF dashboard - universe, latest snapshot, ecosystem totals | Key |
| GET | /api/v1/hyperliquid/etf/history | HYPE spot ETF daily time series (per ticker, per metric) | Key |
| GET | /api/v1/hyperliquid/etf/history-all | HYPE spot ETF daily time series across all issuers (one metric) | Key |
Hyperliquid (HIP-3 DEXs)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/hip3/aggregates | HIP-3 cumulative KPIs (all-time volume, trades) + volume history | Key |
| GET | /api/v1/hyperliquid/hip3/by-dex | HIP-3 per-DEX OI/volume + market share | Key |
| GET | /api/v1/hyperliquid/hip3/by-symbol | HIP-3 per-symbol breakdown for a given builder DEX | Key |
| GET | /api/v1/hyperliquid/hip3/dashboard | HIP-3 ecosystem dashboard - total OI, volume, per-DEX breakdown | Key |
| GET | /api/v1/hyperliquid/hip3/oi-trends | HIP-3 open interest time series (ecosystem or per-DEX) | Key |
| GET | /api/v1/hyperliquid/hip3/share | HIP-3 share of total HL perp volume + top markets by OI | Key |
Hyperliquid (HIP-4 prediction markets)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/hip4/by-outcome | HIP-4 single-outcome drill-down - per-side probability + volume time series | Key |
| GET | /api/v1/hyperliquid/hip4/dashboard | HIP-4 prediction markets - outcomes with implied probabilities, volume | Key |
| GET | /api/v1/hyperliquid/hip4/history | HIP-4 ecosystem daily time series (aggregate volume + trades by snapshot) | Key |
Hyperliquid (HYPE token)
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/hyperliquid/hype/buy-pressure | HYPE structural buy pressure - AF buyback + ETF flows + DAT vs float | Key |
| GET | /api/v1/hyperliquid/hype/candles | HYPE OHLCV daily series | Key |
| GET | /api/v1/hyperliquid/hype/dashboard | HYPE token dashboard - structural, AF buyback, composite, bridges | Key |
| GET | /api/v1/hyperliquid/hype/history | HYPE daily time series (per allowed metric) | 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-cross-rubric
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/insights/cross-rubric/composites-snapshot | Get Composites Snapshot | Key |
| GET | /api/v1/insights/cross-rubric/cycle-phase | Get Cycle Phase | Key |
| GET | /api/v1/insights/cross-rubric/insights | Get Cross Rubric Insights | 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 |
market-intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/market-intelligence/asset/{canonical_slug} | Get Asset Detail | Key |
| GET | /api/v1/market-intelligence/asset/{canonical_slug}/ohlc | Get Asset Ohlc | Key |
| GET | /api/v1/market-intelligence/assets | List Assets | Key |
| GET | /api/v1/market-intelligence/deltas | Get Deltas | Key |
| GET | /api/v1/market-intelligence/derivatives | Top crypto derivatives snapshot (Coinalyze aggregated cross-exchange) | Key |
| GET | /api/v1/market-intelligence/fear-greed | Canonical Fear & Greed Index (Alternative.me) - current + 90d history (Pro tier) | Key |
market-intelligence-tokenized
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/market-intelligence/tokenized/asset/{slug} | Tokenized asset drill-down detail (Performance+ tier required) | Key |
| GET | /api/v1/market-intelligence/tokenized/asset/{slug}/ohlc | Tokenized asset OHLC candles (HIP-3 candleSnapshot OR CoinGecko OHLC dispatch) | Key |
| GET | /api/v1/market-intelligence/tokenized/compliance-map | Compliance map snapshot 4-quadrants (Free tier visible) | Key |
| GET | /api/v1/market-intelligence/tokenized/premium-watch | Live cross-wrapper premium watch (top N) | Key |
| GET | /api/v1/market-intelligence/tokenized/universe | Universe of tokenized markets assets (tier-gated) | 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 |
mcp-api-keys
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/mcp/api-keys/{key_id} | Revoke an MCP API key | Key |
| GET | /api/v1/mcp/api-keys | List my MCP API keys | Key |
| GET | /api/v1/mcp/api-keys/analytics | My Trinity Data usage analytics | Key |
| GET | /api/v1/mcp/api-keys/usage | My Trinity Data credit usage | Key |
| POST | /api/v1/mcp/api-keys | Create a new MCP API key | Key |
| POST | /api/v1/mcp/api-keys/{key_id}/rotate | Rotate an MCP API key | Key |
Narrative intelligence
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/narrative-intelligence/catalog | List Narrative Catalog | Key |
| GET | /api/v1/narrative-intelligence/categories | List Narrative Categories | Key |
| GET | /api/v1/narrative-intelligence/metrics/{metric_id}/data | Get Narrative Metric Data | 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/cohort-conviction/{slug} | Get Cohort Conviction | Key |
| 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}/{metric_id}/intraday | Get Metric Intraday | Key |
| GET | /api/v1/price-intelligence/{asset}/klines | Get Intraday Klines | 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 |
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/{indicator}/page-payload | Get Indicator Page Payload | 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 |
Real-time streaming
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/stream/scores | Stream Scores | Key |
| GET | /api/v1/stream/scores/snapshot | Scores Snapshot | Key |
team
| Method | Path | Summary | Auth |
|---|---|---|---|
| DELETE | /api/v1/team/members/{member_id} | Remove Member | Key |
| GET | /api/v1/team/invite/{token} | Preview Invite | Key |
| GET | /api/v1/team/members | List Members | Key |
| POST | /api/v1/team/invite | Create Invite | Key |
| POST | /api/v1/team/invite/{invite_id}/revoke | Revoke Invite | Key |
| POST | /api/v1/team/invite/{token}/accept | Accept Invite | Key |
treasuries
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/treasuries/public | Get Treasuries Hub | Key |
| GET | /api/v1/treasuries/public/{slug} | Get Treasury Entity | Key |
| GET | /api/v1/treasuries/public/sparklines | Get Treasuries Sparklines | Key |
Trial
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/trial/status | Trial Status | Key |
trinity-composites
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /api/v1/trinity-composites/live | Get Trinity Composites Live | 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 |
| GET | /api/v1/users/me/newsletter-preferences | Get Newsletter Preferences | Key |
| PATCH | /api/v1/users/me/newsletter-preferences | Update Newsletter Preferences | Key |
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.