Skip to content
On this page

UserData API

The UserData API will accept the following values for the user_data_type field.

StringNumerical valueDescription
USER_DATA_TYPE_PFP1Profile Picture for the user
USER_DATA_TYPE_DISPLAY2Display Name for the user
USER_DATA_TYPE_BIO3Bio for the user
USER_DATA_TYPE_URL5URL of the user
USER_DATA_TYPE_USERNAME6Preferred Name for the user

userDataByFid

Get UserData for a FID.

Query Parameters

ParameterDescriptionExample
fidThe FID that's being requestedfid=6833
user_data_typeThe type of user data, either as a numerical value or type string. If this is ommited, all user data for the FID is returneduser_data_type=1 OR user_data_type=USER_DATA_TYPE_DISPLAY

Example

bash
curl http://127.0.0.1:2281/v1/userDataByFid?fid=6833&user_data_type=1

Response

json
{
  "data": {
    "type": "MESSAGE_TYPE_USER_DATA_ADD",
    "fid": 6833,
    "timestamp": 83433831,
    "network": "FARCASTER_NETWORK_MAINNET",
    "userDataBody": {
      "type": "USER_DATA_TYPE_PFP",
      "value": "https://i.imgur.com/HG54Hq6.png"
    }
  },
  "hash": "0x327b8f47218c369ae01cc453cc23efc79f10181f",
  "hashScheme": "HASH_SCHEME_BLAKE3",
  "signature": "XITQZD7q...LdAlJ9Cg==",
  "signatureScheme": "SIGNATURE_SCHEME_ED25519",
  "signer": "0x0852...6e999cdd"
}