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",
"score": 123
},
"address_balances": [
{
"object": "address_balance",
"verified_address": {
"address": "<string>",
"network": "ethereum"
},
"token_balances": [
{
"object": "token_balance",
"token": {
"object": "token",
"name": "<string>",
"symbol": "<string>",
"address": "<string>",
"decimals": 123
},
"balance": {
"in_token": "<string>",
"in_usdc": "<string>"
}
}
]
}
]
}
}Fetches the token balances of a user given their FID
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",
"score": 123
},
"address_balances": [
{
"object": "address_balance",
"verified_address": {
"address": "<string>",
"network": "ethereum"
},
"token_balances": [
{
"object": "token_balance",
"token": {
"object": "token",
"name": "<string>",
"symbol": "<string>",
"address": "<string>",
"decimals": 123
},
"balance": {
"in_token": "<string>",
"in_usdc": "<string>"
}
}
]
}
]
}
}API key to authorize requests
FID of the user to fetch
x >= 1Comma separated list of networks to fetch balances for
A blockchain network e.g. "ethereum", "optimism", "base", "arbitrum"
ethereum, optimism, base, arbitrum Success
Show child attributes
user_balance Show child attributes
user_dehydrated The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
address_balance Show child attributes
Show child attributes
token_balance Show child attributes
token The token name e.g. "Ethereum"
The token symbol e.g. "ETH"
The contract address of the token (omitted for native token)
The number of decimals the token uses
Was this page helpful?