Farcaster
Deploy onchain
Farcaster Hub API
Neynar SDK
Page of events
Copy
Ask AI
curl --request GET \
--url https://snapchain-api.neynar.com/v1/events \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"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
],
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
},
"type": "MESSAGE_TYPE_CAST_ADD"
},
"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
],
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
},
"type": "MESSAGE_TYPE_CAST_ADD"
},
"hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"hashScheme": "HASH_SCHEME_BLAKE3",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"signatureScheme": "SIGNATURE_SCHEME_ED25519",
"signer": "<string>"
}
]
}
}
]
}HubEvents
Page of events
Fetch a list of events.
GET
/
v1
/
events
Page of events
Copy
Ask AI
curl --request GET \
--url https://snapchain-api.neynar.com/v1/events \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"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
],
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
},
"type": "MESSAGE_TYPE_CAST_ADD"
},
"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
],
"text": "<string>",
"mentionsPositions": [
123
],
"embeds": [
{
"castId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
}
}
],
"parentCastId": {
"fid": 2,
"hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
},
"parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
},
"type": "MESSAGE_TYPE_CAST_ADD"
},
"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
A successful response.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Example:
"HUB_EVENT_TYPE_MERGE_MESSAGE"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
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.
Example:
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.
Example:
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
Available options:
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.
Show child attributes
Show child attributes
events.mergeMessageBody.message.data.castAddBody.embeds
URLs or cast IDs to be embedded in the cast · object[]
required
- Option 1
- Option 2
Show child attributes
Show child attributes
A unique identifier for a cast (post) in the Farcaster network, consisting of the creator's FID and a hash of the cast's content. This combination ensures global uniqueness across all casts.
Show child attributes
Show child attributes
The Farcaster ID (FID) of the user who created the cast. Required to uniquely identify the cast's author in the network.
Example:
2
A unique hash that identifies a specific cast within the creator's posts. Generated using HASH_SCHEME_BLAKE3 of the cast's content.
Example:
"0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
A unique identifier for a cast (post) in the Farcaster network, consisting of the creator's FID and a hash of the cast's content. This combination ensures global uniqueness across all casts.
Show child attributes
Show child attributes
The Farcaster ID (FID) of the user who created the cast. Required to uniquely identify the cast's author in the network.
Example:
2
A unique hash that identifies a specific cast within the creator's posts. Generated using HASH_SCHEME_BLAKE3 of the cast's content.
Example:
"0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
Example:
"chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
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
Available options:
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 Example:
"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"
Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData
Available options:
HASH_SCHEME_BLAKE3 events.mergeMessageBody.message.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 Show child attributes
Show child attributes
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
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.
Example:
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.
Example:
48994466
events.mergeMessageBody.deletedMessages.data.network
enum<string>
default:FARCASTER_NETWORK_MAINNET
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
Available options:
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.
Show child attributes
Show child attributes
events.mergeMessageBody.deletedMessages.data.castAddBody.embeds
URLs or cast IDs to be embedded in the cast · object[]
required
- Option 1
- Option 2
Show child attributes
Show child attributes
A unique identifier for a cast (post) in the Farcaster network, consisting of the creator's FID and a hash of the cast's content. This combination ensures global uniqueness across all casts.
Show child attributes
Show child attributes
The Farcaster ID (FID) of the user who created the cast. Required to uniquely identify the cast's author in the network.
Example:
2
A unique hash that identifies a specific cast within the creator's posts. Generated using HASH_SCHEME_BLAKE3 of the cast's content.
Example:
"0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
A unique identifier for a cast (post) in the Farcaster network, consisting of the creator's FID and a hash of the cast's content. This combination ensures global uniqueness across all casts.
Show child attributes
Show child attributes
The Farcaster ID (FID) of the user who created the cast. Required to uniquely identify the cast's author in the network.
Example:
2
A unique hash that identifies a specific cast within the creator's posts. Generated using HASH_SCHEME_BLAKE3 of the cast's content.
Example:
"0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
Example:
"chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
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
Available options:
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 Example:
"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"
Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData
Available options:
HASH_SCHEME_BLAKE3 events.mergeMessageBody.deletedMessages.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 Was this page helpful?
⌘I