API Overview
ChartInspect v1 REST surfaces, discovery routes, authentication, parameters, and response conventions.
ChartInspect exposes versioned REST data at:
https://chartinspect.com/api/v1#Discovery
Use discovery instead of hardcoding asset or endpoint inventories:
| Route | Auth | Purpose |
|---|---|---|
GET /api/v1/chains | Public | Complete additive V1 assets, networks, metric counts, and freshness |
GET /api/public/catalog | Public | Endpoint IDs, categories, tiers, fields, and public metadata |
GET /api/v1/endpoints | API key | Authenticated endpoint registry |
GET /api/v1/openapi.json | Pro | OpenAPI 3.1 document generated from the shared catalog |
GET /api/v1/onchain/status?chain=... | Pro | Exact on-chain metric IDs and fields for one asset |
The Full Endpoint Reference is generated from the same catalog used by discovery, OpenAPI, and MCP. The contract suite fails if its checked-in output is stale.
#Authentication
Send x-api-key: YOUR_API_KEY or Authorization: Bearer YOUR_API_KEY. Only the public discovery routes above omit authentication. Each data route also checks the key's tier and permissions.
#Query Parameters
Parameters are capability-based. Never assume an endpoint accepts every item in this table.
| Parameter | Meaning |
|---|---|
days | Most recent number of days, usually capped at 3,650 |
limit | Maximum returned points, usually capped at 10,000 |
startDate | Inclusive lower date bound as YYYY-MM-DD |
endDate | Inclusive upper date bound as YYYY-MM-DD |
chain | Asset ID returned by /api/v1/chains |
format | json by default, or csv only where advertised |
fields | Comma-separated projection only where advertised; date keys are preserved |
dataResolution | Published on-chain resolution, only for capable metrics |
timeframe | Source-specific window, only where advertised |
Explicit date bounds take precedence over days. Either bound can be supplied independently; endDate includes the entire UTC calendar day. limit is then applied to the resulting rows. Source-specific routes may document additional parameters such as asset, series, tier, or cryptocurrency.
#Data Resolutions
Daily aliases are 1d and day1. Other published tokens can include block, min10, min30, hour1, hour4, hour12, day3, 1w, week1, 1M, month1, 3M, month3, 1y, and year1. Availability is per asset and metric. Unsupported requests return 404 with availableResolutions; they do not silently fall back to daily data.
Check the live Data Resolutions page or the per-chain manifest before requesting a token.
#Response Conventions
Default REST time-series responses commonly include:
{
"success": true,
"data": [],
"metadata": {}
}Discovery, snapshots, CSV downloads, certified chart datasets, and source-specific endpoints use documented shapes. Field names and timestamp units are not globally uniform across legacy sources. Prefer an ISO date field where present, inspect each endpoint's generated field list, and distinguish 10-digit Unix seconds from 13-digit Unix milliseconds by magnitude.
Field schemas describe known columns across assets and historical observations. Numeric series can contain decimals even when their first value is zero. Optional historical fields may be absent or null; additional columns can be introduced without removing existing fields. Some legacy datasets contain numeric strings, shown as string | number in the generated reference. A null is not a zero and should not be filled with zero when computing derived metrics.
A supported endpoint is not a guarantee that every producer is current. Compare the latest observation date with the dataset's expected cadence; weekly economic reports and live market quotes have different freshness expectations. metadata.timestamp is response time. On-chain lastUpdated and generatedAt describe the publication and can be later than the last complete daily observation.
#Categories
The current catalog covers on-chain metrics, certified chart datasets, crypto prices, market indicators, economic indicators, exchange reserves and ETF-related market series, derivatives, and live Socket.IO data. Browse the generated reference for the current inventory.