Skip to main content
GET
/
v1
/
linkById
By its FID and target FID
curl --request GET \
  --url https://snapchain-api.neynar.com/v1/linkById \
  --header 'x-api-key: <api-key>'
{
  "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
    }
  }
}

Authorizations

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

API key to authorize requests

Query Parameters

ā€‹
fid
integer<uint64>
required

The FID of the link's originator 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

ā€‹
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
required

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"

Response

The requested Link.

ā€‹
hash
string
required
Example:

"0xd2b1ddc6c88e865a33cb1a565e0058d757042974"

ā€‹
hashScheme
enum<string>
default:HASH_SCHEME_BLAKE3
required

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData

Available options:
HASH_SCHEME_BLAKE3
ā€‹
signature
string<byte>
required
ā€‹
signatureScheme
enum<string>
default:SIGNATURE_SCHEME_ED25519
required

Type of signature scheme used to sign the Message hash

  • SIGNATURE_SCHEME_ED25519: Ed25519 signature (default)
  • SIGNATURE_SCHEME_EIP712: ECDSA signature using EIP-712 scheme
Available options:
SIGNATURE_SCHEME_ED25519,
SIGNATURE_SCHEME_EIP712
ā€‹
signer
string
required
ā€‹
data
object
required

Represents a social graph connection between users in the Farcaster network. Currently supports following relationships between users.