Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

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

ParameterTypeRequiredDescription
fidnumber✅FID of the user to fetch
networksArray<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);
}
📖 API Reference: fetchUserBalance For detailed information about the HTTP endpoint, request/response schemas, and additional examples, see the complete API documentation.

​
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.