Skip to main content
GET
/
v1
/
linksByTargetFid
To target FID
curl --request GET \
  --url https://snapchain-api.neynar.com/v1/linksByTargetFid \
  --header 'x-api-key: <api-key>'
{
  "messages": [
    {
      "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
        }
      }
    }
  ],
  "nextPageToken": "AuzO1V0DtaItCwwa10X6YsfStlynsGWT"
}

Authorizations

ā€‹
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

ā€‹
target_fid
integer<uint64>
required

The FID of the target user for this link Farcaster ID (FID). A unique identifier assigned to each user in the Farcaster network. This number is permanent and cannot be changed. FIDs are assigned sequentially when users register on the network.

Required range: x >= 1
Example:

1

ā€‹
link_type
enum<string>
default:follow

Defines the type of social connection between users.

  • follow: Establishes a following relationship where the user will receive updates from the target user in their feed
Available options:
follow
Example:

"follow"

ā€‹
pageSize
integer

Maximum number of messages to return in a single response

ā€‹
reverse
boolean

Reverse the sort order, returning latest messages first

ā€‹
pageToken
string

The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

Response

The requested Links.

ā€‹
messages
object[]
required
ā€‹
nextPageToken
string<byte>
required

Base64-encoded pagination token for fetching the next page of results. An empty value indicates there are no more pages to return. Used in conjunction with the pageSize parameter to implement pagination across large result sets.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Example:

"AuzO1V0DtaItCwwa10X6YsfStlynsGWT"