Neynar Documentation

By its FID and target FID

cURL

curl --request GET \
  --url 'https://snapchain-api.neynar.com/v1/linkById?link_type=follow' \
  --header 'x-api-key: NEYNAR_API_DOCS'

import requests

url = "https://snapchain-api.neynar.com/v1/linkById?link_type=follow"

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://snapchain-api.neynar.com/v1/linkById?link_type=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://snapchain-api.neynar.com/v1/linkById?link_type=follow",\
  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://snapchain-api.neynar.com/v1/linkById?link_type=follow"

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://snapchain-api.neynar.com/v1/linkById?link_type=follow")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://snapchain-api.neynar.com/v1/linkById?link_type=follow")

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

From the server:

{
  "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
  "hashScheme": "HASH_SCHEME_BLAKE3",
  "signature": "aSDinaTvuI8gbWludGxpZnk=",
  "signatureScheme": "SIGNATURE_SCHEME_ED25519",
  "signer": "<string>",
  "data": {
    "type": "MESSAGE_TYPE_CAST_ADD",
    "fid": 2,
    "timestamp": 48994466,
    "network": "FARCASTER_NETWORK_MAINNET",
    "linkBody": {
      "type": "follow",
      "targetFid": 1,
      "displayTimestamp": 48994466
    }
  }
}

{
  "errCode": "<string>",
  "presentable": true,
  "name": "<string>",
  "code": 123,
  "details": "<string>",
  "metadata": {
    "errcode": [
      "<string>"
    ]
  }
}

Authorizations

• x-api-key
  • Type: string
  • Location: header
  • Default: NEYNAR_API_DOCS
  • Required: true

Query Parameters

• fid: Required, integer. The FID of the link's originator (e.g. 1). Must be x >= 1.
• target_fid: Required, integer. The FID of the target user for this link (e.g. 1). Must be x >= 1.
• link_type: Required, enum, default: follow. Defines the type of social connection.

Response

• Status code: 200
• Content-Type: application/json
• The requested Link:

Response Fields

• hash: string required.
• hashScheme: enum required, default: HASH_SCHEME_BLAKE3.
• signature: string required.
• signatureScheme: enum required, default: SIGNATURE_SCHEME_ED25519.

Data

• data: object required.