> ## 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.

# Endpoints

> All Alphscan API endpoints by method, path, and access level

This page lists every available endpoint. For request/response schemas and examples, use the [Swagger UI (prod)](https://api.alphscan.io/prod/docs) or [Swagger UI (dev)](https://api.alphscan.io/dev/docs).

**Base URL:** `https://api.alphscan.io/prod` or `https://api.alphscan.io/dev`

**Access levels:** **Public** (no key), **User** (API key with user level), **Admin** (API key with admin level).

## Docs & spec

| Method | Path          | Access | Description             |
| ------ | ------------- | ------ | ----------------------- |
| GET    | /docs         | Public | Swagger UI (HTML)       |
| GET    | /openapi.json | Public | OpenAPI 3.0 spec (JSON) |

## Auth

| Method | Path               | Access | Description                                           |
| ------ | ------------------ | ------ | ----------------------------------------------------- |
| POST   | /auth/admin/google | Public | Admin sign-in with Google credential; returns API key |

## Transaction

| Method | Path                                            | Access | Description                         |
| ------ | ----------------------------------------------- | ------ | ----------------------------------- |
| GET    | /transaction/{transaction_id}/normalized/events | User   | Normalized events for a transaction |

## System — Plans

| Method | Path          | Access | Description    |
| ------ | ------------- | ------ | -------------- |
| GET    | /system/plans | Public | List API plans |

## System — Keys

| Method | Path                      | Access | Description       |
| ------ | ------------------------- | ------ | ----------------- |
| GET    | /system/keys              | User   | List API keys     |
| POST   | /system/keys              | Admin  | Create API key    |
| POST   | /system/keys/delete       | Admin  | Delete key        |
| POST   | /system/keys/patch        | Admin  | Patch key         |
| POST   | /system/keys/set-plan     | Admin  | Set key plan      |
| POST   | /system/key/origin/add    | User   | Add key origin    |
| POST   | /system/key/origin/delete | User   | Delete key origin |

## System — Payment

| Method | Path                       | Access | Description              |
| ------ | -------------------------- | ------ | ------------------------ |
| GET    | /system/payment/next-index | Admin  | Next derivation index    |
| POST   | /system/payment/request    | Admin  | Create payment request   |
| POST   | /system/payment/verify     | Admin  | Verify payment by tx\_id |
| GET    | /system/payment/pending    | Admin  | Pending payments         |
| GET    | /system/payment/history    | User   | Payment history          |

## System — Telegram

| Method | Path                           | Access | Description           |
| ------ | ------------------------------ | ------ | --------------------- |
| GET    | /system/telegram/admins        | Admin  | List Telegram admins  |
| POST   | /system/telegram/admins/add    | Admin  | Add Telegram admin    |
| POST   | /system/telegram/admins/remove | Admin  | Remove Telegram admin |

## System — Other

| Method | Path                         | Access | Description                |
| ------ | ---------------------------- | ------ | -------------------------- |
| GET    | /system/banned               | Admin  | List banned users          |
| POST   | /system/banned/add           | Admin  | Add banned user            |
| POST   | /system/banned/remove        | Admin  | Remove banned user         |
| GET    | /system/jobs                 | Admin  | List jobs                  |
| GET    | /system/admin/allowed-emails | Admin  | List allowed admin emails  |
| GET    | /system/wireguard/ping       | Public | WireGuard ping             |
| GET    | /system/wireguard/postgresql | Public | WireGuard PostgreSQL check |
| GET    | /system/wireguard/tables     | Public | Database tables            |

## Token

| Method | Path                      | Access | Description             |
| ------ | ------------------------- | ------ | ----------------------- |
| GET    | /token/all                | Public | List tokens (paginated) |
| GET    | /token/{token_id}/details | Public | Token details           |
| GET    | /token/categories         | Public | List token categories   |
| POST   | /token/categories/add     | Admin  | Add category            |
| POST   | /token/categories/del     | Admin  | Delete category         |
| POST   | /token/update             | Admin  | Update token            |
| POST   | /token/delete             | Admin  | Delete token            |

## Addresses

| Method | Path                        | Access | Description                     |
| ------ | --------------------------- | ------ | ------------------------------- |
| GET    | /addresses/{address}/labels | Public | Labels for an address           |
| GET    | /addresses/all              | Public | List address labels (paginated) |
| GET    | /addresses-labels/all       | Public | Alias for addresses/all         |
| POST   | /addresses/label/add        | Admin  | Add address label               |
| POST   | /addresses/label/del        | Admin  | Delete address label            |

## Contracts

| Method | Path           | Access | Description                |
| ------ | -------------- | ------ | -------------------------- |
| GET    | /contracts/all | Public | List contracts (paginated) |

## Chain

| Method | Path          | Access | Description               |
| ------ | ------------- | ------ | ------------------------- |
| GET    | /chain/all    | Public | List chains (paginated)   |
| GET    | /chain/search | Public | Search chains (chainlist) |
| POST   | /chain/add    | Admin  | Add chain by chainlist ID |
| POST   | /chain/update | Admin  | Update chain              |
| POST   | /chain/delete | Admin  | Soft-delete chain         |

## Webhook

| Method | Path              | Access | Description          |
| ------ | ----------------- | ------ | -------------------- |
| POST   | /telegram/webhook | Public | Telegram bot webhook |
