# FX Cross-Rate Heatmap & Matrix API
> The full grid of every major currency against every other, with the day's move in each cell, computed live from Yahoo Finance (no key, nothing stored). It is the dashboard every FX desk keeps open: an 8x8 matrix of the majors (USD, EUR, GBP, JPY, CHF, AUD, CAD, NZD) showing the cross rate and the percentage change on the day for every pair at once, so you can see in a single glance which currencies are bid and which are offered across the board. The matrix endpoint returns the whole rate grid plus the matching change-on-the-day heatmap, and derives the strongest and weakest currency from their average move against the basket. The cross endpoint returns one pair's rate and daily change. The currencies endpoint lists what is covered. The FX cross-rate matrix / heatmap cut — distinct from the bring-your-own-rates cross-rate & triangular-arbitrage calculator, the currency-strength meter (one aggregate score per currency) and the single-pair price APIs. It is the whole board, live.

## 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/fxheatmap-api/..."
```

## Pricing
- **Free** (Free) — 1,200 calls/Mo, 2 req/s
- **Starter** ($9/Mo) — 28,000 calls/Mo, 6 req/s
- **Pro** ($28/Mo) — 135,000 calls/Mo, 18 req/s
- **Business** ($68/Mo) — 650,000 calls/Mo, 45 req/s

## Endpoints

### Matrix

#### `GET /v1/matrix` — Full 8x8 cross-rate grid + daily-change heatmap + strongest/weakest

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

### Cross

#### `GET /v1/cross` — One cross rate and daily change

**Parameters:**
- `base` (query, required, string) — Base currency Example: `EUR`
- `quote` (query, required, string) — Quote currency Example: `JPY`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/fxheatmap-api/v1/cross?base=EUR&quote=JPY"
```

### Currencies

#### `GET /v1/currencies` — Supported currencies

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

### Meta

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

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


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