Neynar Links API

Operations related to links.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 3 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.0.4, at version 3.176.0.

Requests are made against a single base URL, https://api.neynar.com.

3 operations 3 paths 13 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.4

API Version

3.176.0

Base URL

https://api.neynar.com

Authentication

API Key

Contact

Neynar

Resource Areas

Authentication & Security 1

Neynar Links API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

ApiKeyAuth — API key to authorize requests

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Links 3

Operations related to links.

GET

/v1/linkById

By its FID and target FID

lookup-user-relation 3 params → 200default

GET

/v1/linksByFid

From source FID

fetch-user-following 5 params → 200default

GET

/v1/linksByTargetFid

To target FID

fetch-user-followers 5 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (6 properties), MessageCommon (5 properties), MessageDataCommon (4 properties), LinkBody (3 properties). Each schema is shown below with its type and property counts.

SignatureScheme

string

Type of signature scheme used to sign the Message hash - SIGNATURESCHEMEED25519: Ed25519 signature (default) - SIGNATURESCHEMEEIP712: ECDSA signature using EIP…

MessageDataLink

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

FarcasterNetwork

string

Farcaster network the message is intended for. - FARCASTERNETWORKMAINNET: Public primary network - FARCASTERNETWORKTESTNET: Public test network - FARCASTERNETW…

MessageDataCommon

object

Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context.

4 properties 3 required

MessageCommon

object

5 properties 5 required

PaginationResponse

object

1 property 1 required

LinkBody

object

Defines a social connection between users in the Farcaster network. Currently used to establish following relationships, allowing users to curate their content…

3 properties 2 required

MessageType

string

Type of the MessageBody. - MESSAGETYPECASTADD: Add a new Cast - MESSAGETYPECASTREMOVE: Remove an existing Cast - MESSAGETYPEREACTIONADD: Add a Reaction to a Ca…

LinkAdd

ErrorResponse

object

6 properties 6 required

LinkType

string

Defines the type of social connection between users. - follow: Establishes a following relationship where the user will receive updates from the target user in…

HashScheme

string

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

FidSchema

integer

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 seque…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Links

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Neynar Links API

Metadata

Authentication & Security 1

Paths & Operations 3

Schemas 13

Specification

Source

API Details

Provider

Explore more