Neynar UserData API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth — API key to authorize requests
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
UserData 1
Operations related to user data.
GET
/v1/userDataByFid
Fetch UserData for a FID
fetch-user-data5 params→ 200default
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (6 properties), MessageCommon (5 properties), MessageDataCommon (4 properties), UserDataBody (2 properties). Each schema is shown below with its type and property counts.
MessageDataUserDataAdd
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 u…
FarcasterNetwork
string
Farcaster network the message is intended for. - FARCASTERNETWORKMAINNET: Public primary network - FARCASTERNETWORKTESTNET: Public test network - FARCASTERNETW…
UserDataType
string
Specifies which field of a user's profile is being updated. - USERDATATYPEPFP: Profile Picture URL for the user's avatar - USERDATATYPEDISPLAY: Display Name sh…
SignatureScheme
string
Type of signature scheme used to sign the Message hash - SIGNATURESCHEMEED25519: Ed25519 signature (default) - SIGNATURESCHEMEEIP712: ECDSA signature using EIP…
UserDataBody
object
Contains the data for updating a specific field of a user's profile metadata. Each update operation modifies one profile field at a time, allowing granular con…
2 properties2 required
MessageDataCommon
object
Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context.
4 properties3 required
MessageCommon
object
5 properties5 required
PaginationResponse
object
1 property1 required
MessageType
string
Type of the MessageBody. - MESSAGETYPECASTADD: Add a new Cast - MESSAGETYPECASTREMOVE: Remove an existing Cast - MESSAGETYPEREACTIONADD: Add a Reaction to a Ca…
ErrorResponse
object
6 properties6 required
UserDataAdd
HashScheme
string
Type of hashing scheme used to produce a digest of MessageData. - HASHSCHEMEBLAKE3: Default scheme for hashing MessageData
Specification
The full machine-readable OpenAPI contract behind this narrative.
