A new developer's guide to using the Token API and getting token information. Query Token data using alchemy-web3 (recommended) or fetch.
With the Token API, you can retrieve token balances, metadata, and more.
Alchemy currently supports the following Token API Endpoints:
alchemy_getTokenAllowance: Returns the amount which the sender is allowed to withdraw from the owner.alchemy_getTokenBalances: Returns ERC20 token balances for all tokens the given address has ever transacted in with. Optionally accepts a list of contracts.alchemy_getTokenMetadata: Returns metadata (name, symbol, decimals, logo) for a given token contract address.
Interested in token prices? Check out the Prices API.
Decoded values
Unless otherwise specified, Alchemy methods will return decoded values in their responses (e.g., for token decimals, 18 will be returned instead of "0x12") to save you the extra step of decoding the value yourself ✅
How to Query the Token API
Alchemy SDK (Recommended)
Install the alchemy-sdk module to easily interact with Alchemy APIs. We highly recommend the alchemy-sdk for WebSocket support, retries, and more.
Check the Github repo here: https://github.com/alchemyplatform/alchemy-sdk-js
Installation
Run the following command to install alchemy-sdk with npm or yarn
npm install alchemy-sdk
yarn add alchemy-sdk
Usage
touch alchemy-sdk-script.js
And then paste the following code snippet into the file:
import { Alchemy, Network } from "alchemy-sdk";
const settings = {
apiKey: "demo", // Replace with your Alchemy API Key.
network: Network.ETH_MAINNET, // Replace with your network.
};
const alchemy = new Alchemy(settings);
// The wallet address / token we want to query for:
const ownerAddr = "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be";
const balances = await alchemy.core.getTokenBalances(ownerAddr, [
"0x607f4c5bb672230e8672085532f7e901544a7375",
]);
// The token address we want to query for metadata:
const metadata = await alchemy.core.getTokenMetadata(
"0x607f4c5bb672230e8672085532f7e901544a7375"
);
console.log("Token Balances:");
console.log(balances);
console.log("Token Metadata: ");
console.log(metadata);
From your command line, you can execute the script with:
node alchemy-sdk-script.js
You should see output like this:
Token Balances:
{
address: '0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be',
tokenBalances: [
{
contractAddress: '0x607f4c5bb672230e8672085532f7e901544a7375',
tokenBalance: '0x0000000000000000000000000000000000000000000000000000000000000000',
error: null
}
]
}
Token Metadata:
{
decimals: 9,
logo: 'https://static.alchemyapi.com/images/assets/1637.png',
name: 'iExec RLC',
symbol: 'RLC'
}
Node Fetch
node-fetch is a lightweight, common module for making HTTP requests.
See the documentation for more info: https://www.npmjs.com/package/node-fetch
Installation
Run the following command to install node-fetch with npm or yarn
npm install node-fetch
yarn add node-fetch
Usage
touch fetch-script.js
and then paste the following code snippet into the file to explore the getNFTs method:=
// alchemy-token-api/fetch-script.js
import fetch from 'node-fetch';
// Replace with your Alchemy API key:
const apiKey = "demo";
const fetchURL = `https://eth-mainnet.g.alchemy.com/v2/${apiKey}`;
// Replace with the wallet address you want to query:
const ownerAddr = "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be";
// Replace with the token contract address you want to query:
const tokenAddr = "0x607f4c5bb672230e8672085532f7e901544a7375";
var raw = JSON.stringify({
"jsonrpc": "2.0",
"method": "alchemy_getTokenBalances",
"headers": {
"Content-Type": "application/json"
},
"params": [
`${ownerAddr}`,
[
`${tokenAddr}`,
]
],
"id": 42
});
var requestOptions = {
method: 'POST',
body: raw,
redirect: 'follow'
};
// Make the request and print the formatted response:
fetch(fetchURL, requestOptions)
.then(response => response.json())
.then(response => JSON.stringify(response, null, 2))
.then(result => console.log(result))
.catch(error => console.log('error', error));
From your command line, you can execute the script with:
node fetch-script.js
Your output should look like the following:
{
"jsonrpc": "2.0",
"id": 42,
"result": {
"address": "0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be",
"tokenBalances": [
{
"contractAddress": "0x607f4c5bb672230e8672085532f7e901544a7375",
"tokenBalance": "0x00000000000000000000000000000000000000000000000000003c005f81ab00",
"error": null
}
]
}
}
API Reference
For more details on the available Token API methods, check out the docs: