GET
/
users
curl --request GET \
  --url https://api.pinata.cloud/v3/farcaster/users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "users": [
      {
        "fid": 2,
        "custody_address": "0x4114e33eb831858649ea3702e1c9a2db3f626446",
        "recovery_address": "0x00000000fcb080a4d6c39a9354da9eb9bc104cd7",
        "following_count": 1138,
        "follower_count": 150650,
        "verifications": [
          "0x182327170fc284caaa5b1bc3e3878233f529d741",
          "0x83f7335253bfaf321de49f25f6fd67fa8f1d0665b4cab33f67f7e4341bfd91d0",
          "0x91031dcfdea024b4d51e775486111d2b2a715871",
          "0x91701714719f1388e7f5cf8156b7bcdf001e5dcd1354151488959fdf343caff5",
          "0xf86a7a5b7c703b1fd8d93c500ac4cc75b67477f0"
        ],
        "bio": "Technowatermelon. Elder Millenial. Building Farcaster. \n\nnf.td/varun",
        "display_name": "Varun Srinivasan",
        "pfp_url": "https://i.seadn.io/gae/sYAr036bd0bRpj7OX6B-F-MqLGznVkK3--DSneL_BT5GX4NZJ3Zu91PgjpD9-xuVJtHq0qirJfPZeMKrahz8Us2Tj_X8qdNPYC-imqs?w=500&auto=format",
        "username": "v"
      }
    ],
    "next_page_token": "eyJvZmZzZXQiOiIyIn0"
  }
}

This endpoint is similar to /casts in that you can either fetch a specific user by FID or you can combine multiple query parameters to get specific lists of users.

​
Users Following FID

/users?fid=6023&followers=true

Returns all the users following a specific FID

​
Users FID Following

/users?fid=6023&following=true

Returns all the users a specific FID is following

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fid
integer

Used in combination with followers and following

followers
boolean

When used with fid will return the followers of the specified fid

following
boolean

When used with fid will return the users fid is following

pageSize
integer

Determine the number of results, if not specified default is 100

pageToken
string

Token to be used for the next page of results

Response

200 - application/json

The response is of type object.

User By FIDGetting Started