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 Channel API

Operations related to channels

This API exposes 17 operations across 15 paths, and defines 37 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.

17 operations 15 paths 37 schemas 2 DELETE12 GET2 POST1 PUT

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 Channel 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 17

Across 15 paths, the API surfaces 17 operations — 2 DELETE, 12 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Channel 17

Operations related to channels

GET
/v2/farcaster/channel/
By ID or parenturl
lookup-channel 3 params → 200404
GET
/v2/farcaster/channel/bulk/
Bulk fetch
fetch-bulk-channels 3 params → 200404
DELETE
/v2/farcaster/channel/follow/
Unfollow a channel
unfollow-channel body → 200400401403404500502
POST
/v2/farcaster/channel/follow/
Follow a channel
follow-channel body → 200400401403404500502
GET
/v2/farcaster/channel/followers/
For channel
fetch-followers-for-a-channel 5 params → 200400
GET
/v2/farcaster/channel/followers/relevant/
Relevant followers
fetch-relevant-followers-for-a-channel 3 params → 200400
GET
/v2/farcaster/channel/list/
Fetch all channels with their details
fetch-all-channels 2 params → 200
DELETE
/v2/farcaster/channel/member/
Remove user
remove-channel-member body → 200400500
POST
/v2/farcaster/channel/member/invite/
Invite
invite-channel-member body → 200400500
PUT
/v2/farcaster/channel/member/invite/
Accept or reject an invite
respond-channel-invite body → 200400500
GET
/v2/farcaster/channel/member/invite/list/
Open invites
fetch-channel-invites 4 params → 200400500
GET
/v2/farcaster/channel/member/list/
Fetch members
fetch-channel-members 5 params → 200400500
GET
/v2/farcaster/channel/search/
Search by ID or name
search-channels 4 params → 200
GET
/v2/farcaster/channel/trending/
Channels by activity
fetch-trending-channels 3 params → 200400500
GET
/v2/farcaster/channel/user/
Fetch channels that user is active in
fetch-users-active-channels 3 params → 200400404
GET
/v2/farcaster/user/channels/
Following
fetch-user-channels 3 params → 200
GET
/v2/farcaster/user/memberships/list/
Member of
fetch-user-channel-memberships 3 params → 200400500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Channel (19 properties), User (18 properties), UserDehydrated (7 properties), ChannelActivity (5 properties). Each schema is shown below with its type and property counts.

ChannelUserContext
object
Adds context on the viewer's or author's role in the channel.
2 properties 1 required
Follower
object
3 properties 2 required
ChannelMember
object
4 properties 4 required
RemoveChannelMemberReqBody
object
4 properties 4 required
OperationResponse
object
2 properties
ChannelListResponse
object
2 properties 1 required
InviteChannelMemberReqBody
object
4 properties 4 required
SignerUUID
string
UUID of the signer. signeruuid is paired with API key, can't use a uuid made with a different API key.
SolAddress
string
Solana address
User
object
18 properties 12 required
ChannelMemberInvite
object
4 properties 4 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
UsersResponse
object
2 properties 2 required
UserDehydrated
object
7 properties 2 required
ChannelDehydrated
object
5 properties 3 required
ChannelResponse
object
1 property 1 required
TrendingChannelResponse
object
2 properties 2 required
ChannelMemberInviteListResponse
object
2 properties 1 required
ChannelActivity
object
5 properties 5 required
ChannelSearchResponse
object
2 properties 2 required
LocationAddress
object
5 properties 2 required
FollowerDehydrated
object
2 properties 2 required
RelevantFollowersResponse
object
2 properties 2 required
ErrorRes
object
Details for the error response
4 properties 1 required
TextRange
object
2 properties 2 required
NextCursor
object
Returns next cursor
1 property 1 required
ChannelFollowReqBody
object
2 properties 2 required
ChannelId
string
The unique identifier of a farcaster channel
RespondChannelInviteReqBody
object
4 properties 4 required
ChannelResponseBulk
object
1 property 1 required
UsersActiveChannelsResponse
object
2 properties
Channel
object
19 properties 4 required
ChannelMemberListResponse
object
2 properties 2 required
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-channel-api-openapi.yml Raw ↑