--- title: "Fetch UserData for a FID" method: GET path: "/v1/userDataByFid" tags: ["UserData"] --- # Fetch UserData for a FID `GET /v1/userDataByFid` **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. ## Query parameters - `fid` integer, required - `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 - `pageSize` integer - `reverse` boolean - `pageToken` string ## Response `200` The requested UserData. - union - UserDataAdd - `hash` string, required - `hashScheme` 'HASH_SCHEME_BLAKE3', required — Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData - `signature` string, byte, required - `signatureScheme` 'SIGNATURE_SCHEME_ED25519' | 'SIGNATURE_SCHEME_EIP712', 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 - `signer` string, required - `data` object, required — Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context. - `type` 'MESSAGE_TYPE_CAST_ADD' | 'MESSAGE_TYPE_CAST_REMOVE' | 'MESSAGE_TYPE_REACTION_ADD' | 'MESSAGE_TYPE_REACTION_REMOVE' | 'MESSAGE_TYPE_LINK_ADD' | 'MESSAGE_TYPE_LINK_REMOVE' | 'MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS' | 'MESSAGE_TYPE_VERIFICATION_REMOVE' | 'MESSAGE_TYPE_USER_DATA_ADD' | 'MESSAGE_TYPE_USERNAME_PROOF' | 'MESSAGE_TYPE_FRAME_ACTION', required — Type of the MessageBody. - MESSAGE_TYPE_CAST_ADD: Add a new Cast - MESSAGE_TYPE_CAST_REMOVE: Remove an existing Cast - MESSAGE_TYPE_REACTION_ADD: Add a Reaction to a Cast - MESSAGE_TYPE_REACTION_REMOVE: Remove a Reaction from a Cast - MESSAGE_TYPE_LINK_ADD: Add a new Link - MESSAGE_TYPE_LINK_REMOVE: Remove an existing Link - MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS: Add a Verification of an Ethereum Address - MESSAGE_TYPE_VERIFICATION_REMOVE: Remove a Verification - MESSAGE_TYPE_USER_DATA_ADD: Add metadata about a user - MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof - MESSAGE_TYPE_FRAME_ACTION: A Farcaster Frame action - `fid` integer, required — The unique identifier (FID) of the user who created this message. FIDs are assigned sequentially when users register on the network and cannot be changed. - `timestamp` integer, required — Seconds since Farcaster Epoch (2021-01-01T00:00:00Z). Used to order messages chronologically and determine the most recent state. Must be within 10 minutes of the current time when the message is created. - `network` 'FARCASTER_NETWORK_MAINNET' | 'FARCASTER_NETWORK_TESTNET' | 'FARCASTER_NETWORK_DEVNET', required — Farcaster network the message is intended for. - FARCASTER_NETWORK_MAINNET: Public primary network - FARCASTER_NETWORK_TESTNET: Public test network - FARCASTER_NETWORK_DEVNET: Private test network - `userDataBody` UserDataBody, required — 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 control over profile information. - `type` 'USER_DATA_TYPE_PFP' | 'USER_DATA_TYPE_DISPLAY' | 'USER_DATA_TYPE_BIO' | 'USER_DATA_TYPE_URL' | 'USER_DATA_TYPE_USERNAME', required — 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 - `value` string, required — The new value for the specified profile field. The format depends on the type: URLs for profile pictures, plain text for display names and bios, etc. - object - `messages` UserDataAdd[], required - `hash` string, required - `hashScheme` 'HASH_SCHEME_BLAKE3', required — Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData - `signature` string, byte, required - `signatureScheme` 'SIGNATURE_SCHEME_ED25519' | 'SIGNATURE_SCHEME_EIP712', 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 - `signer` string, required - `data` object, required — Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context. - `type` 'MESSAGE_TYPE_CAST_ADD' | 'MESSAGE_TYPE_CAST_REMOVE' | 'MESSAGE_TYPE_REACTION_ADD' | 'MESSAGE_TYPE_REACTION_REMOVE' | 'MESSAGE_TYPE_LINK_ADD' | 'MESSAGE_TYPE_LINK_REMOVE' | 'MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS' | 'MESSAGE_TYPE_VERIFICATION_REMOVE' | 'MESSAGE_TYPE_USER_DATA_ADD' | 'MESSAGE_TYPE_USERNAME_PROOF' | 'MESSAGE_TYPE_FRAME_ACTION', required — Type of the MessageBody. - MESSAGE_TYPE_CAST_ADD: Add a new Cast - MESSAGE_TYPE_CAST_REMOVE: Remove an existing Cast - MESSAGE_TYPE_REACTION_ADD: Add a Reaction to a Cast - MESSAGE_TYPE_REACTION_REMOVE: Remove a Reaction from a Cast - MESSAGE_TYPE_LINK_ADD: Add a new Link - MESSAGE_TYPE_LINK_REMOVE: Remove an existing Link - MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS: Add a Verification of an Ethereum Address - MESSAGE_TYPE_VERIFICATION_REMOVE: Remove a Verification - MESSAGE_TYPE_USER_DATA_ADD: Add metadata about a user - MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof - MESSAGE_TYPE_FRAME_ACTION: A Farcaster Frame action - `fid` integer, required — The unique identifier (FID) of the user who created this message. FIDs are assigned sequentially when users register on the network and cannot be changed. - `timestamp` integer, required — Seconds since Farcaster Epoch (2021-01-01T00:00:00Z). Used to order messages chronologically and determine the most recent state. Must be within 10 minutes of the current time when the message is created. - `network` 'FARCASTER_NETWORK_MAINNET' | 'FARCASTER_NETWORK_TESTNET' | 'FARCASTER_NETWORK_DEVNET', required — Farcaster network the message is intended for. - FARCASTER_NETWORK_MAINNET: Public primary network - FARCASTER_NETWORK_TESTNET: Public test network - FARCASTER_NETWORK_DEVNET: Private test network - `userDataBody` UserDataBody, required — 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 control over profile information. - `type` 'USER_DATA_TYPE_PFP' | 'USER_DATA_TYPE_DISPLAY' | 'USER_DATA_TYPE_BIO' | 'USER_DATA_TYPE_URL' | 'USER_DATA_TYPE_USERNAME', required — 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 - `value` string, required — The new value for the specified profile field. The format depends on the type: URLs for profile pictures, plain text for display names and bios, etc. - `nextPageToken` string, byte, required — Base64-encoded pagination token for fetching the next page of results. An empty value indicates there are no more pages to return. Used in conjunction with the pageSize parameter to implement pagination across large result sets. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.dev/neynar/apis/neynar-api.md) · [All operations](https://skmtc.dev/neynar/apis/neynar-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neynar/neynar-api/revisions/dbb91bfb0d1a/schema)