API Keys
The Bitcompare API offers two access tiers: a free tier with no key required, and an authenticated tier with higher rate limits and usage tracking.
Free tier (no key)
All read endpoints work without authentication. Unauthenticated requests are rate-limited per IP at the Free-tier rate (30 requests per minute, 10,000 per month). See Rate Limiting for the full tier breakdown.
Unauthenticated request
curl https://api.bitcompare.net/api/v1/prices/BTC
This is ideal for prototyping, low-traffic integrations, and getting started quickly.
Authenticated tier (API key)
Pass your API key as a Bearer token in the Authorization header to unlock higher rate limits and per-key usage tracking.
- Name
Rate limit- Description
Scales with your plan — up to 300 requests per minute on Pro. See Rate Limiting for all tiers.
- Name
Usage tracking- Description
Per-key request counts, endpoint breakdowns, and daily usage history.
- Name
Chart endpoints- Description
Capped at 30 requests per minute on the Free tier; paid plans use their standard limit.
Key format
All consumer API keys are issued with a ck_live_ prefix followed by 64 hex characters (e.g., ck_live_a1b2c3d4...). Create and manage keys at the Bitcompare dashboard.
Passing the key
Include your API key as a Bearer token in the Authorization header on every request:
curl https://api.bitcompare.net/api/v1/prices/BTC \
-H "Authorization: Bearer ck_live_your_key_here"
Available scopes
API keys are issued with read-only scopes that control which endpoints the key can access:
- Name
rates:read- Description
Access rate endpoints — lending, borrowing, and staking yields.
- Name
analytics:read- Description
Access analytics endpoints — market summaries and aggregations.
- Name
clicks:read- Description
Access click-tracking endpoints — referral and outbound link data.
Rate limits by tier
| Plan | Requests / minute | Requests / month |
|---|---|---|
| Free (no key, per IP) | 30 | 10,000 |
| Starter | 60 | 50,000 |
| Growth | 120 | 200,000 |
| Pro | 300 | 1,000,000 |
| Enterprise | Custom | Custom |
Chart endpoints are additionally capped at 30 req/min on the Free tier. See Rate Limiting for headers and handling 429 responses, or pricing for the full plan comparison.
Security best practices
API keys grant elevated access to the Bitcompare API. Treat them like passwords.
- Never expose keys in client-side code — do not embed API keys in JavaScript that runs in the browser. Make API calls from your server or backend.
- Use environment variables — store keys in
.envfiles or your platform's secrets manager, not in source code. - Rotate keys regularly — if a key is compromised, revoke it immediately and generate a new one.
- Use separate keys per environment — create distinct keys for development, staging, and production from the dashboard so you can rotate and track usage independently.
- Restrict scopes — request only the scopes your application needs.