How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neynar Frame API

Operations related to mini apps

Neynar Frame API is one of 39 APIs that Neynar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Frame. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and rate-limit docs.

This API exposes 7 operations across 6 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, 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.2.0
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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-frame-api-openapi.yml Raw ↑

Other APIs Neynar publishes across the network.

Neynar Action API
Neynar Agents API
Neynar App Host API
Neynar AuthAddress API
Neynar Ban API
Neynar Block API
Neynar Cast API
Neynar Casts API
Neynar Channel API
Neynar Feed API
Neynar Fids API
Neynar fname API
Where this information came from

This is an independent, third-party profile of Neynar Frame API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.