GET
/
farcaster
/
following
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/following \
  --header 'x-api-key: <api-key>'
{
  "users": [
    {
      "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
        }
      }
    }
  ],
  "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

fid
integer
required

FID of the user whose following you want to fetch.

Examples:

3

191

2

194

19960

viewer_fid
integer

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

Examples:

3

191

2

194

19960

sort_type
enum<string>

Optional parameter to sort the users based on different criteria.

Available options:
desc_chron,
affinity_score
Examples:

"desc_chron"

limit
integer
default:25

Number of results to fetch

Required range: 1 <= x <= 100
cursor
string

Pagination cursor.

Response

200
application/json
Successful operation.
users
object[]
required
next
object
required

Returns next cursor