Airstack Links API
The Links API from Airstack — 3 operation(s) for links.
OpenAPI Specification
openapi: 3.0.1
info:
title: Farcaster Hub REST Casts Links API
version: '1.0'
description: "Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Farcaster docs](https://www.thehubble.xyz/docs/httpapi/httpapi.html) for more details. Some client libraries:\n - [TypeScript](https://www.npmjs.com/package/@standard-crypto/farcaster-js-hub-rest)\n"
servers:
- url: https://hubs.airstack.xyz
security:
- ApiKeyAuth: []
tags:
- name: Links
paths:
/v1/linkById:
get:
security:
- ApiKeyAuth: []
tags:
- Links
summary: Get a link by its FID and target FID.
operationId: GetLinkById
parameters:
- name: fid
in: query
description: The FID of the link's originator
required: true
schema:
type: integer
- name: target_fid
in: query
description: The FID of the target of the link
required: true
schema:
type: integer
- name: link_type
in: query
description: The type of link, as a string value
required: true
schema:
$ref: '#/components/schemas/LinkType'
responses:
'200':
description: The requested Link.
content:
application/json:
schema:
$ref: '#/components/schemas/LinkAdd'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/linksByFid:
get:
security:
- ApiKeyAuth: []
tags:
- Links
summary: Get all links from a source FID
operationId: ListLinksByFid
parameters:
- name: fid
in: query
schema:
type: integer
required: true
description: The FID of the link's originator
- name: link_type
in: query
schema:
$ref: '#/components/schemas/LinkType'
required: false
description: The type of link, as a string value
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
'200':
description: The requested Links.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/LinkAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/linksByTargetFid:
get:
security:
- ApiKeyAuth: []
tags:
- Links
summary: Get all links to a target FID
operationId: ListLinksByTargetFid
parameters:
- name: target_fid
in: query
schema:
type: integer
required: true
description: The FID of the target of the link
- name: link_type
in: query
schema:
$ref: '#/components/schemas/LinkType'
required: false
description: The type of link, as a string value
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
'200':
description: The requested Links.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/LinkAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
components:
schemas:
SignatureScheme:
type: string
description: "Type of signature scheme used to sign the Message hash\n- SIGNATURE_SCHEME_ED25519: Ed25519 signature (default)\n - SIGNATURE_SCHEME_EIP712: ECDSA signature using EIP-712 scheme"
default: SIGNATURE_SCHEME_ED25519
enum:
- SIGNATURE_SCHEME_ED25519
- SIGNATURE_SCHEME_EIP712
MessageDataLink:
allOf:
- $ref: '#/components/schemas/MessageDataCommon'
- type: object
required:
- linkBody
properties:
linkBody:
$ref: '#/components/schemas/LinkBody'
FarcasterNetwork:
type: string
description: "Farcaster network the message is intended for.\n- FARCASTER_NETWORK_MAINNET: Public primary network\n - FARCASTER_NETWORK_TESTNET: Public test network\n - FARCASTER_NETWORK_DEVNET: Private test network"
default: FARCASTER_NETWORK_MAINNET
enum:
- FARCASTER_NETWORK_MAINNET
- FARCASTER_NETWORK_TESTNET
- FARCASTER_NETWORK_DEVNET
MessageDataCommon:
required:
- fid
- network
- timestamp
type: object
properties:
fid:
title: Farcaster ID of the user producing the message
type: integer
format: uint64
example: 2
timestamp:
title: Farcaster epoch timestamp in seconds
type: integer
format: int64
example: 48994466
network:
$ref: '#/components/schemas/FarcasterNetwork'
MessageCommon:
type: object
properties:
hash:
title: Hash digest of data
pattern: ^0x[0-9a-fA-F]{40}$
type: string
example: '0xd2b1ddc6c88e865a33cb1a565e0058d757042974'
hashScheme:
$ref: '#/components/schemas/HashScheme'
signature:
title: Signature of the hash digest
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
signatureScheme:
$ref: '#/components/schemas/SignatureScheme'
signer:
title: Public key or address of the key pair that produced the signature
pattern: ^0x[0-9a-fA-F]+$
type: string
required:
- hash
- hashScheme
- signature
- signatureScheme
- signer
LinkBody:
description: Adds or removes a Link
type: object
properties:
type:
$ref: '#/components/schemas/LinkType'
displayTimestamp:
title: User-defined timestamp that preserves original timestamp when message.data.timestamp needs to be updated for compaction
type: integer
format: int64
targetFid:
title: The fid the link relates to
type: integer
format: uint64
required:
- type
- targetFid
MessageType:
type: string
description: "Type of the MessageBody.\n - MESSAGE_TYPE_CAST_ADD: Add a new Cast\n - MESSAGE_TYPE_CAST_REMOVE: Remove an existing Cast\n - MESSAGE_TYPE_REACTION_ADD: Add a Reaction to a Cast\n - MESSAGE_TYPE_REACTION_REMOVE: Remove a Reaction from a Cast\n - MESSAGE_TYPE_LINK_ADD: Add a new Link\n - MESSAGE_TYPE_LINK_REMOVE: Remove an existing Link\n - MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS: Add a Verification of an Ethereum Address\n - MESSAGE_TYPE_VERIFICATION_REMOVE: Remove a Verification\n - MESSAGE_TYPE_USER_DATA_ADD: Add metadata about a user\n - MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof\n - MESSAGE_TYPE_FRAME_ACTION: A Farcaster Frame action"
default: MESSAGE_TYPE_CAST_ADD
enum:
- 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
- MESSAGE_TYPE_FRAME_ACTION
LinkAdd:
allOf:
- $ref: '#/components/schemas/MessageCommon'
- type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/MessageDataLink'
- type: object
properties:
type:
$ref: '#/components/schemas/MessageType'
required:
- type
required:
- data
ErrorResponse:
required:
- code
- details
- errCode
- metadata
- name
- presentable
type: object
properties:
errCode:
type: string
presentable:
type: boolean
name:
type: string
code:
type: integer
details:
type: string
metadata:
required:
- errcode
type: object
properties:
errcode:
type: array
items:
type: string
LinkType:
type: string
description: 'Type of Link.
- follow: Follow another user'
default: follow
enum:
- follow
HashScheme:
type: string
description: 'Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData
'
default: HASH_SCHEME_BLAKE3
enum:
- HASH_SCHEME_BLAKE3
responses:
ErrorResponse:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
parameters:
paginationReverse:
name: reverse
in: query
description: Reverse the sort order, returning latest messages first
schema:
type: boolean
pageSize:
name: pageSize
in: query
description: Maximum number of messages to return in a single response
schema:
type: integer
pageToken:
name: pageToken
in: query
description: The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
schema:
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-airstack-hubs