Farcaster
Deploy onchain
Farcaster Hub API
Other SDKs
curl --request GET \
--url https://api.neynar.com/v2/farcaster/channel/followers/ \
--header 'x-api-key: <api-key>'{
"users": [
{
"object": "user",
"fid": 3,
"username": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
],
"mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"mentioned_channels": [
{
"id": "<string>",
"name": "<string>",
"object": "channel_dehydrated",
"image_url": "<string>",
"viewer_context": {
"following": true,
"role": "member"
}
}
],
"mentioned_channels_ranges": [
{
"start": 1,
"end": 1
}
]
},
"location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"country": "<string>",
"state": "<string>",
"state_code": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"auth_addresses": [
{
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"app": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
}
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"display_name": "<string>",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"experimental": {
"neynar_user_score": 123,
"deprecation_notice": "<string>"
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
},
"score": 123
}
],
"next": {
"cursor": "<string>"
}
}For channel
Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination.
curl --request GET \
--url https://api.neynar.com/v2/farcaster/channel/followers/ \
--header 'x-api-key: <api-key>'{
"users": [
{
"object": "user",
"fid": 3,
"username": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
],
"mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"mentioned_channels": [
{
"id": "<string>",
"name": "<string>",
"object": "channel_dehydrated",
"image_url": "<string>",
"viewer_context": {
"following": true,
"role": "member"
}
}
],
"mentioned_channels_ranges": [
{
"start": 1,
"end": 1
}
]
},
"location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"country": "<string>",
"state": "<string>",
"state_code": "<string>",
"country_code": "<string>"
},
"radius": 1
},
"banner": {
"url": "<string>"
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"auth_addresses": [
{
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"app": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"score": 123
}
}
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"display_name": "<string>",
"pro": {
"status": "subscribed",
"subscribed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"pfp_url": "<string>",
"experimental": {
"neynar_user_score": 123,
"deprecation_notice": "<string>"
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
},
"score": 123
}
],
"next": {
"cursor": "<string>"
}
}Node.js SDK
š SDK Method: fetchFollowersForAChannel Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.Authorizations
API key to authorize requests
Headers
Query Parameters
Channel ID for the channel being queried
"founders"
Providing this will return a list of followers that respects this user's mutes and blocks and includes viewer_context.
x >= 1Pagination cursor.
Number of followers to fetch
1 <= x <= 1000Response
Success
Show child attributes
Show child attributes
user The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
user_dehydrated The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_profiles list.
Show child attributes
Show child attributes
channel_dehydrated Adds context on the viewer's or author's role in the channel.
Positions within the text (inclusive start, exclusive end) where each mention occurs. Each index within this list corresponds to the same-numbered index in the mentioned_channels list.
Coordinates and place names for a location
Show child attributes
Show child attributes
-90 <= x <= 90-180 <= x <= 180The radius in meters for the location search. Any location within this radius will be returned.
x >= 0The number of followers the user has.
The number of users the user is following.
Ethereum address
Show child attributes
Show child attributes
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
Show child attributes
user_dehydrated The unique identifier of a farcaster user or app (unsigned integer)
x >= 03
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Show child attributes
Show child attributes
List of verified Ethereum addresses of the user sorted by oldest to most recent.
Ethereum address
List of verified Solana addresses of the user sorted by oldest to most recent.
Solana address
The URL of the user's profile picture
Adds context on the viewer's follow relationship with the user.
Show child attributes
Show child attributes
Indicates if the viewer is following the user.
Indicates if the viewer is followed by the user.
Indicates if the viewer is blocking the user.
Indicates if the viewer is blocked by the user.
Score that represents the probability that the account is not spam.
Was this page helpful?