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
Page of events
Fetch a list of events.
curl --request GET \
--url https://hub-api.neynar.com/v1/events \
--header 'x-api-key: <api-key>'{
"nextPageEventId": 123,
"events": [
{
"type": "HUB_EVENT_TYPE_MERGE_MESSAGE",
"id": 123,
"mergeMessageBody": {
"message": {
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"castAddBody": {
"embedsDeprecated": [
"<string>"
],
"mentions": [
2
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
]
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>"
},
"deletedMessages": [
{
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"castAddBody": {
"embedsDeprecated": [
"<string>"
],
"mentions": [
2
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
]
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>"
}
]
}
}
]
}Authorizations
API key to authorize requests
Query Parameters
An optional Hub Id to start getting events from. This is also returned from the API as nextPageEventId, which can be used to page through all the Hub events. Set it to 0 to start from the first event.
Response
"HUB_EVENT_TYPE_MERGE_MESSAGE"
A Message is a delta operation on the Farcaster network that represents a state change. Messages are the fundamental unit of data in Farcaster and can represent various actions like:
- Creating or removing casts (posts)
- Adding or removing reactions
- Following or unfollowing users
- Updating profile data
- Verifying Ethereum addresses
Each message contains:
- A MessageData object with the actual content
- A hash of the content for integrity verification
- A cryptographic signature to prove authenticity
- The signer's public key for verification
Messages are immutable once created and form an append-only log of all user actions on the network.
Represents a new cast (post) being created in the Farcaster network. A cast can include text content, mentions of other users, embedded URLs, and references to parent posts for replies.
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 The content and metadata of the new cast, including the text, mentions, embeds, and any parent references for replies.
"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 A Message is a delta operation on the Farcaster network that represents a state change. Messages are the fundamental unit of data in Farcaster and can represent various actions like:
- Creating or removing casts (posts)
- Adding or removing reactions
- Following or unfollowing users
- Updating profile data
- Verifying Ethereum addresses
Each message contains:
- A MessageData object with the actual content
- A hash of the content for integrity verification
- A cryptographic signature to prove authenticity
- The signer's public key for verification
Messages are immutable once created and form an append-only log of all user actions on the network.
Represents a new cast (post) being created in the Farcaster network. A cast can include text content, mentions of other users, embedded URLs, and references to parent posts for replies.
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 The content and metadata of the new cast, including the text, mentions, embeds, and any parent references for replies.
"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 Was this page helpful?
curl --request GET \
--url https://hub-api.neynar.com/v1/events \
--header 'x-api-key: <api-key>'{
"nextPageEventId": 123,
"events": [
{
"type": "HUB_EVENT_TYPE_MERGE_MESSAGE",
"id": 123,
"mergeMessageBody": {
"message": {
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"castAddBody": {
"embedsDeprecated": [
"<string>"
],
"mentions": [
2
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
]
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>"
},
"deletedMessages": [
{
"data": {
"fid": 2,
"timestamp": 48994466,
"network": "FARCASTER_NETWORK_MAINNET",
"castAddBody": {
"embedsDeprecated": [
"<string>"
],
"mentions": [
2
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
]
}
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>"
}
]
}
}
]
}