By FID - Neynar

Status

Blog

Overview

Farcaster API V2

User
Signer
Cast
Feed
Reaction
Notifications
Channel
Follows
Storage
Frame
Agents
Fname
Webhook
Action
Mute
Block
Ban
Onchain
Login
Metrics

Onchain

POST
Deploy fungible

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

Github

GET

castsByFid

curl --request GET \
  --url https://hub-api.neynar.com/v1/castsByFid \
  --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",
        "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"
              }
            }
          ]
        },
        "type": "MESSAGE_TYPE_CAST_ADD"
      }
    }
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}

Authorizations

x-api-key

string

header

default:NEYNAR_API_DOCS

required

API key to authorize requests

Query Parameters

fid

integer

required

The FID of the casts' creator

Required range: x >= 1

Example:

1

pageSize

integer

Maximum number of messages to return in a single response

reverse

boolean

Reverse the sort order, returning latest messages first

pageToken

string

The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

Response

200

application/json

The requested Casts.

messages

object[]

required

messages.hash

string

required

Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

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

messages.signature

string

required

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

messages.signer

string

required

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

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

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

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

messages.data.castAddBody

object

required

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

messages.data.type

enum<string>

default:MESSAGE_TYPE_CAST_ADD

required

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

nextPageToken

string

required

Base64-encoded pagination token for fetching the next page of results. An empty value indicates there are no more pages to return. Used in conjunction with the pageSize parameter to implement pagination across large result sets.

Example:

"AuzO1V0DtaItCwwa10X6YsfStlynsGWT"

Was this page helpful?

By FID and Hash Mentioning an FID

curl --request GET \
  --url https://hub-api.neynar.com/v1/castsByFid \
  --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",
        "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"
              }
            }
          ]
        },
        "type": "MESSAGE_TYPE_CAST_ADD"
      }
    }
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}