Skip to main content
The Token API lists registered tokens from GET /token/all. It is public (no API key required).

client.token

const client = alphscan({ apiUrl: "https://api.alphscan.io" });
const result = await client.token.list({ page: 1, pageSize: 20 });

TokenApi

MethodReturnsDescription
list(params?)Promise<TokenListResponse>Paginated token list.

TokenListParams

FieldTypeDefaultDescription
pagenumber11-based page index.
pageSizenumber20Page size (max 999).

TokenListResponse

FieldTypeDescription
tokensTokenEntry[]Page of tokens.
totalnumberTotal count.
pagenumberCurrent page.
pageSizenumberPage size used.
networkIdnumberOptional network id.

TokenEntry

FieldTypeDescription
idstringToken id.
namestringDisplay name.
symbolstringSymbol.
decimalsnumberDecimals.
descriptionstringOptional description.
logoURIstringLogo URL.
nameOnChainstringOn-chain name.
symbolOnChainstringOn-chain symbol.
originChainstringOrigin chain.
unchainedLogoURIstringAlternative logo.
categorystringSingle category.
categoriesstring[]Category list.
dappstringDapp id.
chainIdnumberChain id.
moderationstringModeration status.
marketDisplaybooleanShow in market.

Example

import { alphscan } from "@alphscan/sdk";

const client = alphscan({ apiUrl: "https://api.alphscan.io" });

const { tokens, total, page, pageSize } = await client.token.list({
  page: 1,
  pageSize: 50,
});

console.log(`Page ${page}: ${tokens.length} of ${total} tokens`);
tokens.forEach((t) => console.log(t.id, t.symbol, t.name));