Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Links

By its FID and target FID

Lookup a link by its FID and target FID.

get/v1/linkById

Query parameters

fidinteger required

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.

Example:1

The FID of the link's originator

target_fidinteger required

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.

Example:1

The FID of the target user for this link

link_type'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
Example:follow

Response

The requested Link.

hashstring required
hashScheme'HASH_SCHEME_BLAKE3' required

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

signaturestring byte required
signatureScheme'SIGNATURE_SCHEME_ED25519' | 'SIGNATURE_SCHEME_EIP712' 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
signerstring required

Example response

{
  "hash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
  "data": {
    "fid": 2,
    "timestamp": 48994466,
    "linkBody": {
      "type": "follow",
      "displayTimestamp": 48994466,
      "targetFid": 1
    }
  }
}