Neynar Documentation

Page of events

cURL

curl --request GET \
  --url https://snapchain-api.neynar.com/v1/events \
  --header 'x-api-key: NEYNAR_API_DOCS'
import requests

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

headers = {"x-api-key": "NEYNAR_API_DOCS"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};

fetch('https://snapchain-api.neynar.com/v1/events', 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/events",
  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: NEYNAR_API_DOCS"
  ],
]);

$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/events"

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

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

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

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

fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://snapchain-api.neynar.com/v1/events")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();
require 'uri'
require 'net/http'

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

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

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

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

Response

200

default

{
  "nextPageEventId": 123,
  "events": [
    {
      "type": "HUB_EVENT_TYPE_MERGE_MESSAGE",
      "id": 123,
      "mergeMessageBody": {
        "message": {
          "data": {
            "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"
            },
            "type": "MESSAGE_TYPE_CAST_ADD"
          },
          "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
                ],
                "text": "<string>",
                "mentionsPositions": [
                  123
                ],
                "embeds": [
                  {
                    "castId": {
                      "fid": 2,
                      "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
                    }
                  }
                ],
                "parentCastId": {
                  "fid": 2,
                  "hash": "0x03aff391a6eb1772b20b4ead9a89f732be75fe27"
                },
                "parentUrl": "chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2"
              },
              "type": "MESSAGE_TYPE_CAST_ADD"
            },
            "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
            "hashScheme": "HASH_SCHEME_BLAKE3",
            "signature": "aSDinaTvuI8gbWludGxpZnk=",
            "signatureScheme": "SIGNATURE_SCHEME_ED25519",
            "signer": "<string>"
          }
        ]
      }
    }
  ]
}
{
  "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

from_event_id
integer
An optional Hub Id to start getting events from. This is also returned from the API as nextPageEventId, which can be used to page through all the Hub events. Set it to 0 to start from the first event.

Response

200
application/json
A successful response.