Farcaster
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Mini App Hosts
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- NodeJS SDK v1 to v2 migration guide
- Getting Started with Neynar Rust SDK
- Getting Started with Neynar Go SDK
Onchain
Token balance
Fetches the token balances of a user given their FID
GET
/
v2
/
farcaster
/
user
/
balance
/
Copy
curl --request GET \
--url https://api.neynar.com/v2/farcaster/user/balance/ \
--header 'x-api-key: <api-key>'
Copy
{
"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": "ethereum"
},
"token_balances": [
{
"object": "token_balance",
"token": {
"object": "token",
"name": "<string>",
"symbol": "<string>",
"address": "<string>",
"decimals": 123
},
"balance": {
"in_token": "<string>",
"in_usdc": "<string>"
}
}
]
}
]
}
}
Related tutorial: User balances directly w/ FID
Authorizations
API key to authorize requests
Query Parameters
FID of the user to fetch
Comma separated list of networks to fetch balances for
Response
200
application/json
Success
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://api.neynar.com/v2/farcaster/user/balance/ \
--header 'x-api-key: <api-key>'
Copy
{
"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": "ethereum"
},
"token_balances": [
{
"object": "token_balance",
"token": {
"object": "token",
"name": "<string>",
"symbol": "<string>",
"address": "<string>",
"decimals": 123
},
"balance": {
"in_token": "<string>",
"in_usdc": "<string>"
}
}
]
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.