Neynar Documentation

By Eth or Sol addresses

cURL

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

import requests

url = "https://api.neynar.com/v2/farcaster/user/bulk-by-address/"

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://api.neynar.com/v2/farcaster/user/bulk-by-address/', 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/user/bulk-by-address/",
  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://api.neynar.com/v2/farcaster/user/bulk-by-address/"

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://api.neynar.com/v2/farcaster/user/bulk-by-address/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/user/bulk-by-address/")

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

Status Codes

• 200
• 400
• 404

Example Response

{}

Expected JSON Response Structure

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

Additional Information

SDK Method

SDK Method: fetchBulkUsersByEthOrSolAddress
Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

• x-api-key: API key to authorize requests (default: NEYNAR_API_DOCS, required)

Headers

• x-neynar-experimental: enables experimental features including filtering based on the Neynar score. (default: false)

Query Parameters

• addresses: Comma separated list of Ethereum or Solana addresses, up to 350 at a time. Example: "0xa6a8736f18f383f1cc2d938576933e5ea7df01a1,0x7cac817861e5c3384753403fb6c0c556c204b1ce"
• address_types: Customize which address types the request should search for. Available options: custody_address, verified_address.
• viewer_fid: Required range: x >= 1

Response Format

Success (200 - application/json)