Neynar Documentation

Fetch members

cURL

curl --request GET \
  --url 'https://api.neynar.com/v2/farcaster/channel/member/list/?limit=20' \
  --header 'x-api-key: NEYNAR_API_DOCS'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/channel/member/list/?limit=20"

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

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

JavaScript

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

fetch('https://api.neynar.com/v2/farcaster/channel/member/list/?limit=20', 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/channel/member/list/?limit=20",
  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/channel/member/list/?limit=20"

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 (Java)

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

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/channel/member/list/?limit=20")

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

Members Response

{
  "members": [
    {
      "channel": {
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "object": "channel",
        "url": "<string>",
        "description": "<string>",
        "description_mentioned_profiles": [
          {
            "fid": 3,
            "object": "user_dehydrated",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "display_name": "<string>",
            "pfp_url": "<string>",
            "score": 123,
            "username": "<string>"
          }
        ],
        "follower_count": 123,
        "member_count": 123,
        "name": "<string>",
        "viewer_context": {
          "following": true
        }
      },
      "object": "member",
      "user": {
        "fid": 3,
        "object": "user_dehydrated",
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "display_name": "<string>",
        "pfp_url": "<string>",
        "score": 123,
        "username": "<string>"
      }
    }
  ],
  "next": {
    "cursor": "<string>"
  }
}

Error Response

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