GET
/
v2
/
farcaster
/
feed
/
By filters
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/feed/ \
  --header 'x-api-key: <api-key>'
{
  "casts": [
    {
      "object": "cast",
      "hash": "<string>",
      "parent_hash": "<string>",
      "parent_url": "<string>",
      "root_parent_url": "<string>",
      "parent_author": {
        "fid": 3
      },
      "author": {
        "object": "user",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "pro": {
          "status": "subscribed",
          "subscribed_at": "2023-11-07T05:31:56Z",
          "expires_at": "2023-11-07T05:31:56Z"
        },
        "pfp_url": "<string>",
        "profile": {
          "bio": {},
          "location": {},
          "banner": {}
        },
        "follower_count": 123,
        "following_count": 123,
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "auth_addresses": [
          {}
        ],
        "verified_addresses": {
          "eth_addresses": [
            "<any>"
          ],
          "sol_addresses": [
            "<any>"
          ],
          "primary": {}
        },
        "verified_accounts": [
          {}
        ],
        "power_badge": true,
        "experimental": {
          "deprecation_notice": "<string>",
          "neynar_user_score": 123
        },
        "viewer_context": {
          "following": true,
          "followed_by": true,
          "blocking": true,
          "blocked_by": true
        },
        "score": 123
      },
      "app": {
        "object": "user_dehydrated",
        "fid": 3,
        "username": "<string>",
        "display_name": "<string>",
        "pfp_url": "<string>",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "score": 123
      },
      "text": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "embeds": [
        {
          "cast_id": {
            "fid": 3,
            "hash": "<string>"
          },
          "cast": {
            "hash": "<string>",
            "parent_hash": "<string>",
            "parent_url": "<string>",
            "root_parent_url": "<string>",
            "parent_author": {
              "fid": 3
            },
            "author": {
              "object": "<any>",
              "fid": "<any>",
              "username": "<any>",
              "display_name": "<any>",
              "pfp_url": "<any>",
              "custody_address": "<any>",
              "score": "<any>"
            },
            "app": {
              "object": "user_dehydrated",
              "fid": 3,
              "username": "<string>",
              "display_name": "<string>",
              "pfp_url": "<string>",
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "score": 123
            },
            "text": "<string>",
            "timestamp": "2023-11-07T05:31:56Z",
            "embeds": [
              {
                "cast_id": {},
                "cast": {
                  "object": "cast_dehydrated",
                  "hash": "<string>",
                  "author": {},
                  "app": "<any>"
                }
              }
            ],
            "channel": {
              "id": "<string>",
              "name": "<string>",
              "object": "channel_dehydrated",
              "image_url": "<string>",
              "viewer_context": {
                "following": "<any>",
                "role": "<any>"
              }
            }
          }
        }
      ],
      "type": "cast-mention",
      "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",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "pfp_url": "<string>",
          "profile": {
            "bio": {},
            "location": {},
            "banner": {}
          },
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "auth_addresses": [
            {}
          ],
          "verified_addresses": {
            "eth_addresses": [
              "<any>"
            ],
            "sol_addresses": [
              "<any>"
            ],
            "primary": {}
          },
          "verified_accounts": [
            {}
          ],
          "power_badge": true,
          "experimental": {
            "deprecation_notice": "<string>",
            "neynar_user_score": 123
          },
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          },
          "score": 123
        }
      ],
      "mentioned_profiles_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ],
      "mentioned_channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "object": "channel_dehydrated",
          "image_url": "<string>",
          "viewer_context": {
            "following": "<any>",
            "role": "<any>"
          }
        }
      ],
      "mentioned_channels_ranges": [
        {
          "start": 1,
          "end": 1
        }
      ],
      "channel": {
        "id": "<string>",
        "url": "<string>",
        "name": "<string>",
        "description": "<string>",
        "object": "channel",
        "created_at": "2023-11-07T05:31:56Z",
        "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",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "pfp_url": "<string>",
          "profile": {
            "bio": {},
            "location": {},
            "banner": {}
          },
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "auth_addresses": [
            {}
          ],
          "verified_addresses": {
            "eth_addresses": [
              "<any>"
            ],
            "sol_addresses": [
              "<any>"
            ],
            "primary": {}
          },
          "verified_accounts": [
            {}
          ],
          "power_badge": true,
          "experimental": {
            "deprecation_notice": "<string>",
            "neynar_user_score": 123
          },
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          },
          "score": 123
        },
        "moderator_fids": [
          3
        ],
        "member_count": 123,
        "moderator": {
          "object": "user",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "pro": {
            "status": "subscribed",
            "subscribed_at": "2023-11-07T05:31:56Z",
            "expires_at": "2023-11-07T05:31:56Z"
          },
          "pfp_url": "<string>",
          "profile": {
            "bio": {},
            "location": {},
            "banner": {}
          },
          "follower_count": 123,
          "following_count": 123,
          "verifications": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "auth_addresses": [
            {}
          ],
          "verified_addresses": {
            "eth_addresses": [
              "<any>"
            ],
            "sol_addresses": [
              "<any>"
            ],
            "primary": {}
          },
          "verified_accounts": [
            {}
          ],
          "power_badge": true,
          "experimental": {
            "deprecation_notice": "<string>",
            "neynar_user_score": 123
          },
          "viewer_context": {
            "following": true,
            "followed_by": true,
            "blocking": true,
            "blocked_by": true
          },
          "score": 123
        },
        "pinned_cast_hash": "0x71d5225f77e0164388b1d4c120825f3a2c1f131c",
        "hosts": [
          {
            "object": "user",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "pro": {
              "status": "subscribed",
              "subscribed_at": "2023-11-07T05:31:56Z",
              "expires_at": "2023-11-07T05:31:56Z"
            },
            "pfp_url": "<string>",
            "profile": {
              "bio": {},
              "location": {},
              "banner": {}
            },
            "follower_count": 123,
            "following_count": 123,
            "verifications": [
              "0x5a927ac639636e534b678e81768ca19e2c6280b7"
            ],
            "auth_addresses": [
              {}
            ],
            "verified_addresses": {
              "eth_addresses": [
                "<any>"
              ],
              "sol_addresses": [
                "<any>"
              ],
              "primary": {}
            },
            "verified_accounts": [
              {}
            ],
            "power_badge": true,
            "experimental": {
              "deprecation_notice": "<string>",
              "neynar_user_score": 123
            },
            "viewer_context": {
              "following": true,
              "followed_by": true,
              "blocking": true,
              "blocked_by": true
            },
            "score": 123
          }
        ],
        "viewer_context": {
          "following": "<any>",
          "role": "<any>"
        },
        "description_mentioned_profiles": [
          {
            "object": "<any>",
            "fid": "<any>",
            "username": "<any>",
            "display_name": "<any>",
            "pfp_url": "<any>",
            "custody_address": "<any>",
            "score": "<any>"
          }
        ],
        "description_mentioned_profiles_ranges": [
          {
            "start": 1,
            "end": 1
          }
        ]
      },
      "viewer_context": {
        "liked": true,
        "recasted": true
      },
      "author_channel_context": {
        "following": "<any>",
        "role": "<any>"
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Headers

​
x-neynar-experimental
boolean
default:false

Enables experimental features including filtering based on the Neynar score. See docs for more details.

Query Parameters

​
feed_type
enum<string>
default:following

Defaults to following (requires FID or address). If set to filter (requires filter_type)

Available options:
following,
filter
Example:

"filter"

​
filter_type
enum<string>

Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id)

Available options:
fids,
parent_url,
channel_id,
embed_url,
embed_types,
global_trending
Example:

"fids"

​
fid
integer

(Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type

Required range: x >= 1
​
fids
string

Used when filter_type=FIDs . Create a feed based on a list of FIDs. Max array size is 100. Requires feed_type and filter_type.

Example:

"3,2,194"

​
parent_url
string

Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type.

Example:

"chain://eip155:1/erc721:0xd4498134211baad5846ce70ce04e7c4da78931cc"

​
channel_id
string

Used when filter_type=channel_id can be used to fetch casts under a channel. Requires feed_type and filter_type.

Example:

"neynar"

​
members_only
boolean | null
default:true
deprecated

Used when filter_type=channel_id. Only include casts from members of the channel. True by default.

Example:

true

​
embed_url
string

Used when filter_type=embed_url. Casts with embedded URLs prefixed by this embed_url param will be returned. We normalize your given URL prefix and prepend 'https://' if no protocol is included. Requires feed_type and filter_type.

Example:

"https://example.com"

​
embed_types
enum<string>[]

Used when filter_type=embed_types can be used to fetch all casts with matching content types. Requires feed_type and filter_type.

​
with_recasts
boolean | null
default:true

Include recasts in the response, true by default

​
limit
integer
default:25

Number of results to fetch

Required range: 1 <= x <= 100
Example:

30

​
cursor
string

Pagination cursor.

​
viewer_fid
integer

Providing this will return a feed that respects this user's mutes and blocks and includes viewer_context.

Required range: x >= 1
Example:

3

Response

Success

​
casts
Cast · object[]
required
​
next
object
required

Returns next cursor