Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Frame
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Provided by an FID
Fetch verifications provided by a user.
curl --request GET \
--url https://hub-api.neynar.com/v1/verificationsByFid \
--header 'x-api-key: <api-key>'{
"messages": [
{
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>",
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"verificationAddEthAddressBody": {
"address": "0x1234567890123456789012345678901234567890",
"ethSignature": "4mGN6TACFqXUVU9RpwLDGCqgqiV1GidEFk9eKF0L0h6JNqmN3kRM9NMPnjUnkh8oL6+jFeQJ9YVuKX4F9EqGiAE=",
"blockHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
},
"type": "MESSAGE_TYPE_CAST_ADD"
}
}
],
"nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}Authorizations
API key to authorize requests
Query Parameters
The FID being requested
The optional ETH address to filter by
Maximum number of messages to return in a single response
Reverse the sort order, returning latest messages first
The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
Response
"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"
Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData
HASH_SCHEME_BLAKE3 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
SIGNATURE_SCHEME_ED25519, SIGNATURE_SCHEME_EIP712 Represents a message that adds verification of ownership for an Ethereum or Solana address to a user's profile. This verification proves that the user controls the specified blockchain address.
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.
2
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.
48994466
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
FARCASTER_NETWORK_MAINNET, FARCASTER_NETWORK_TESTNET, FARCASTER_NETWORK_DEVNET Contains the blockchain address being verified, along with cryptographic proof of ownership through a signature.
The Ethereum (0x-prefixed) or Solana address that the user is claiming ownership of. Must match the address that produced the signature.
"0x1234567890123456789012345678901234567890"
Base64-encoded signature produced by the blockchain address, proving ownership. For Ethereum, this is an ECDSA signature of a specific message format.
"4mGN6TACFqXUVU9RpwLDGCqgqiV1GidEFk9eKF0L0h6JNqmN3kRM9NMPnjUnkh8oL6+jFeQJ9YVuKX4F9EqGiAE="
The hash of the most recent block when the signature was created. Used to verify the approximate time of signature creation.
"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
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
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 Was this page helpful?
curl --request GET \
--url https://hub-api.neynar.com/v1/verificationsByFid \
--header 'x-api-key: <api-key>'{
"messages": [
{
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>",
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"verificationAddEthAddressBody": {
"address": "0x1234567890123456789012345678901234567890",
"ethSignature": "4mGN6TACFqXUVU9RpwLDGCqgqiV1GidEFk9eKF0L0h6JNqmN3kRM9NMPnjUnkh8oL6+jFeQJ9YVuKX4F9EqGiAE=",
"blockHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
},
"type": "MESSAGE_TYPE_CAST_ADD"
}
}
],
"nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}