Subscribers
Subscribers of a user
Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- 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
- SDK v1 to v2 migration guide
Subscribers
Subscribers of a user
Fetch subscribers for a given FID’s contracts. Doesn’t return addresses that don’t have an FID.
GET
/
farcaster
/
user
/
subscribers
curl --request GET \
--url https://api.neynar.com/v2/farcaster/user/subscribers \
--header 'x-api-key: <api-key>'
{
"subscribers": [
{
"object": "subscriber",
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pfp_url": "<string>",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"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>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
}
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"power_badge": true,
"experimental": {
"deprecation_notice": "<string>",
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"subscribed_to": {
"object": "subscription_dehydrated",
"provider_name": "fabric_stp",
"contract_address": "0x325b3e2c19f4900f8f4eb5f6872dc2715e77cbac",
"protocol_version": 1,
"chain": 8453,
"expires_at": "2023-09-13T22:10:22.000Z",
"subscribed_at": "2023-09-13T22:10:22.000Z",
"tier_id": "0"
}
}
]
}
Authorizations
API key to authorize requests
Query Parameters
The unique identifier of a farcaster user (unsigned integer)
Example:
3
The unique identifier of a farcaster user (unsigned integer)
Example:
3
The provider of the subscription.
Available options:
fabric_stp
, paragraph
Response
200
application/json
Successful operation.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.neynar.com/v2/farcaster/user/subscribers \
--header 'x-api-key: <api-key>'
{
"subscribers": [
{
"object": "subscriber",
"user": {
"object": "user",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pfp_url": "<string>",
"profile": {
"bio": {
"text": "<string>",
"mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"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>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
}
}
},
"follower_count": 123,
"following_count": 123,
"verifications": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"verified_addresses": {
"eth_addresses": [
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
],
"sol_addresses": [
"<string>"
],
"primary": {
"eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"sol_address": "<string>"
}
},
"verified_accounts": [
{
"platform": "x",
"username": "<string>"
}
],
"power_badge": true,
"experimental": {
"deprecation_notice": "<string>",
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"subscribed_to": {
"object": "subscription_dehydrated",
"provider_name": "fabric_stp",
"contract_address": "0x325b3e2c19f4900f8f4eb5f6872dc2715e77cbac",
"protocol_version": 1,
"chain": 8453,
"expires_at": "2023-09-13T22:10:22.000Z",
"subscribed_at": "2023-09-13T22:10:22.000Z",
"tier_id": "0"
}
}
]
}