Reference

API reference

Every public REST endpoint in one place — 118 endpoints across 14 categories, with real curl examples, response shapes, and the tier required to call them. Everything here is stable; breaking changes get a /v2 path.

Browse endpoints Get an API key

Quick start

The fastest path to a working request. No account needed — the fear & greed index is anonymous-tier. If this returns 200, everything else below will work once you have a key.

Requestbash

curl -sS "https://api.example.com/api/v1/sentiment/fear-greed?limit=5"

Responsejson

{
  "data": {
    "latest": {
      "ts": 1744761600000,
      "value": 62,
      "classification": "Greed"
    },
    "history": [
      { "ts": 1744243200000, "value": 54, "classification": "Neutral" },
      { "ts": 1744329600000, "value": 58, "classification": "Greed" }
    ]
  },
  "meta": { "total": 2, "limit": 5 }
}

For AI agents

If you are an LLM, an autonomous agent, or a human building one: these artefacts are the machine-readable version of this page. Same source of truth, no drift.

OpenAPI 3.1 spec

Every endpoint, every parameter, with examples and auth metadata. Drop into Postman, Insomnia, Stoplight, or any OpenAPI toolchain.

/openapi.json

llms.txt + llms-full.txt

LLM-ingestible discovery files following the llmstxt.org spec. The short file is an overview; the full file is every endpoint inlined for one-fetch ingestion.

/llms.txt /llms-full.txt

MCP server (coming soon)

Model Context Protocol server exposes every REST endpoint as a native tool for Claude Desktop, Cursor, Windsurf, Cline. Register interest on the MCP page.

/docs/mcp

ChatGPT plugin manifest

Legacy plugin spec still walked by several agent frameworks; points at the same OpenAPI + llms.txt files.

/.well-known/ai-plugin.json

Authentication

Anonymous-tier endpoints (fear & greed, status, symbols) are open. For every other endpoint you pass a bearer token on each request. Keys are prefixed cg_live_ — GitHub's secret scanner recognises this format and will warn you if you commit one.

1. Create a key

Head to API keys in your dashboard. The plaintext is shown once at creation — save it somewhere durable; we only ever store the hash.

2. Send it as Bearer

Every request includes the key in an Authorization header. Query-string auth is deliberately not supported — keeps keys out of server logs.

Authenticated requestbash

curl -sS "https://api.example.com/api/v1/liquidations?coin=BTC&limit=10" \
  -H "Authorization: Bearer cg_live_YOUR_KEY"

Rate limit headers

Every response carries live rate-limit counters — no need to track them client-side. Read X-RateLimit-Remaining before sending your next batch; back off when it approaches zero. On a 429 the server also sets Retry-After with the seconds until the window resets.

Response headersbash

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 294
X-RateLimit-Reset: 48
Retry-After: 48   (sent only on 429 responses)

Tier limits

The requests-per-minute budget for every tier. Full feature matrix and pricing lives on the pricing page.

Tier	Requests per minute	Window	Positioning
Anonymous	10	60s	No key. Open endpoints for tire-kicking and public dashboards.
Hobbyist	30	60s	Logged-in free tier. Enough for side projects and learning.
Startup	80	60s	Small teams and solo quant devs building weekend bots.
Standard	300	60s	Prop desks and production dashboards. The canonical tier.
Professional	1,200	60s	Funds and institutions — priority support, full history.
Enterprise	10,000	60s	Custom SLA, dedicated infra, WebSocket priority lane.

Endpoints

118 endpoints, grouped by domain. Click any row for the full reference — parameters, response shape, curl example, and tier.

Futures

Derivatives data across all major CEXs — liquidations, open interest, funding, long/short ratios.

GET

/api/v1/liquidations

Recent forced-close events across every derivatives exchange we ingest.

Code	HTTP	When it happens	What to do
BAD_PARAM	400	A query or path parameter failed validation (bad symbol, unknown enum, malformed expiry, etc.).	Re-check the endpoint's parameter table. Each parameter documents its allowed values and defaults.
UNKNOWN_UNDERLYING	404	The `:underlying` path segment on the options endpoint wasn't BTC or ETH.	Use `/api/v1/options/BTC` or `/api/v1/options/ETH`.
UNKNOWN_ASSET	404	The `:asset` path segment on the on-chain endpoint didn't match the expected short alphabetic form (2–8 letters).	Use uppercase codes like `BTC`, `ETH`, `SOL`. Avoid tickers with slashes, numbers, or punctuation.
RATE_LIMITED	429	You exceeded your tier's requests-per-minute budget. Headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` tell you where you are.	Back off until `X-RateLimit-Reset` seconds have elapsed, or upgrade tier. Honour the `Retry-After` header when present.
DB_ERROR	500	The database layer failed (libsql / SQLite unavailable, migration mid-flight, etc.). Message is deliberately opaque — server logs carry detail.	Retry with exponential backoff. If this persists, check `/api/v1/status` — a stalled adapter often precedes a DB issue.
INTERNAL_ERROR	500	An unexpected error — the catch-all for anything the route didn't classify itself.	Retry once; open a support ticket if it keeps happening with the same request shape.

API reference

Quick start

For AI agents

OpenAPI 3.1 spec

llms.txt + llms-full.txt

MCP server (coming soon)

ChatGPT plugin manifest

Authentication

1. Create a key

2. Send it as Bearer

Rate limit headers

Tier limits

Endpoints

Futures

Spot

Coins

Markets

Exchanges

Options

On-chain

ETFs

Sentiment

Indicators

Macro

Hyperliquid

DEX perps

Meta

Response envelope

Error codes