Neynar Documentation

Fetch a webhook

cURL

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/webhook/ \
  --header 'x-api-key: NEYNAR_API_DOCS'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/webhook/"

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

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

print(response.text)

JavaScript Fetch API

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

fetch('https://api.neynar.com/v2/farcaster/webhook/', 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://api.neynar.com/v2/farcaster/webhook/",
  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;
}

Go

package main

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

func main() {

url := "https://api.neynar.com/v2/farcaster/webhook/"

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))
}

Unirest

HttpResponse<String> response = Unirest.get("https://api.neynar.com/v2/farcaster/webhook/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/webhook/")

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 Examples

Success Response

{
  "message": "<string>",
  "success": true,
  "webhook": {
    "active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "developer_uuid": "<string>",
    "http_timeout": "<string>",
    "object": "webhook",
    "rate_limit": 123,
    "rate_limit_duration": "<string>",
    "secrets": [
      {
        "created_at": "<string>",
        "deleted_at": "<string>",
        "expires_at": "<string>",
        "uid": "<string>",
        "updated_at": "<string>",
        "value": "<string>"
      }
    ],
    "target_url": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "webhook_id": "<string>",
    "subscription": {
      "created_at": "2023-11-07T05:31:56Z",
      "filters": {
        "cast.created": {
          "author_fids": [
            123
          ],
          "embedded_cast_author_fids": [
            123
          ],
          "embedded_cast_hashes": [
            "<string>"
          ],
          "embeds": "\b(farcaster|neynar)\b",
          "exclude_author_fids": [
            123
          ],
          "mentioned_fids": [
            123
          ],
          "minimum_author_score": 0,
          "parent_author_fids": [
            123
          ],
          "parent_hashes": [
            "<string>"
          ],
          "parent_urls": [
            "<string>"
          ],
          "root_parent_urls": [
            "<string>"
          ],
          "text": "(?i)\$degen"
        },
        "cast.deleted": {
          "author_fids": [
            123
          ],
          "embedded_cast_author_fids": [
            123
          ],
          "embedded_cast_hashes": [
            "<string>"
          ],
          "embeds": "\b(farcaster|neynar)\b",
          "exclude_author_fids": [
            123
          ],
          "mentioned_fids": [
            123
          ],
          "minimum_author_score": 0,
          "parent_author_fids": [
            123
          ],
          "parent_hashes": [
            "<string>"
          ],
          "parent_urls": [
            "<string>"
          ],
          "root_parent_urls": [
            "<string>"
          ],
          "text": "(?i)\$degen"
        },
        "follow.created": {
          "fids": [
            123
          ],
          "target_fids": [
            123
          ]
        },
        "follow.deleted": {
          "fids": [
            123
          ],
          "target_fids": [
            123
          ]
        },
        "reaction.created": {
          "fids": [
            123
          ],
          "target_cast_hashes": [
            "0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
          ],
          "target_fids": [
            123
          ]
        },
        "reaction.deleted": {
          "fids": [
            123
          ],
          "target_cast_hashes": [
            "0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
          ],
          "target_fids": [
            123
          ]
        },
        "trade.created": {
          "fids": [
            123
          ],
          "minimum_token_amount_usdc": 1,
          "minimum_trader_neynar_score": 0.5
        },
        "user.created": {},
        "user.updated": {
          "fids": [
            123
          ]
        }
      },
      "object": "webhook_subscription",
      "subscription_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Error Response

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}