Event by ID - Neynar

Status

Blog

Overview

Farcaster API V2

Onchain

Farcaster Hub API

Neynar SDK

Github

GET

eventById

curl --request GET \
  --url https://hub-api.neynar.com/v1/eventById \
  --header 'x-api-key: <api-key>'

{
  "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

x-api-key

string

header

default:NEYNAR_API_DOCS

required

API key to authorize requests

Query Parameters

event_id

integer

required

The Hub Id of the event

Response

200

application/json

A successful response.

type

string

required

Example:

"HUB_EVENT_TYPE_MERGE_MESSAGE"

integer

required

mergeMessageBody

object

required

mergeMessageBody.message

object

required

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.

mergeMessageBody.message.data

object

required

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.

mergeMessageBody.message.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeMessageBody.message.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeMessageBody.message.signature

string

required

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

mergeMessageBody.message.signer

string

required

mergeMessageBody.deletedMessages

object[]

required

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.

mergeMessageBody.deletedMessages.data

object

required

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.

mergeMessageBody.deletedMessages.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeMessageBody.deletedMessages.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeMessageBody.deletedMessages.signature

string

required

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

mergeMessageBody.deletedMessages.signer

string

required

type

string

required

Example:

"HUB_EVENT_TYPE_MERGE_MESSAGE"

integer

required

mergeMessageBody

object

required

mergeMessageBody.message

object

required

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.

mergeMessageBody.message.data

object

required

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.

mergeMessageBody.message.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeMessageBody.message.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeMessageBody.message.signature

string

required

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

mergeMessageBody.message.signer

string

required

mergeMessageBody.deletedMessages

object[]

required

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.

mergeMessageBody.deletedMessages.data

object

required

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.

mergeMessageBody.deletedMessages.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeMessageBody.deletedMessages.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeMessageBody.deletedMessages.signature

string

required

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

mergeMessageBody.deletedMessages.signer

string

required

type

string

required

Example:

"HUB_EVENT_TYPE_PRUNE_MESSAGE"

integer

required

pruneMessageBody

object

required

pruneMessageBody.message

object

required

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.

pruneMessageBody.message.data

object

required

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.

pruneMessageBody.message.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

pruneMessageBody.message.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

pruneMessageBody.message.signature

string

required

pruneMessageBody.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

pruneMessageBody.message.signer

string

required

type

string

required

Example:

"HUB_EVENT_TYPE_REVOKE_MESSAGE"

integer

required

revokeMessageBody

object

required

revokeMessageBody.message

object

required

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.

revokeMessageBody.message.data

object

required

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.

revokeMessageBody.message.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

revokeMessageBody.message.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

revokeMessageBody.message.signature

string

required

revokeMessageBody.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

revokeMessageBody.message.signer

string

required

type

string

required

Example:

"HUB_EVENT_TYPE_MERGE_USERNAME_PROOF"

integer

required

mergeUsernameProofBody

object

required

mergeUsernameProofBody.usernameProof

object

mergeUsernameProofBody.deletedUsernameProof

object

mergeUsernameProofBody.usernameProofMessage

object

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.

mergeUsernameProofBody.usernameProofMessage.data

object

required

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.

mergeUsernameProofBody.usernameProofMessage.data.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.

Example:

2

mergeUsernameProofBody.usernameProofMessage.data.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.

Example:

48994466

mergeUsernameProofBody.usernameProofMessage.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

mergeUsernameProofBody.usernameProofMessage.data.castAddBody

object

required

The content and metadata of the new cast, including the text, mentions, embeds, and any parent references for replies.

mergeUsernameProofBody.usernameProofMessage.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeUsernameProofBody.usernameProofMessage.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeUsernameProofBody.usernameProofMessage.signature

string

required

mergeUsernameProofBody.usernameProofMessage.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

mergeUsernameProofBody.usernameProofMessage.signer

string

required

mergeUsernameProofBody.deletedUsernameProofMessage

object

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.

mergeUsernameProofBody.deletedUsernameProofMessage.data

object

required

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.

mergeUsernameProofBody.deletedUsernameProofMessage.data.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.

Example:

2

mergeUsernameProofBody.deletedUsernameProofMessage.data.timestamp

integer

required

Example:

48994466

mergeUsernameProofBody.deletedUsernameProofMessage.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

mergeUsernameProofBody.deletedUsernameProofMessage.data.castAddBody

object

required

The content and metadata of the new cast, including the text, mentions, embeds, and any parent references for replies.

mergeUsernameProofBody.deletedUsernameProofMessage.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

mergeUsernameProofBody.deletedUsernameProofMessage.hashScheme

enum<string>

default:HASH_SCHEME_BLAKE3

required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:

HASH_SCHEME_BLAKE3

mergeUsernameProofBody.deletedUsernameProofMessage.signature

string

required

mergeUsernameProofBody.deletedUsernameProofMessage.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

mergeUsernameProofBody.deletedUsernameProofMessage.signer

string

required

type

string

required

Example:

"HUB_EVENT_TYPE_MERGE_ON_CHAIN_EVENT"

integer

required

mergeOnChainEventBody

object

required

Page of events Getting Started with Neynar NodeJS SDK

curl --request GET \
  --url https://hub-api.neynar.com/v1/eventById \
  --header 'x-api-key: <api-key>'

{
  "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>"
      }
    ]
  }
}