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

Operations related to mini apps

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

7 operations 6 paths 43 schemas 6 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 Frame 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 7

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

Frame 7

Operations related to mini apps

GET
/v2/farcaster/frame/catalog/
Mini apps catalog
fetch-frame-catalog 5 params → 200
GET
/v2/farcaster/frame/notification_tokens/
List of mini app notification tokens
fetch-notification-tokens 3 params → 200400
GET
/v2/farcaster/frame/notifications/
Get notification campaign stats
get-notification-campaign-stats 3 params → 200400500
POST
/v2/farcaster/frame/notifications/
Send notifications
publish-frame-notifications body → 200202400404422500
GET
/v2/farcaster/frame/relevant/
Relevant mini apps
fetch-relevant-frames 3 params → 200
GET
/v2/farcaster/frame/search/
Search mini apps
search-frames 4 params → 200400
GET
/v2/farcaster/frame/transaction/pay/
Get transaction pay mini app
get-transaction-pay-frame 1 param → 200400404500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are HtmlMetadata (50 properties), User (18 properties), OembedPhotoData (14 properties), OembedVideoData (14 properties). Each schema is shown below with its type and property counts.

SendFrameNotificationsResponse
object
5 properties 4 required
ChannelUserContext
object
Adds context on the viewer's or author's role in the channel.
2 properties 1 required
TransactionFramePay
object
6 properties 6 required
TransactionFrameAction
object
Action button for primary CTA on the transaction mini app
3 properties
FrameCatalogResponse
object
2 properties 2 required
NotificationCampaignStats
object
9 properties 9 required
SolAddress
string
Solana address
User
object
18 properties 12 required
TransactionFrameResponse
object
1 property 1 required
ChannelMemberRole
string
The role of a channel member
OembedVideoData
object
Video OEmbed data
14 properties 3 required
UserViewerContext
object
Adds context on the viewer's follow relationship with the user.
4 properties 4 required
TransactionFrame
object
EthAddress
string
Ethereum address
Location
object
Coordinates and place names for a location
4 properties 2 required
FarcasterManifest
object
3 properties 1 required
OembedRichData
object
Rich OEmbed data
14 properties 3 required
QueuedFrameNotificationsResponse
object
2 properties 2 required
ImageObject
object
5 properties 1 required
UserDehydrated
object
7 properties 2 required
ChannelDehydrated
object
5 properties 3 required
SendFrameNotificationsReqBody
object
3 properties 1 required
OembedLinkData
object
Link OEmbed data
11 properties 2 required
FrameNotificationTokens
object
2 properties 2 required
Network
string
A blockchain network e.g. "ethereum", "optimism", "base", "arbitrum"
LocationAddress
object
5 properties 2 required
VideoObject
object
4 properties 1 required
TransactionFrameDestination
object
4 properties 4 required
HtmlMetadata
object
50 properties
ZodError
object
3 properties 3 required
NotificationCampaignStatus
string
Always "queued" for a successful async enqueue.
ErrorRes
object
Details for the error response
4 properties 1 required
TextRange
object
2 properties 2 required
OembedPhotoData
object
Photo OEmbed data
14 properties 3 required
TransactionFrameLineItem
object
3 properties 2 required
NextCursor
object
Returns next cursor
1 property 1 required
TransactionFrameType
string
Type of transaction mini app
NotificationCampaign
object
8 properties 5 required
TransactionFrameStatus
string
TransactionFrameConfig
object
3 properties 1 required
FrameV2WithFullAuthor
object
Mini app v2 object with full user object
7 properties 3 required
EncodedJsonFarcasterSignature
object
Encoded JSON Farcaster signature
3 properties 3 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-frame-api-openapi.yml Raw ↑