Skip to main content
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.
StageSwagger UI
Productionhttps://api.alphscan.io/prod/docs
Devhttps://api.alphscan.io/dev/docs
OpenAPI spec (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 for how to obtain a key.

​
Endpoints list

A full list of available endpoints by method, path, and access level is in Endpoints.

Open Swagger (prod)

Open production Swagger UI in a new tab.

Open Swagger (dev)

Open dev Swagger UI in a new tab.