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

# API reference overview

> Swagger UI, authorization, and endpoint list

The Alphscan API is documented with **OpenAPI (Swagger)**. Interactive docs and the raw spec are available per stage.

## Swagger UI (interactive docs)

Open the links below to try endpoints in the browser. Use **Authorize** to set your API key for protected routes.

| Stage          | Swagger UI                                                             |
| -------------- | ---------------------------------------------------------------------- |
| **Production** | [https://api.alphscan.io/prod/docs](https://api.alphscan.io/prod/docs) |
| **Dev**        | [https://api.alphscan.io/dev/docs](https://api.alphscan.io/dev/docs)   |

OpenAPI spec (JSON):

* **Prod:** [https://api.alphscan.io/prod/openapi.json](https://api.alphscan.io/prod/openapi.json)
* **Dev:** [https://api.alphscan.io/dev/openapi.json](https://api.alphscan.io/dev/openapi.json)

## Authorization setup

Most endpoints require an **API key**. In Swagger UI:

1. Click **Authorize** (top right).
2. Enter your API key in the **ApiKeyAuth** field. The UI will send it as both **X-API-Key** and **Authorization: Bearer** (the gateway expects both).
3. Click **Authorize**, then **Close**.

After that, "Try it out" on any endpoint will include the key. Public endpoints (e.g. /token/all, /system/plans, /chain/all) work without authorizing. See [Generate API key](/generate-api-key) for how to obtain a key.

## Endpoints list

A full list of available endpoints by method, path, and access level is in [Endpoints](/api-reference/endpoints).

<Card title="Open Swagger (prod)" icon="external-link" href="https://api.alphscan.io/prod/docs">
  Open production Swagger UI in a new tab.
</Card>

<Card title="Open Swagger (dev)" icon="external-link" href="https://api.alphscan.io/dev/docs">
  Open dev Swagger UI in a new tab.
</Card>
