Neynar HubEvents API
Operations related to hub events.
This API exposes 2 operations across 2 paths, and defines 58 schemas. It is described by OpenAPI 3.0.4, at version 3.176.0.
Requests are made against a single base URL, https://api.neynar.com.
2 operations
2 paths
58 schemas
2 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Neynar HubEvents API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— API key to authorize requests
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
HubEvents 2
Operations related to hub events.
GET
/v1/events
Page of events
GET
/v1/eventById
Event by ID
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are OnChainEventCommon (9 properties), CastAddBody (7 properties), UserNameProof (6 properties), ErrorResponse (6 properties). Each schema is shown below with its type and property counts.
OnChainEvent
MessageDataLink
Represents a social graph connection between users in the Farcaster network. Currently supports following relationships between users.
OnChainEventStorageRent
HubEventPruneMessage
object
3 properties
3 required
PruneMessageBody
object
1 property
1 required
MessageDataVerificationRemove
Represents a message that removes an existing blockchain address verification from a user's profile. This allows users to disassociate previously verified addr…
MessageDataUsernameProof
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 represen…
FrameActionBody
object
Contains the data for a user's interaction with a Farcaster Frame. Frames are interactive elements within casts that can have up to 4 clickable buttons, allowi…
3 properties
3 required
MergeOnChainEventBody
object
1 property
1 required
CastEmbed
object
1 property
1 required
VerificationAddEthAddressBody
object
Contains the data required to verify ownership of an Ethereum or Solana address. The verification process requires a cryptographic signature from the blockchai…
3 properties
3 required
Embed
VerificationRemoveBody
object
Contains the data required to remove a previously added blockchain address verification from a user's profile. This operation permanently removes the verificat…
1 property
1 required
FidSchema
integer
Farcaster ID (FID). A unique identifier assigned to each user in the Farcaster network. This number is permanent and cannot be changed. FIDs are assigned seque…
SignerEventBody
object
5 properties
5 required
SignatureScheme
string
Type of signature scheme used to sign the Message hash - SIGNATURESCHEMEED25519: Ed25519 signature (default) - SIGNATURESCHEMEEIP712: ECDSA signature using EIP…
FarcasterNetwork
string
Farcaster network the message is intended for. - FARCASTERNETWORKMAINNET: Public primary network - FARCASTERNETWORKTESTNET: Public test network - FARCASTERNETW…
MessageDataUserDataAdd
Represents a message that updates a user's profile metadata. This can include changes to profile picture, display name, bio, URL, or preferred username. Each u…
UserDataType
string
Specifies which field of a user's profile is being updated. - USERDATATYPEPFP: Profile Picture URL for the user's avatar - USERDATATYPEDISPLAY: Display Name sh…
UserDataBody
object
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 con…
2 properties
2 required
MessageCommon
object
5 properties
5 required
MessageDataVerificationAdd
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…
HubEventRevokeMessage
object
3 properties
3 required
UrlEmbed
object
1 property
1 required
MessageType
string
Type of the MessageBody. - MESSAGETYPECASTADD: Add a new Cast - MESSAGETYPECASTREMOVE: Remove an existing Cast - MESSAGETYPEREACTIONADD: Add a Reaction to a Ca…
OnChainEventCommon
object
9 properties
9 required
SignerEventType
string
HashScheme
string
Type of hashing scheme used to produce a digest of MessageData. - HASHSCHEMEBLAKE3: Default scheme for hashing MessageData
ReactionType
string
Type of interaction a user can have with content on the Farcaster network. - Like: Express appreciation for the target content. Similar to "likes" or "favorite…
CastHash
string
A unique hash that identifies a specific cast within the creator's posts. Generated using HASHSCHEMEBLAKE3 of the cast's content.
SignerMigratedEventBody
object
1 property
1 required
RevokeMessageBody
object
1 property
1 required
MessageDataReaction
Represents a user's reaction to content on the Farcaster network. Reactions can be likes or recasts of casts, allowing users to express appreciation or share c…
MergeMessageBody
object
2 properties
2 required
UserNameType
string
MessageDataCastRemove
Represents a request to remove (delete) a previously created cast. Only the original creator of a cast can remove it.
MergeUserNameProofBody
object
4 properties
ErrorResponse
object
6 properties
6 required
LinkType
string
Defines the type of social connection between users. - follow: Establishes a following relationship where the user will receive updates from the target user in…
HubEventMergeMessage
object
3 properties
3 required
ReactionBody
object
Specifies the details of a reaction to content on Farcaster. A reaction must specify its type (like/recast) and either a target cast ID or URL to react to. Onl…
3 properties
1 required
MessageDataCastAdd
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…
OnChainEventSigner
MessageDataCommon
object
Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context.
4 properties
3 required
MessageDataFrameAction
Represents a user's interaction with a Farcaster Frame, which is an interactive element embedded within a cast. Frames allow users to engage with content throu…
HubEvent
OnChainEventIdRegister
HubEventMergeUsernameProof
object
3 properties
3 required
HubEventMergeOnChainEvent
object
3 properties
3 required
IdRegisterEventType
string
LinkBody
object
Defines a social connection between users in the Farcaster network. Currently used to establish following relationships, allowing users to curate their content…
3 properties
2 required
OnChainEventSignerMigrated
UserNameProof
object
6 properties
6 required
CastId
object
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 glob…
2 properties
2 required
IdRegisterEventBody
object
4 properties
4 required
CastAddBody
object
Adds a new Cast
7 properties
5 required
StorageRentEventBody
object
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#HubEvents