Skip to main content
GET
/
v1
/
linkById
By its FID and target FID
curl --request GET \
  --url https://hub-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",
      "displayTimestamp": 48994466,
      "targetFid": 1
    }
  }
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
fid
integer
required

The FID of the link's originator

Required range: x >= 1
Example:

1

​
target_fid
integer
required

The FID of the target user for this link

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. Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context.

⌘I