Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neynar Subscribers API

Operations related to a subscriptions

This API exposes 4 operations across 4 paths, and defines 23 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.

4 operations 4 paths 23 schemas 4 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
Resource Areas
1

Authentication & Security 1

Neynar Subscribers 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 4

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

Subscribers 4

Operations related to a subscriptions

GET
/v2/farcaster/user/subscribed_to/
Subscribed to
fetch-subscribed-to-for-fid 3 params → 200400
GET
/v2/farcaster/user/subscribers/
Subscribers of a user
fetch-subscribers-for-fid 3 params → 200400
GET
/v2/farcaster/user/subscriptions_created/
Subscriptions created by FID
fetch-subscriptions-for-fid 2 params → 200400
GET
/v2/stp/subscription_check/
Hypersub subscription check
fetch-subscription-check 3 params → 200400

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are User (18 properties), SubscribedTo (14 properties), Subscription (10 properties), SubscribedToObject (8 properties). Each schema is shown below with its type and property counts.

SubscribersResponse
object
1 property
Subscriptions
object
1 property 1 required
ChannelUserContext
object
Adds context on the viewer's or author's role in the channel.
2 properties 1 required
Subscriber
object
3 properties 3 required
SubscriptionCheckResponse
object
SolAddress
string
Solana address
User
object
18 properties 12 required
ChannelMemberRole
string
The role of a channel member
UserViewerContext
object
Adds context on the viewer's follow relationship with the user.
4 properties 4 required
EthAddress
string
Ethereum address
Location
object
Coordinates and place names for a location
4 properties 2 required
UserDehydrated
object
7 properties 2 required
ChannelDehydrated
object
5 properties 3 required
LocationAddress
object
5 properties 2 required
SubscribedToResponse
object
1 property
Subscription
object
10 properties 8 required
ErrorRes
object
Details for the error response
4 properties 1 required
TextRange
object
2 properties 2 required
SubscribedTo
object
14 properties 12 required
SubscriptionTier
object
2 properties
SubscribedToObject
object
8 properties 2 required
SubscriptionsResponse
object
1 property
Fid
integer
The unique identifier of a farcaster user or app (unsigned integer)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-subscribers-api-openapi.yml Raw ↑