Quickstart

This guide will get you set up and making your first request to the Bitcompare API. We'll resolve a symbol, fetch an aggregated price, and query current rates — all with cURL.

Base URL

All API services are available at:

https://api.bitcompare.net

Step 1: Resolve a symbol

Map a ticker to a canonical coin identifier.

GET

/api/v1/symbols/resolve

curl -G https://api.bitcompare.net/api/v1/symbols/resolve \  -d symbol=BTC

Response

{
  "resolved": true,
  "coingecko_id": "bitcoin",
  "confidence": 95,
  "method": "exchange_mapping"
}

Step 2: Fetch an aggregated price

Get the median price for a coin across multiple providers.

GET

/api/v1/prices/BTC

curl https://api.bitcompare.net/api/v1/prices/BTC```

```js {{ title: 'JavaScript' }}
const res = await fetch(
  'https://api.bitcompare.net/api/v1/prices/BTC')
const data = await res.json()
console.log(data)

Response

{
  "symbol": "BTC",
  "aggregated": {
    "symbol": "BTC",
    "price": 45000.50,
    "providers": 3,
    "min": 44950.00,
    "max": 45100.00,
    "median": 45000.50,
    "timestamp": "2025-10-29T14:00:00Z"
  }
}

Step 3: Query current rates

Get lending, borrowing, and staking rates across providers.

GET

/api/v1/rates

curl -G https://api.bitcompare.net/api/v1/rates \  -d symbol=USDC \
  -d category=lending

Response

{
  "rates": [
    {
      "provider": "aave",
      "symbol": "USDC",
      "category": "lending",
      "rate": 4.5,
      "unit_type": "percentage",
      "updated_at": "2025-10-29T14:00:00Z"
    }
  ],
  "count": 1,
  "timestamp": "2025-10-29T14:00:00Z"
}

Step 4: Authenticate (optional)

Add an API key to your requests for higher rate limits (1,000 req/min vs 60 req/min) and usage tracking. Pass the key in the X-API-Key header:

GET

/api/v1/prices/BTC

curl https://api.bitcompare.net/api/v1/prices/BTC \
  -H "X-API-Key: pk_live_your_key_here"

Steps 1–3 work without a key. See API Keys for full details on getting and managing keys.

What's next?

You're now making requests to the Bitcompare API. Here are some next steps: