Developer API

A REST/JSON API for the BTC yield curve, credit surface, market context, and the Gavel-native and on-chain indicators — so you don’t have to index the chain and compute these yourself.

Free and open. The Gavel Protocol API requires no key and carries no charge. Aletheia Analytics operates the reference deployment; commercial data products will follow when the market has the depth to make them meaningful.

Quick start

$ curl "https://api.thegavel.io/v1/credit/yield-curve?pair=WBTC/USDC&points=true" { "pair": "WBTC/USDC", "computed_at": "2026-06-29T14:30:00Z", "rates": { "7d": 4.82, "30d": 6.12, "90d": 7.23, "365d": 8.15 }, "fit": { "r_squared": 0.94, "data_point_count": 847 } }

Base URL

Access

No key required. Every endpoint below is public — auction data, protocol state, current indicator values and the canonical yield curve, served without authentication and without charge, with full history. Rate limits are for infrastructure protection, not a billing meter: 300 requests/minute (burst 600) and 100,000/day per IP. Over the limit the API returns 429 with Retry-After and X-RateLimit-* headers — back off and retry.

Cross-venue data moved

This API serves one venue — this one. Measurement across the Bitcoin-collateralised credit markets moved to The Bitcoin Credit Stack on 30 August 2026: /v1/market/*, /v1/venues/*, /v1/onchain/*, /v1/indicators/*, /v1/stablecoins/*, /v1/macro/*, /v1/prices/*, /v1/rates/* and /v1/defi-rates/*.

They 301 rather than fail, so every existing caller keeps working — keys and access unchanged — and each response carries Deprecation, Sunset: 20 January 2027 and a Link: rel="successor-version". The flat paths this page used to list — /v1/yield-curve, /v1/tci and the rest — 301 to their /v1/credit/* form on this host, under the same Sunset.

/v1/credit/* stays here. Those are Gavel-derived assessments, and where they belong is an open question rather than a settled one: a signed REST disposition table is owed, and until it exists nothing about them moves.

Errors

All endpoints are GET and return JSON. Non-2xx responses carry a body of the form:

{ "error": { "code": "string", "message": "human-readable detail" } }

A representative selection. The canonical doc above is the complete, authoritative surface — endpoint availability evolves as new indicators ship, so check /health and live responses for what’s currently available on each environment.

Bulk download (CSV)

The full history as two static files, regenerated nightly — free, no key, and not rate-limited. One download instead of paginating the API.

Auction observations are on-chain and free to redistribute. The indicator series carries its provenance in a leading comment and a sibling indicators.meta.json.

Prefer the raw data?

This API serves derived market data. For the underlying raw protocol data — auctions, loans, and events read directly from the contracts — see the On-Chain Data guide ↗.