Skip to main content
GET
/
v1
/
userDataByFid
Fetch UserData for a FID
curl --request GET \
  --url https://snapchain-api.neynar.com/v1/userDataByFid \
  --header 'x-api-key: <api-key>'
{
  "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
  "hashScheme": "HASH_SCHEME_BLAKE3",
  "signature": "aSDinaTvuI8gbWludGxpZnk=",
  "signatureScheme": "SIGNATURE_SCHEME_ED25519",
  "signer": "<string>",
  "data": {
    "type": "MESSAGE_TYPE_CAST_ADD",
    "fid": 2,
    "timestamp": 48994466,
    "network": "FARCASTER_NETWORK_MAINNET",
    "userDataBody": {
      "type": "USER_DATA_TYPE_PFP",
      "value": "https://i.imgur.com/123abc.jpg"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

ā€‹
fid
integer
required

The FID that's being requested

ā€‹
user_data_type
enum<string>
default:USER_DATA_TYPE_PFP

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 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
Available options:
USER_DATA_TYPE_PFP,
USER_DATA_TYPE_DISPLAY,
USER_DATA_TYPE_BIO,
USER_DATA_TYPE_URL,
USER_DATA_TYPE_USERNAME
ā€‹
pageSize
integer

Maximum number of messages to return in a single response

ā€‹
reverse
boolean

Reverse the sort order, returning latest messages first

ā€‹
pageToken
string

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.

ā€‹
hash
string
required
Pattern: ^0x[0-9a-fA-F]{40}$
Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

ā€‹
hashScheme
enum<string>
default:HASH_SCHEME_BLAKE3
required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:
HASH_SCHEME_BLAKE3
ā€‹
signature
string<byte>
required
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
ā€‹
signatureScheme
enum<string>
default:SIGNATURE_SCHEME_ED25519
required

Type of signature scheme used to sign the Message hash

  • SIGNATURE_SCHEME_ED25519: Ed25519 signature (default)
  • SIGNATURE_SCHEME_EIP712: ECDSA signature using EIP-712 scheme
Available options:
SIGNATURE_SCHEME_ED25519,
SIGNATURE_SCHEME_EIP712
ā€‹
signer
string
required
Pattern: ^0x[0-9a-fA-F]+$
ā€‹
data
object
required

Represents a message that updates a user's profile metadata. This can include changes to profile picture, display name, bio, URL, or preferred username. Each update modifies a single profile field.