Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
UserData

Fetch UserData for a FID

Note: one of two different response schemas is returned based on whether the caller provides the user_data_type parameter. If included, a single UserDataAdd message is returned (or a not_found error). If omitted, a paginated list of UserDataAdd messages is returned instead.

get/v1/userDataByFid

Query parameters

fidinteger required

The FID that's being requested

user_data_type'USER_DATA_TYPE_PFP' | 'USER_DATA_TYPE_DISPLAY' | 'USER_DATA_TYPE_BIO' | 'USER_DATA_TYPE_URL' | 'USER_DATA_TYPE_USERNAME'

Specifies which field of a user's profile is being updated.

  • USER_DATA_TYPE_PFP: Profile Picture URL for the user's avatar
  • USER_DATA_TYPE_DISPLAY: Display Name shown on the user's profile
  • USER_DATA_TYPE_BIO: Biography or description of the user
  • USER_DATA_TYPE_URL: Website or social media link for the user
  • USER_DATA_TYPE_USERNAME: Preferred username for the user

The type of user data, either as a numerical value or type string. If this is omitted, all user data for the FID is returned

pageSizeinteger

Maximum number of messages to return in a single response

reverseboolean

Reverse the sort order, returning latest messages first

pageTokenstring

The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

Response

The requested UserData.

OR

Example response

{
  "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
  "data": {
    "fid": 2,
    "timestamp": 48994466,
    "userDataBody": {
      "value": "https://i.imgur.com/123abc.jpg"
    }
  }
}