Neynar Documentation
Token balance
Group: Onchain APIs
Use this when you need: Token balance.
Usage
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";
const client = new NeynarAPIClient(
new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);
const res = await client.fetchUserBalance({
fid: 123, // FID of the user to fetch
networks: [], // Comma separated list of networks to fetch balances for
});
console.log(res);
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fid |
number |
✅ | FID of the user to fetch |
networks |
Array<FetchUserBalanceNetworksEnum> |
✅ | Comma separated list of networks to fetch balances for |
Response
Returns a RequestArgs object.
Error Handling
try {
const res = await client.fetchUserBalance({
fid: 123,
networks: []
});
// use res
} catch (err) {
// Axios/HTTP errors, invalid params, auth issues, etc.
console.error(err);
}
Tips
- Provide a viewerFid when supported to respect mutes/blocks and include
viewer_context. - Keep requests scoped (e.g., use
limit) to improve latency. - Cache results where sensible.