Neynar Documentation
Metrics for casts
cURL
curl --request GET \
--url https://api.neynar.com/v2/farcaster/cast/metrics/ \
--header 'x-api-key: NEYNAR_API_DOCS'
Python
import requests
url = "https://api.neynar.com/v2/farcaster/cast/metrics/"
headers = {"x-api-key": "NEYNAR_API_DOCS"}
response = requests.get(url, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};
fetch('https://api.neynar.com/v2/farcaster/cast/metrics/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.neynar.com/v2/farcaster/cast/metrics/",
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/cast/metrics/"
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))
}
Java (Unirest)
HttpResponse<String> response = Unirest.get("https://api.neynar.com/v2/farcaster/cast/metrics/")
.header("x-api-key", "NEYNAR_API_DOCS")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/cast/metrics/")
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 Codes
- 200
- 400
JSON Response
{
"metrics": [
{
"cast_count": 123,
"resolution_in_seconds": 123,
"start": "2023-11-07T05:31:56Z"
}
]
}
Error Response
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
Node.js SDK
SDK Method: fetchCastMetrics
Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.
Authorizations
- x-api-key: string (header, default: NEYNAR_API_DOCS, required)
Headers
- x-neynar-experimental: boolean (header, default: false)
Query Parameters
- q: string (required)
Example:"star wars" - interval: enum
(default: 30d)
Available options:1d,7d,30d,90d,180d - author_fid: integer (required)
- channel_id: string
Response
- 200: application/json
Response Object
- metrics: CastsMetrics · object[] (required)