# Bitcoin Reference Rates API
> The value of one bitcoin expressed across every unit CoinGecko tracks — world fiat currencies, precious metals (gold and silver, troy ounce) and other cryptocurrencies, powered by the public CoinGecko exchange-rates feed, no key, nothing stored. This is the "Bitcoin standard" / unit-of-account view: not a coin's dollar price, but how much of each asset one BTC buys right now — 1 BTC in US dollars, euros and yen, in ounces of gold and silver, and in ether, satoshi and dozens more. The rates endpoint returns every unit with its value and asset type; the rate endpoint returns one specific unit (gold, the euro, ether); the groups endpoint splits the units into fiat, commodity and crypto so you can see what a bitcoin is worth across asset classes at a glance. This is the Bitcoin-denominated reference-index cut — distinct from the coin-price converters, the market-overview and the per-exchange ticker APIs in the catalogue.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/btcrates-api/..."
```

## Pricing
- **Free** (Free) — 30,000 calls/Mo, 3 req/s
- **Basic** ($6/Mo) — 330,000 calls/Mo, 12 req/s
- **Pro** ($18/Mo) — 1,300,000 calls/Mo, 30 req/s
- **Scale** ($44/Mo) — 4,200,000 calls/Mo, 65 req/s

## Endpoints

### Rates

#### `GET /v1/rates` — One BTC valued in every unit

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/btcrates-api/v1/rates"
```

**Response:**
```json
{
    "data": {
        "base": "BTC",
        "note": "Value is the amount of `unit` that one BTC is worth.",
        "count": 76,
        "rates": [
            {
                "name": "United Arab Emirates Dirham",
                "type": "fiat",
                "unit": "AED",
                "value": 229952.336
            },
            {
                "name": "Armenian Dram",
                "type": "fiat",
                "unit": "AMD",
                "value": 23064410.575
            },
            {
                "name": "Argentine Peso",
                "type": "fiat",
                "unit": "ARS",
                "value": 89442885.421
            },
            {
                "name": "Australian Dollar",
                "type": "fiat",
                "unit": "AUD",
                "value": 89521.803
            },
            {
                "name": "Bosnia and Herzegovina Convertible Mark",
                "type": "fiat",
                "unit": "BAM",
                "value": 106126.777
            },
            {
                "name": "Bitcoin Cash",
                "type": "crypto",
                "unit": "BCH",
                "value": 313.503
            },
            {
                "name": "Bangladeshi Taka",
                "type": "fiat",
                "unit": "BDT",
                "value": 7696509.624
            },
            {
                "name": "Bahraini Dinar",
                "type": "fiat",
                "unit": "BHD
…(truncated, see openapi.json for full schema)
```

### Rate

#### `GET /v1/rate` — One BTC valued in a single unit

**Parameters:**
- `unit` (query, required, string) — CoinGecko unit code Example: `xau`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/btcrates-api/v1/rate?unit=xau"
```

**Response:**
```json
{
    "data": {
        "base": "BTC",
        "name": "Gold - Troy Ounce",
        "type": "commodity",
        "unit": "XAU",
        "value": 15.337,
        "source": "CoinGecko"
    },
    "meta": {
        "timestamp": "2026-06-11T16:46:45.704Z",
        "request_id": "451dce90-1a8d-4c8a-82a7-ec7c608851bf"
    },
    "status": "ok",
    "message": "Rate retrieved successfully",
    "success": true
}
```

### Groups

#### `GET /v1/groups` — Units split into fiat, commodity, crypto

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/btcrates-api/v1/groups"
```

**Response:**
```json
{
    "data": {
        "base": "BTC",
        "fiat": [
            {
                "name": "United Arab Emirates Dirham",
                "type": "fiat",
                "unit": "AED",
                "value": 229952.336
            },
            {
                "name": "Armenian Dram",
                "type": "fiat",
                "unit": "AMD",
                "value": 23064410.575
            },
            {
                "name": "Argentine Peso",
                "type": "fiat",
                "unit": "ARS",
                "value": 89442885.421
            },
            {
                "name": "Australian Dollar",
                "type": "fiat",
                "unit": "AUD",
                "value": 89521.803
            },
            {
                "name": "Bosnia and Herzegovina Convertible Mark",
                "type": "fiat",
                "unit": "BAM",
                "value": 106126.777
            },
            {
                "name": "Bangladeshi Taka",
                "type": "fiat",
                "unit": "BDT",
                "value": 7696509.624
            },
            {
                "name": "Bahraini Dinar",
                "type": "fiat",
                "unit": "BHD",
                "value": 23615.071
            },
            {
                "name": "Bermudian Dollar",
                "type": "fiat",
                "unit": "BMD",
                "value": 62603.579
            },
            {
                "name":
…(truncated, see openapi.json for full schema)
```

### Meta

#### `GET /v1/meta` — Service metadata

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/btcrates-api/v1/meta"
```

**Response:**
```json
{
    "data": {
        "note": "BTC is the base (value 1). unit is a CoinGecko code (usd, eur, xau=gold, xag=silver, eth, sats=satoshi). Results are cached briefly to protect the keyless rate-limited upstream.",
        "source": "CoinGecko exchange rates (api.coingecko.com/api/v3/exchange_rates, live)",
        "btc_usd": 62603.579,
        "service": "btcrates-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/rate": "One BTC valued in a single unit (unit=xau, unit=usd, unit=eth).",
            "GET /v1/rates": "One BTC valued in every unit (fiat, commodity, crypto), sorted by code.",
            "GET /v1/groups": "Units split into fiat, commodity and crypto — what one BTC buys across asset classes."
        },
        "description": "The value of one bitcoin expressed across every unit CoinGecko tracks — world fiat currencies, precious metals (gold/silver, troy ounce) and other cryptocurrencies. The 'Bitcoin standard' / unit-of-account view: how much of each asset one BTC buys right now (1 BTC in dollars, euros, ounces of gold, ether, satoshi…). The rates endpoint returns every unit; the rate endpoint returns one unit; the groups endpoint splits units into fiat, commodity and crypto. Live, no key, nothing stored. The Bitcoin-denominated reference-index cut — distinct from the coin-price converters, market-overview and per-exchange APIs.",
        "upstream_status": "ok"
    },
    "meta": {
        "timestamp": "2026-06
…(truncated, see openapi.json for full schema)
```


---
Marketplace page: https://www.oanor.com/api/btcrates-api
OpenAPI spec: https://www.oanor.com/api/btcrates-api/openapi.json
