Fetch all casts that mention an FID

GET

castsByMention

curl --request GET \
  --url https://hub.pinata.cloud/v1/castsByMention

{
  "messages": [
    {
      "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
      "hashScheme": "HASH_SCHEME_BLAKE3",
      "signature": "aSDinaTvuI8gbWludGxpZnk=",
      "signatureScheme": "SIGNATURE_SCHEME_ED25519",
      "signer": "<string>",
      "data": {
        "type": "MESSAGE_TYPE_CAST_ADD",
        "fid": 2,
        "timestamp": 48994466,
        "network": "FARCASTER_NETWORK_MAINNET",
        "castAddBody": {
          "embedsDeprecated": [
            "<string>"
          ],
          "mentions": [
            2
          ],
          "parentCastId": {
            "fid": 123,
            "hash": "<string>"
          },
          "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
          "text": "<string>",
          "mentionsPositions": [
            123
          ],
          "embeds": [
            {
              "url": "<string>",
              "castId": {
                "fid": 123,
                "hash": "<string>"
              }
            }
          ]
        }
      }
    }
  ],
  "nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}

Query Parameters

fid

integer

required

The FID that is mentioned in a cast

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

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: Deprecated MESSAGE_TYPE_SIGNER_ADD = 9; // Add a new Ed25519 key pair that signs messages for a user MESSAGE_TYPE_SIGNER_REMOVE = 10; // Remove an Ed25519 key pair that signs messages for a user

Add metadata about a user

MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof

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

messages.data.fid

integer

required

Example:

2

messages.data.timestamp

integer

required

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

Adds a new Cast

nextPageToken

string

required

Suggest edits

Fetch all casts by parent cast's FID and Hash OR by the parent's URL Get a cast by its FID and Hash.

curl --request GET \
  --url https://hub.pinata.cloud/v1/castsByMention

{
  "messages": [
    {
      "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
      "hashScheme": "HASH_SCHEME_BLAKE3",
      "signature": "aSDinaTvuI8gbWludGxpZnk=",
      "signatureScheme": "SIGNATURE_SCHEME_ED25519",
      "signer": "<string>",
      "data": {
        "type": "MESSAGE_TYPE_CAST_ADD",
        "fid": 2,
        "timestamp": 48994466,
        "network": "FARCASTER_NETWORK_MAINNET",
        "castAddBody": {
          "embedsDeprecated": [
            "<string>"
          ],
          "mentions": [
            2
          ],
          "parentCastId": {
            "fid": 123,
            "hash": "<string>"
          },
          "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2",
          "text": "<string>",
          "mentionsPositions": [
            123
          ],
          "embeds": [
            {
              "url": "<string>",
              "castId": {
                "fid": 123,
                "hash": "<string>"
              }
            }
          ]
        }
      }
    }
  ],
  "nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}

Get Started

Account Management

Files

Gateways

Additional Resources

Fetch all casts that mention an FID

Query Parameters

Response