Neynar Documentation

Token balance

cURL

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

import requests

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

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/balance/', 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/balance/",\
  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/balance/"

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/balance/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

require 'uri'
require 'net/http'

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

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

Status Codes

Response Structure

{
  "user_balance": {
    "address_balances": [
      {
        "object": "address_balance",
        "token_balances": [
          {
            "balance": {
              "in_token": "<string>",
              "in_usdc": "<string>"
            },
            "object": "token_balance",
            "token": {
              "name": "<string>",
              "object": "token",
              "symbol": "<string>",
              "address": "<string>",
              "decimals": 123
            }
          }
        ],
        "verified_address": {
          "address": "<string>"
        }
      }
    ],
    "object": "user_balance",
    "user": {
      "fid": 3,
      "object": "user_dehydrated",
      "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
      "display_name": "<string>",
      "pfp_url": "<string>",
      "score": 123,
      "username": "<string>"
    }
  }
}

Error Response Structure

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

Authorization

Query Parameters