> ## Documentation Index
> Fetch the complete documentation index at: https://docs.core3.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Exchanges Data API

> REST API for exchange listings, dashboards, listed assets, PoL scores, ratings, and search—served behind the CORE3 gateway at exchanges_data.

The **Exchanges Data** service exposes JSON endpoints for CORE3 exchange intelligence: aggregate and per-exchange Probability of Loss (PoL), ratings, transparency and solvency sections, listed assets, and search. Public traffic reaches it through the CORE3 **API gateway**, which mounts the service under the `exchanges_data` path prefix (mirroring how [Projects Data API](/projects-data-api) uses `projects_data`).

<Tip>If you're interested in our API, feel free to reach out via [info@core3.io](mailto:info@core3.io)</Tip>

## Base URL

All paths in the machine-readable specification are relative to the gateway mount:

```text theme={null}
https://api.core3.io/exchanges_data
```

Append the versioned route from the spec (for example `/v1/...`). Example call for an exchange PoL history chart over the last 30 days:

```bash theme={null}
curl -sS "https://api.core3.io/exchanges_data/v1/binance/pol/history/chart?days=30" \
  -H "x-api-key: core3_your_key_here"
```

Here `binance` is the `{slug}` path parameter for the exchange; `pol` is a fixed segment in the route (PoL score).

## Authentication

Every request must include a valid API key in the **`x-api-key`** header. Keys issued for this API begin with the prefix **`core3_`**.

```bash theme={null}
curl -sS "https://api.core3.io/exchanges_data/v1/health" \
  -H "x-api-key: core3_live_0123456789abcdef"
```

Do not embed keys in client-side public code. Prefer a backend or serverless proxy that adds the header.

## Conventions

* **HTTP method:** All documented operations use `GET`.
* **Version:** Routes are under `/v1`.
* **`{slug}`:** Exchange identifier in the path (examples in the spec use values like `binance`; use slugs returned by list, ratings, search, or dashboard routes).
* **History by range:** PoL history endpoints that are not “chart” variants expect Unix timestamp bounds: required query parameters **`from`** and **`to`** (seconds).
* **History by chart window:** Chart endpoints accept optional **`days`** (integer `1`–`365`). Omit `days` for all-time history, as described in the spec.

## Endpoint map

Path templates are shown **without** the gateway prefix; prepend `https://api.core3.io/exchanges_data` when you call the API.

### Health

| Method | Path         | Summary                                         |
| ------ | ------------ | ----------------------------------------------- |
| `GET`  | `/v1/health` | Liveness and dependency status (`200` / `503`). |

### Exchanges

| Method | Path                                                     | Query / path notes                                                                                                                                                                                                 |
| ------ | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `GET`  | `/v1/top_ratings`                                        | Top-rated exchanges payload.                                                                                                                                                                                       |
| `GET`  | `/v1/list`                                               | Full exchanges list.                                                                                                                                                                                               |
| `GET`  | `/v1/transparency_stats`                                 | Aggregate transparency statistics.                                                                                                                                                                                 |
| `GET`  | `/v1/lost_funds`                                         | Lost-funds statistics.                                                                                                                                                                                             |
| `GET`  | `/v1/dashboard/{slug}`                                   | Dashboard for one exchange.                                                                                                                                                                                        |
| `GET`  | `/v1/{slug}`                                             | General exchange record.                                                                                                                                                                                           |
| `GET`  | `/v1/{slug}/listed_assets`                               | Paginated listed assets: `page` (default `1`), `page_size` (default `20`, max `50`), optional `search`, `categories` (array), `sort_by` (`name` \| `marketCap` \| `polScore`), `sort_direction` (`ASC` \| `DESC`). |
| `GET`  | `/v1/{slug}/listed_assets/categories`                    | Category metadata for listed assets filters.                                                                                                                                                                       |
| `GET`  | `/v1/{slug}/transparency`                                | Transparency section.                                                                                                                                                                                              |
| `GET`  | `/v1/{slug}/security`                                    | Security section.                                                                                                                                                                                                  |
| `GET`  | `/v1/{slug}/solvency`                                    | Solvency section.                                                                                                                                                                                                  |
| `GET`  | `/v1/{slug}/solvency/liabilities_reserves/history/chart` | `days` optional.                                                                                                                                                                                                   |

### PoL score

| Method | Path                                       | Query / path notes                     |
| ------ | ------------------------------------------ | -------------------------------------- |
| `GET`  | `/v1/pol`                                  | Current index-level PoL for exchanges. |
| `GET`  | `/v1/{slug}/pol/current`                   | Current PoL for one exchange.          |
| `GET`  | `/v1/{slug}/pol/history`                   | `from`, `to` (required).               |
| `GET`  | `/v1/{slug}/pol/history/chart`             | `days` optional.                       |
| `GET`  | `/v1/{slug}/pol/by_category`               | Breakdown by category.                 |
| `GET`  | `/v1/{slug}/pol/by_category/history`       | `from`, `to` (required).               |
| `GET`  | `/v1/{slug}/pol/by_category/history/chart` | `days` optional.                       |
| `GET`  | `/v1/{slug}/pol/by_metric`                 | Breakdown by metric.                   |
| `GET`  | `/v1/{slug}/pol/by_metric/history`         | `from`, `to` (required).               |
| `GET`  | `/v1/{slug}/pol/by_metric/history/chart`   | `days` optional.                       |

### Ratings

| Method | Path                            | Query notes                                                                                                                                                                                                                                                                                                                                               |
| ------ | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`  | `/v1/ratings`                   | Pagination: `page` (default `1`), `page_size` (default `20`, max `50`). Sort: `sort_by` (`name` \| `pol` \| `tradingVolume` \| `tradingVolumeChange` \| `rank`), `sort_direction` (`ASC` \| `DESC`). Filters: `is_bug_bounty_present`, `is_proof_of_reserves_present`, `is_penetration_testing_present` (booleans), `listed_tokens` (array of token IDs). |
| `GET`  | `/v1/ratings/parameters`        | Available sorting and filtering metadata for ratings.                                                                                                                                                                                                                                                                                                     |
| `GET`  | `/v1/ratings/parameters/tokens` | Token list for ratings filters; optional `search` (name or ticker).                                                                                                                                                                                                                                                                                       |

### Search

| Method | Path                  | Query notes                         |
| ------ | --------------------- | ----------------------------------- |
| `GET`  | `/v1/search`          | **`search`** (required)—text query. |
| `GET`  | `/v1/search/trending` | Trending exchanges list.            |

## Errors and status codes

Follow HTTP semantics. The health endpoint documents **`503`** when checks fail; other routes return standard client and server errors according to gateway and service behavior.

## Next steps

* Use **`GET /v1/ratings/parameters`** (and **`/v1/ratings/parameters/tokens`** when filtering by listings) so ratings UI matches server-supported values.
* For methodology context, see [CEX PoL methodology](/cex-pol-methodology) and [CEX PoL scoring logic](/cex-pol-scoring-logic).

<Tip>If you're interested in our API, feel free to reach out via [info@core3.io](mailto:info@core3.io)</Tip>
