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

Operations related to a ban

This API exposes 3 operations across 2 paths, and defines 18 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 2 paths 18 schemas 1 DELETE1 GET1 POST

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 Ban 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 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Ban 3

Operations related to a ban

DELETE
/v2/farcaster/ban/
Unban FIDs from app
delete-bans body → 200400404500
POST
/v2/farcaster/ban/
Ban FIDs from app
publish-bans body → 200400404500
GET
/v2/farcaster/ban/list/
Banned FIDs of app
fetch-ban-list 3 params → 200400404500

Schemas 18

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

BanListResponse
object
2 properties 2 required
ChannelUserContext
object
Adds context on the viewer's or author's role in the channel.
2 properties 1 required
BanRecord
object
3 properties 2 required
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
BanReqBody
object
1 property 1 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
BanResponse
object
2 properties 1 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-ban-api-openapi.yml Raw ↑