You need an API key. Create one from the
API key dashboard: a new account gets a one-time
trial of 7 days and 250 requests, and after it the key needs a plan from
/dashboard/billing (from $29/month). Store the key as
SHARPE_API_KEY.Make your first request
Authenticated API requests use the versionedhttps://www.sharpe.ai/api/v1/ prefix and require an Authorization header. Here is how to fetch current funding rates:
GET /v1/funding/rates?type=current
Response envelope
Every successful response wraps data in a consistent envelope:Success response
exchange field carries the venue display name (Binance, Gate.io), not a lowercase slug. Match on these values when filtering client-side.
The envelope always contains:
data: the requested payload (shape varies by endpoint)meta: request metadata withrequest_id,timestamp, andelapsed_ms
Error format
When something goes wrong, the API returns a flat RFC 9457 problem detail object:Error response
Common use cases
Common ways developers use the Sharpe API:Monitor funding rates for arbitrage
Fetchtype=current to scan for outlier funding rates, then use type=accumulated to see whether the rate has been persistently positive or negative over 7 to 30 days. Pair with the spot-perp arbitrage endpoint to surface opportunities automatically.
Build a market heatmap
Call the heatmap endpoint withmode=coins and a category like layer-1 or meme-token to get performance data across multiple timeframes in a single request. Each dot includes 24h, 7d, 30d, 1y, and 3y returns.
Portfolio correlation analysis
Use the correlation endpoint with a mix of crypto IDs and TradFi IDs (e.g.,bitcoin,ethereum,sp500,gold) to compute a correlation matrix. Choose a period of 90d or 1y to match your rebalancing horizon.
Track narrative rotation
The narratives and ecosystems endpoints return aggregated market cap, volume, and performance for sector-level groupings. Compare narrative-level 24h and 7d changes to spot which sectors capital is rotating into.Best practices
- Cache intentionally. Most endpoints return data that updates on a known schedule (current funding rates refresh every 5 minutes and heatmap data every 3 hours). Cache locally and respect
Cache-Controlheaders to avoid burning quota. - Use bulk responses. Endpoints like
/v1/funding/rates?type=currentreturn all symbols at once. Fetch once and filter client-side rather than making per-symbol requests. - Handle 429s gracefully. Read the
X-RateLimit-Resetheader (a Unix timestamp) and wait until that time before retrying. See the rate limits guide for details. - Include
X-Request-Idin support tickets. Every response includes this header. It lets us trace your exact request through our infrastructure. - Use separate keys per environment. Create distinct API keys for development, staging, and production so you can rotate or revoke them independently.

