ClankerFinance · Public API · USD

Programmatic access to the same firehose we trade on.

Read-only REST. Plaintext keys stored on our side, sent in the X-API-Key header (or ?key= query parameter). Free tier is unconditional — request a key from /api/v1/keys/issue and start. Tier limits compound by quota and freshness; pick the lowest tier whose staleness budget beats the edge you're harvesting.

Google SSO not configured.

Set NEXT_PUBLIC_GOOGLE_CLIENT_ID in .env.local and add the same client id to GOOGLE_CLIENT_ID on the Public API server.

# .env.local
NEXT_PUBLIC_GOOGLE_CLIENT_ID=1234567890-abcdef.apps.googleusercontent.com

# server env:
GOOGLE_CLIENT_ID=1234567890-abcdef.apps.googleusercontent.com

Get a client id at Google Cloud → APIs → Credentials. Type: Web application. Authorized origins: https://clankerfinance.ai + http://localhost:3010.

Free

Plaintext key. Rate-limited per IP. Use it forever.

60 requests / minute
60-second response staleness budget
3 keys max per public IP
All read endpoints (spreads, latency matrix, fees, predictions, markets)
Free CSV download for historic OHLCV — no key, no limit

Pro

$49 / mo

For the active retail trader or a small bot fleet.

600 requests / minute (10× free)
5-second staleness budget
50 keys per organisation IP
All endpoints, including draft beta endpoints
Email support, 1 business-day SLA

Edge

$499 / mo

For prop shops and serious quants who need fresh data.

6,000 requests / minute (100× free)
1-second staleness budget
500 keys per organisation
Webhook delivery + SSE streams for spread + latency channels
Priority routing through the geographically nearest 🤖 oracle node

HFT (co-located)

$4,990 / mo

Sub-second feeds. Co-located near our sequencer.

60,000 requests / minute
50ms staleness budget — same data we trade on internally
Direct binary feed off the C++ sequencer ring buffer
WebSocket multiplexed sub to L3 deltas, top-N venues
Dedicated support channel + monthly latency audits

Endpoints

v1 — stable

Method	Path	Description
GET	/api/v1/health	Liveness probe. No key required.
GET	/api/v1/tiers	Returns the pricing matrix above as JSON.
GET	/api/v1/keys/issue	Issue a free key. POST or GET, ?email=opt.
GET	/api/v1/spread/{base}	Live cross-venue spreads for one base asset (e.g. /spread/BTC).
GET	/api/v1/latency/matrix	PoP×exchange latency matrix used by the cockpit globe.
GET	/api/v1/fees	Maker/taker schedule across every venue we cover.
GET	/api/v1/predictions	Forward predictions stamped with feature rationale.
GET	/api/v1/markets/{symbol}	USD-denominated OHLCV (daily). Returns JSON.
GET	/api/v1/markets/{symbol}/csv	Same data as CSV file. No key, no rate cap.

Quick start

# 1. Issue a free key (one-time)
curl https://clankerfinance.ai/api/v1/keys/issue?email=you@domain.tld
# → { "ok": true, "key": "cf_free_xxxxxxxxxxxx", "tier": "free", "rate_per_min": 60 }

# 2. Use it
curl https://clankerfinance.ai/api/v1/spread/BTC \
     -H "X-API-Key: cf_free_xxxxxxxxxxxx"

# 3. CSV download — no key needed
curl https://clankerfinance.ai/api/v1/markets/BTC/csv -o BTC_USD_daily.csv

Why these tiers

The free tier is the same data you can pull manually — we just remove the friction. Paid tiers exist because the bottom of our stack — the sequencer, the latency mesh, the L3 capture — costs real money to run. The four price points map to how stale you can afford your data to be: 60-second-old spreads are useful for research, 5-second for retail, 1-second for prop, sub-second for HFT. See the same data live in the Strategy Builder.