Skip to main content
This guide gets you from zero to a working client and your first API call using @alphscan/sdk. For React apps, see the sdk-react tab after this.

Step 1: Install the SDK

No API key is required for public endpoints (e.g. token list, plans).

Step 2: Create a client and call the API

Step 3: Use in a React app (optional)

If you use React, add @alphscan/sdk-react and wrap your app with the provider. Then use hooks like useTokens instead of calling the client directly.
Full details: sdk-react tab → Overview and useTokens.

Next steps

Client & settings

Configure API URL, API key, and environment variables.

Token API

Pagination and response shape for token.list().

Provider & useClient

AlphscanProvider and useClient() in React.

Development

Run the docs site locally.