Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Fetch Channel Info
- Members
- Fetch Followers
- User's Channels
- Trending
- GETFetch all channels with their details
- GETFetch channels that user is active in
- Follows
- Storage
- Frame
- 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
Open invites
Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned.
curl --request GET \
--url https://api.neynar.com/v2/farcaster/channel/member/invite/list \
--header 'x-api-key: <api-key>'
{
"invites": [
{
"channel_id": "neynar",
"role": "member",
"inviter": {
"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": {
"neynar_user_score": 123
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"invited": {
"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": {
"neynar_user_score": 123
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"next": {
"cursor": "<string>"
}
}
Authorizations
API key to authorize requests
Query Parameters
Channel ID for the channel being queried
"neynar"
FID of the user being invited
3
Number of results to fetch
1 <= x <= 100
Pagination cursor.
Response
The unique identifier of a farcaster channel
"neynar"
The role of a channel member
member
, moderator
user
The unique identifier of a farcaster user (unsigned integer)
3
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.
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.
The number of followers the user has.
The number of users the user is following.
Ethereum address
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
Score that represents the probability that the account is not spam.
Adds context on the viewer's follow relationship with the user.
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.
user
The unique identifier of a farcaster user (unsigned integer)
3
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.
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.
The number of followers the user has.
The number of users the user is following.
Ethereum address
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
Score that represents the probability that the account is not spam.
Adds context on the viewer's follow relationship with the user.
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.
Was this page helpful?
curl --request GET \
--url https://api.neynar.com/v2/farcaster/channel/member/invite/list \
--header 'x-api-key: <api-key>'
{
"invites": [
{
"channel_id": "neynar",
"role": "member",
"inviter": {
"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": {
"neynar_user_score": 123
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"invited": {
"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": {
"neynar_user_score": 123
},
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"next": {
"cursor": "<string>"
}
}