GET
/
farcaster
/
user
/
balance
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/user/balance \
  --header 'x-api-key: <api-key>'
{
  "user_balance": {
    "object": "user_balance",
    "user": {
      "object": "user_dehydrated",
      "fid": 3,
      "username": "<string>",
      "display_name": "<string>",
      "pfp_url": "<string>",
      "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
    },
    "address_balances": [
      {
        "object": "address_balance",
        "verified_address": {
          "address": "<string>",
          "network": "base"
        },
        "token_balances": [
          {
            "object": "token_balance",
            "token": {
              "object": "token",
              "name": "<string>",
              "symbol": "<string>",
              "address": "<string>",
              "decimals": 123
            },
            "balance": {
              "in_token": "<string>",
              "in_usdc": "<string>"
            }
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
fid
integer
required

FID of the user to fetch

Example:

3

​
networks
enum<string>[]
required

Comma separated list of networks to fetch balances for. Currently, only "base" is supported.

A blockchain network e.g. "base"

Available options:
base

Response

200
application/json
Successful operation.
​
user_balance
object

Was this page helpful?