Notifications
For user by parent_urls
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
Notifications
For user by parent_urls
Returns a list of notifications for a user in specific parent_urls
GET
/
farcaster
/
notifications
/
parent_url
curl --request GET \
--url https://api.neynar.com/v2/farcaster/notifications/parent_url \
--header 'x-api-key: <api-key>'{
"unseen_notifications_count": 123,
"notifications": [
{
"object": "notification",
"most_recent_timestamp": "2023-11-07T05:31:56Z",
"type": "follows",
"seen": true,
"follows": [
{
"object": "follower",
"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": {
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"cast": {
"object": "cast",
"hash": "<string>",
"parent_hash": "<string>",
"parent_url": "<string>",
"root_parent_url": "<string>",
"parent_author": {
"fid": null
},
"author": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"app": null,
"text": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"embeds": [
{
"url": "<string>",
"metadata": {
"_status": "<string>",
"content_type": "<string>",
"content_length": 123,
"image": {
"height_px": 123,
"width_px": 123
},
"video": {
"duration_s": 123,
"stream": [
{
"codec_name": "<string>",
"height_px": 123,
"width_px": 123
}
]
},
"html": {
"favicon": "<string>",
"modifiedTime": "<string>",
"ogArticleAuthor": "<string>",
"ogArticleExpirationTime": "<string>",
"ogArticleModifiedTime": "<string>",
"ogArticlePublishedTime": "<string>",
"ogArticlePublisher": "<string>",
"ogArticleSection": "<string>",
"ogArticleTag": "<string>",
"ogAudio": "<string>",
"ogAudioSecureURL": "<string>",
"ogAudioType": "<string>",
"ogAudioURL": "<string>",
"ogAvailability": "<string>",
"ogDate": "<string>",
"ogDescription": "<string>",
"ogDeterminer": "<string>",
"ogEpisode": "<string>",
"ogImage": [
{
"height": "<string>",
"type": "<string>",
"url": "<string>",
"width": "<string>",
"alt": "<string>"
}
],
"ogLocale": "<string>",
"ogLocaleAlternate": "<string>",
"ogLogo": "<string>",
"ogMovie": "<string>",
"ogPriceAmount": "<string>",
"ogPriceCurrency": "<string>",
"ogProductAvailability": "<string>",
"ogProductCondition": "<string>",
"ogProductPriceAmount": "<string>",
"ogProductPriceCurrency": "<string>",
"ogProductRetailerItemId": "<string>",
"ogSiteName": "<string>",
"ogTitle": "<string>",
"ogType": "<string>",
"ogUrl": "<string>",
"ogVideo": [
{
"height": "<string>",
"type": "<string>",
"url": "<string>",
"width": "<string>"
}
],
"ogVideoActor": "<string>",
"ogVideoActorId": "<string>",
"ogVideoActorRole": "<string>",
"ogVideoDirector": "<string>",
"ogVideoDuration": "<string>",
"ogVideoOther": "<string>",
"ogVideoReleaseDate": "<string>",
"ogVideoSecureURL": "<string>",
"ogVideoSeries": "<string>",
"ogVideoTag": "<string>",
"ogVideoTvShow": "<string>",
"ogVideoWriter": "<string>",
"ogWebsite": "<string>",
"updatedTime": "<string>",
"oembed": {
"type": "rich",
"version": "<string>",
"title": "<string>",
"author_name": "<string>",
"author_url": "<string>",
"provider_name": "<string>",
"provider_url": "<string>",
"cache_age": "<string>",
"thumbnail_url": "<string>",
"thumbnail_width": 123,
"thumbnail_height": 123,
"html": "<string>",
"width": 123,
"height": 123
}
},
"frame": {
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}
}
}
],
"type": "cast-mention",
"frames": [
{
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}
],
"reactions": {
"likes": [
{
"fid": 3,
"fname": "<string>"
}
],
"recasts": [
{
"fid": 3,
"fname": "<string>"
}
],
"likes_count": 123,
"recasts_count": 123
},
"replies": {
"count": 123
},
"thread_hash": "<string>",
"mentioned_profiles": [
{
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
],
"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
}
],
"channel": {
"id": "<string>",
"url": "<string>",
"object": "channel",
"name": "<string>",
"description": "<string>",
"description_mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"description_mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"created_at": 123,
"follower_count": 123,
"external_link": {
"title": "<string>",
"url": "<string>"
},
"image_url": "<string>",
"parent_url": "<string>",
"lead": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"moderator_fids": [
3
],
"member_count": 123,
"moderator": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"pinned_cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
"hosts": [
{
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
],
"viewer_context": {
"following": true,
"role": "member"
}
},
"viewer_context": {
"liked": true,
"recasted": true
},
"author_channel_context": {
"following": true,
"role": "member"
}
},
"reactions": [
{
"object": "likes",
"cast": {
"object": "cast_dehydrated",
"hash": "<string>",
"author": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
},
"app": null
},
"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": {
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"count": 123
}
],
"next": {
"cursor": "<string>"
}
}Related tutorial: Notifications in channel
Authorizations
API key to authorize requests
Query Parameters
FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
Examples:
3
191
2
194
19960
Comma separated parent_urls
When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided).
Number of results to fetch
Required range:
1 <= x <= 25Pagination cursor.
Response
200
application/json
Successful response
Available options:
notification Available options:
follows, recasts, likes, mention, reply, quote Available options:
follower Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
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
Score that represents the probability that the account is not spam.
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.
Available options:
cast The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
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
Score that represents the probability that the account is not spam.
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.
Mini app v1 object
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
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
Score that represents the probability that the account is not spam.
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.
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.
Available options:
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.
Available options:
channel Available options:
user_dehydrated The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Positions within the text (inclusive start, exclusive end) where each mention occurs.
Epoch timestamp in seconds.
Number of followers the channel has.
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
The number of followers the user has.
The number of users the user is following.
Ethereum address
Verified accounts of the user on other platforms, currently only X is supported.
Score that represents the probability that the account is not spam.
The URL of the user's profile picture
Adds context on the viewer's follow relationship with the user.
The unique identifier of a farcaster user (unsigned integer)
Use lead instead.
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
The number of followers the user has.
The number of users the user is following.
Ethereum address
Verified accounts of the user on other platforms, currently only X is supported.
Score that represents the probability that the account is not spam.
The URL of the user's profile picture
Adds context on the viewer's follow relationship with the user.
notifications.cast.channel.pinned_cast_hash
string
default:0xfe90f9de682273e05b201629ad2338bdcd89b6be
Hash of the pinned cast in the channel.
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
The number of followers the user has.
The number of users the user is following.
Ethereum address
Verified accounts of the user on other platforms, currently only X is supported.
Score that represents the probability that the account is not spam.
The URL of the user's profile picture
Adds context on the viewer's follow relationship with the user.
Adds context on the viewer's or author's role in the channel.
Available options:
user_dehydrated The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
The notification type of a cast.
Available options:
cast-mention, cast-reply Mini app v1 object
Version of the mini app, 'next' for v2, 'vNext' for v1
URL of the image
Launch URL of the mini app
Index of the button
The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcaster/frame/action.
Available options:
post, post_redirect, tx, link, mint Title of the button
Target of the button
Used specifically for the tx action type to post a successful transaction hash
Post URL to take an action on this mini app
Input text for the mini app
Adds context on the viewer's or author's role in the channel.
Available options:
likes, recasts Available options:
cast_dehydrated Available options:
user_dehydrated The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Available options:
user_dehydrated The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Available options:
user The unique identifier of a farcaster user (unsigned integer)
Examples:
3
191
2
194
19960
Ethereum address
Example:
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
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
Score that represents the probability that the account is not spam.
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.
The number of notifications of this(follows, likes, recast) type bundled in a single notification.
Was this page helpful?
curl --request GET \
--url https://api.neynar.com/v2/farcaster/notifications/parent_url \
--header 'x-api-key: <api-key>'{
"unseen_notifications_count": 123,
"notifications": [
{
"object": "notification",
"most_recent_timestamp": "2023-11-07T05:31:56Z",
"type": "follows",
"seen": true,
"follows": [
{
"object": "follower",
"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": {
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"cast": {
"object": "cast",
"hash": "<string>",
"parent_hash": "<string>",
"parent_url": "<string>",
"root_parent_url": "<string>",
"parent_author": {
"fid": null
},
"author": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"app": null,
"text": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"embeds": [
{
"url": "<string>",
"metadata": {
"_status": "<string>",
"content_type": "<string>",
"content_length": 123,
"image": {
"height_px": 123,
"width_px": 123
},
"video": {
"duration_s": 123,
"stream": [
{
"codec_name": "<string>",
"height_px": 123,
"width_px": 123
}
]
},
"html": {
"favicon": "<string>",
"modifiedTime": "<string>",
"ogArticleAuthor": "<string>",
"ogArticleExpirationTime": "<string>",
"ogArticleModifiedTime": "<string>",
"ogArticlePublishedTime": "<string>",
"ogArticlePublisher": "<string>",
"ogArticleSection": "<string>",
"ogArticleTag": "<string>",
"ogAudio": "<string>",
"ogAudioSecureURL": "<string>",
"ogAudioType": "<string>",
"ogAudioURL": "<string>",
"ogAvailability": "<string>",
"ogDate": "<string>",
"ogDescription": "<string>",
"ogDeterminer": "<string>",
"ogEpisode": "<string>",
"ogImage": [
{
"height": "<string>",
"type": "<string>",
"url": "<string>",
"width": "<string>",
"alt": "<string>"
}
],
"ogLocale": "<string>",
"ogLocaleAlternate": "<string>",
"ogLogo": "<string>",
"ogMovie": "<string>",
"ogPriceAmount": "<string>",
"ogPriceCurrency": "<string>",
"ogProductAvailability": "<string>",
"ogProductCondition": "<string>",
"ogProductPriceAmount": "<string>",
"ogProductPriceCurrency": "<string>",
"ogProductRetailerItemId": "<string>",
"ogSiteName": "<string>",
"ogTitle": "<string>",
"ogType": "<string>",
"ogUrl": "<string>",
"ogVideo": [
{
"height": "<string>",
"type": "<string>",
"url": "<string>",
"width": "<string>"
}
],
"ogVideoActor": "<string>",
"ogVideoActorId": "<string>",
"ogVideoActorRole": "<string>",
"ogVideoDirector": "<string>",
"ogVideoDuration": "<string>",
"ogVideoOther": "<string>",
"ogVideoReleaseDate": "<string>",
"ogVideoSecureURL": "<string>",
"ogVideoSeries": "<string>",
"ogVideoTag": "<string>",
"ogVideoTvShow": "<string>",
"ogVideoWriter": "<string>",
"ogWebsite": "<string>",
"updatedTime": "<string>",
"oembed": {
"type": "rich",
"version": "<string>",
"title": "<string>",
"author_name": "<string>",
"author_url": "<string>",
"provider_name": "<string>",
"provider_url": "<string>",
"cache_age": "<string>",
"thumbnail_url": "<string>",
"thumbnail_width": 123,
"thumbnail_height": 123,
"html": "<string>",
"width": 123,
"height": 123
}
},
"frame": {
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}
}
}
],
"type": "cast-mention",
"frames": [
{
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}
],
"reactions": {
"likes": [
{
"fid": 3,
"fname": "<string>"
}
],
"recasts": [
{
"fid": 3,
"fname": "<string>"
}
],
"likes_count": 123,
"recasts_count": 123
},
"replies": {
"count": 123
},
"thread_hash": "<string>",
"mentioned_profiles": [
{
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
],
"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
}
],
"channel": {
"id": "<string>",
"url": "<string>",
"object": "channel",
"name": "<string>",
"description": "<string>",
"description_mentioned_profiles": [
{
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
],
"description_mentioned_profiles_ranges": [
{
"start": 1,
"end": 1
}
],
"created_at": 123,
"follower_count": 123,
"external_link": {
"title": "<string>",
"url": "<string>"
},
"image_url": "<string>",
"parent_url": "<string>",
"lead": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"moderator_fids": [
3
],
"member_count": 123,
"moderator": {
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
},
"pinned_cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
"hosts": [
{
"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
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
],
"viewer_context": {
"following": true,
"role": "member"
}
},
"viewer_context": {
"liked": true,
"recasted": true
},
"author_channel_context": {
"following": true,
"role": "member"
}
},
"reactions": [
{
"object": "likes",
"cast": {
"object": "cast_dehydrated",
"hash": "<string>",
"author": {
"object": "user_dehydrated",
"fid": 3,
"username": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
},
"app": null
},
"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": {
"neynar_user_score": 123
},
"score": 123,
"viewer_context": {
"following": true,
"followed_by": true,
"blocking": true,
"blocked_by": true
}
}
}
],
"count": 123
}
],
"next": {
"cursor": "<string>"
}
}