Neynar Documentation
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Follow user
cURL
curl --request POST \
--url https://api.neynar.com/v2/farcaster/user/follow/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: NEYNAR_API_DOCS' \
--data '
{
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"target_fids": [\
194,\
3\
]
}'
Python
import requests
url = "https://api.neynar.com/v2/farcaster/user/follow/"
payload = {
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"target_fids": [194, 3]
}
headers = {
"x-api-key": "NEYNAR_API_DOCS",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {
method: 'POST',
headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
body: JSON.stringify({signer_uuid: '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec', target_fids: [194, 3]})
};
fetch('https://api.neynar.com/v2/farcaster/user/follow/', 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/follow/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'signer_uuid' => '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec',
'target_fids' => [
194,
3
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.neynar.com/v2/farcaster/user/follow/"
payload := strings.NewReader("{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"target_fids\": [\n 194,\n 3\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Unirest (Java)
HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/user/follow/")
.header("x-api-key", "NEYNAR_API_DOCS")
.header("Content-Type", "application/json")
.body("{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"target_fids\": [\n 194,\n 3\n ]\n}")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/user/follow/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"target_fids\": [\n 194,\n 3\n ]\n}"
response = http.request(request)
puts response.read_body
Response Codes
- 200
- 400
- 403
- 404
- 500
Response Structure
{
"details": [
{
"hash": "<string>",
"success": true,
"target_fid": 3
}
],
"success": true
}
Error Response Structure
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
Node.js SDK
๐ SDK Method: followUser
Authorizations
- x-api-key: string, header, default: NEYNAR_API_DOCS, required: API key to authorize requests
Body Structure
- signer_uuid: string, required, UUID of the signer.
- target_fids: integer[], required, Maximum array length:
100, Required range:x >= 1, Example:[194, 3]
Response
Success Response
- status: 200
- Content-Type: application/json
- details: FollowResponse ยท object[], required
- success: boolean, required