Links
Get all links from a source FID
Get Started
- Quickstart
- Frameworks
- LLM Docs
Account Management
IPFS
- Pinning Files
- Groups
- Listing Files
- Metadata & Options
- Deleting Files
- Signatures
- Dedicated Gateways
- IPFS 101
- Tools
Private IPFS
Farcaster
- Farcaster
- Getting Started
- Dev Tools
- Farcaster API
- Farcaster Auth
- Frame Analytics API
- Hub API Reference
- Info
- Casts
- Reactions
- Links
- User Data
- Username Proofs
- Verifications
- FIDs
- Storage
- Onchain API
Links
Get all links from a source FID
GET
/
v1
/
linksByFid
curl --request GET \
--url https://hub.pinata.cloud/v1/linksByFid
{
"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",
"displayTimestamp": 123,
"targetFid": 123
}
}
}
],
"nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}
Query Parameters
The FID of the link's originator
The type of link, as a string value
Available options:
follow
Maximum number of messages to return in a single response
Reverse the sort order, returning latest messages first
The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
Response
200
application/json
The requested Links.
Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData
Available options:
HASH_SCHEME_BLAKE3
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
Type of the MessageBody.
- MESSAGE_TYPE_CAST_ADD: Add a new Cast
- MESSAGE_TYPE_CAST_REMOVE: Remove an existing Cast
- MESSAGE_TYPE_REACTION_ADD: Add a Reaction to a Cast
- MESSAGE_TYPE_REACTION_REMOVE: Remove a Reaction from a Cast
- MESSAGE_TYPE_LINK_ADD: Add a new Link
- MESSAGE_TYPE_LINK_REMOVE: Remove an existing Link
- MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS: Add a Verification of an Ethereum Address
- MESSAGE_TYPE_VERIFICATION_REMOVE: Remove a Verification
- MESSAGE_TYPE_USER_DATA_ADD: Deprecated MESSAGE_TYPE_SIGNER_ADD = 9; // Add a new Ed25519 key pair that signs messages for a user MESSAGE_TYPE_SIGNER_REMOVE = 10; // Remove an Ed25519 key pair that signs messages for a user
Add metadata about a user
- MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof
Available options:
MESSAGE_TYPE_CAST_ADD
, MESSAGE_TYPE_CAST_REMOVE
, MESSAGE_TYPE_REACTION_ADD
, MESSAGE_TYPE_REACTION_REMOVE
, MESSAGE_TYPE_LINK_ADD
, MESSAGE_TYPE_LINK_REMOVE
, MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS
, MESSAGE_TYPE_VERIFICATION_REMOVE
, MESSAGE_TYPE_USER_DATA_ADD
, MESSAGE_TYPE_USERNAME_PROOF
Farcaster network the message is intended for.
- FARCASTER_NETWORK_MAINNET: Public primary network
- FARCASTER_NETWORK_TESTNET: Public test network
- FARCASTER_NETWORK_DEVNET: Private test network
Available options:
FARCASTER_NETWORK_MAINNET
, FARCASTER_NETWORK_TESTNET
, FARCASTER_NETWORK_DEVNET
curl --request GET \
--url https://hub.pinata.cloud/v1/linksByFid
{
"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",
"displayTimestamp": 123,
"targetFid": 123
}
}
}
],
"nextPageToken": "aSDinaTvuI8gbWludGxpZnk="
}