# WhatToMine API
> Live multi-coin crypto mining economics — no key needed. For every mineable coin: its algorithm, current network difficulty and hashrate, block reward and block time, the coin's exchange rate in BTC, market cap, a relative profitability index and the estimated 24h BTC revenue. List all coins ranked by how profitable they are to mine right now, look one coin up by ticker or name, or pull the coins for a specific mining algorithm (KawPow, Ethash, RandomX, Scrypt, Autolykos…) — or the full algorithm list with coin counts. Data comes live from the public WhatToMine feed — nothing stored. This is mining-economics data across the whole GPU/ASIC coin complex, distinct from the Bitcoin-only mining API and from the exchange-ticker and on-chain APIs in the catalogue. Built for mining dashboards, profitability switchers, rig tooling and analytics.

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

## Pricing
- **Free** (Free) — 22,800 calls/Mo, 3 req/s
- **Starter** ($9/Mo) — 298,000 calls/Mo, 10 req/s
- **Growth** ($25/Mo) — 1,305,000 calls/Mo, 25 req/s
- **Scale** ($58/Mo) — 4,620,000 calls/Mo, 50 req/s

## Endpoints

### Coin

#### `GET /v1/coin` — Full mining stats for one coin

**Parameters:**
- `tag` (query, optional, string) — Coin ticker Example: `RVN`
- `name` (query, optional, string) — Coin name Example: `Ravencoin`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/whattomine-api/v1/coin?tag=RVN&name=Ravencoin"
```

### Coins

#### `GET /v1/coins` — All mineable coins ranked by profitability

**Parameters:**
- `algorithm` (query, optional, string) — Filter by algorithm Example: `KawPow`
- `limit` (query, optional, string) — Max results (1-500) Example: `100`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/whattomine-api/v1/coins?algorithm=KawPow&limit=100"
```

### Algorithm

#### `GET /v1/algorithm` — Coins for an algorithm, or all algorithms

**Parameters:**
- `algorithm` (query, optional, string) — Mining algorithm (omit for full list) Example: `KawPow`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/whattomine-api/v1/algorithm?algorithm=KawPow"
```

### Meta

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

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


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