Skip to main content
Alphscan provides an API and client libraries for the Alephium ecosystem: indexer data, normalized events, tokens, chains, and more. This documentation covers the JavaScript/TypeScript SDK, the React hooks and provider, and the UI components for displaying normalized events.

Documentation tabs

Use the tabs at the top to switch between sections:
TabContent
IntroductionYou are here — overview, quickstart, BPT, about us, Telegram bot (user), and local development.
sdk@alphscan/sdk — client, settings, token/transaction/system APIs, raw request.
sdk-react@alphscan/sdk-react — AlphscanProvider, useClient, useTokens, useTxNormalizedEvents.
sdk-react-ui@alphscan/sdk-react-ui — NormalizedEventsList and event row components.
AdministrationTelegram bot (admin), API key generation, and admin endpoints.
InfrastructureStack overview, indexers, data ingestion, status page, and hosting.
API referenceSwagger UI (dev/prod), authorization setup, and full endpoint list.

Quickstart

Install the SDK, create a client, and make your first API call.

SDK overview

@alphscan/sdk — features, client surface, and examples.

sdk-react overview

@alphscan/sdk-react — provider and hooks with code samples.

sdk-react-ui overview

@alphscan/sdk-react-ui — list and row components for normalized events.

Development

Run the docs site locally and preview changes.

BabyPoolTool (BPT)

Description of BabyPoolTool and how it fits with Alphscan.

About us

Baby and me — who we are.

Telegram bot (user)

Get an API key and use the bot as a user.

Administration

Telegram bot and API key generation (admin).

Infrastructure

Stack, indexers, data ingestion, status page, and hosting.

API reference

Swagger UI (dev/prod), authorization, and endpoint list.

Status page

Check service status and uptime: status.babypooltool.com — Alephium.

API base URL

  • Production: https://api.alphscan.io
  • Dev/stage: https://api.alphscan.io/dev (when using a stage)
Use the sdk tab for full client and settings documentation.