Neynar Documentation

Mentioning an FID

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://snapchain-api.neynar.com/v1/castsByMention', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://snapchain-api.neynar.com/v1/castsByMention",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://snapchain-api.neynar.com/v1/castsByMention"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://snapchain-api.neynar.com/v1/castsByMention")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
          ],
          "text": "<string>",
          "mentionsPositions": [
            123
          ],
          "embeds": [
            {
              "castId": {
                "fid": 2,
                "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
              }
            }
          ],
          "parentCastId": {
            "fid": 2,
            "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
          },
          "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
        }
      }
    }
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}

{
  "errCode": "<string>",
  "presentable": true,
  "name": "<string>",
  "code": 123,
  "details": "<string>",
  "metadata": {
    "errcode": [
      "<string>"
    ]
  }
}

GET

castsByMention

Mentioning an FID

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://snapchain-api.neynar.com/v1/castsByMention', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://snapchain-api.neynar.com/v1/castsByMention",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://snapchain-api.neynar.com/v1/castsByMention"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://snapchain-api.neynar.com/v1/castsByMention")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
          ],
          "text": "<string>",
          "mentionsPositions": [
            123
          ],
          "embeds": [
            {
              "castId": {
                "fid": 2,
                "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
              }
            }
          ],
          "parentCastId": {
            "fid": 2,
            "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
          },
          "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
        }
      }
    }
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}

{
  "errCode": "<string>",
  "presentable": true,
  "name": "<string>",
  "code": 123,
  "details": "<string>",
  "metadata": {
    "errcode": [
      "<string>"
    ]
  }
}

Authorizations

x-api-key

string

header

default:NEYNAR_API_DOCS

required

API key to authorize requests

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

The requested Casts.

messages

object[]

required

Show child attributes

nextPageToken

string<byte>

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.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Example:

"AuzO1V0DtaItCwwa10X6YsfStlynsGWT"

Overview

Farcaster

Onchain

Deploy onchain

Farcaster Hub API

Other SDKs

Github

Mentioning an FID

Authorizations

Query Parameters

Response