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

Operations related to cast

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

8 operations 6 paths 62 schemas 1 DELETE6 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 Cast 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 8

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

Cast 8

Operations related to cast

DELETE
/v2/farcaster/cast/
Delete a cast
delete-cast body → 200400403404500
GET
/v2/farcaster/cast/
By hash or URL
lookup-cast-by-hash-or-url 4 params → 200400
POST
/v2/farcaster/cast/
Post a cast
publish-cast body → 200400403404500
GET
/v2/farcaster/cast/conversation/
Conversation for a cast
lookup-cast-conversation 10 params → 200400
GET
/v2/farcaster/cast/embed/crawl/
Embedded URL metadata
fetch-embedded-url-metadata 1 param → 200400
GET
/v2/farcaster/cast/quotes/
Cast Quotes
fetch-cast-quotes 6 params → 200400404
GET
/v2/farcaster/cast/search/
Search for casts
search-casts 10 params → 200400
GET
/v2/farcaster/casts/
Bulk fetch casts
fetch-bulk-casts 4 params → 200400

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are HtmlMetadata (50 properties), CastAndConversations (23 properties), CastAndConversationsRef (23 properties), Cast (22 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
CastEmbedded
object
11 properties 10 required
Conversation
object
2 properties 1 required
PostCastReqBody
object
7 properties 1 required
CastsSearchResponse
object
1 property 1 required
OperationResponse
object
2 properties
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
FrameV1
object
Mini app v1 object
9 properties 3 required
FrameButtonActionType
string
The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcast…
User
object
18 properties 12 required
Embed
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
EmbedUrl
object
2 properties 1 required
CastDehydrated
object
4 properties 2 required
FarcasterManifest
object
3 properties 1 required
EthAddress
string
Ethereum address
OembedRichData
object
Rich OEmbed data
14 properties 3 required
Location
object
Coordinates and place names for a location
4 properties 2 required
ImageObject
object
5 properties 1 required
ChannelOrChannelDehydrated
object
UserDehydrated
object
7 properties 2 required
CastEmbedCrawlResponse
object
1 property 1 required
FrameV2
object
Mini app v2 object
7 properties 3 required
ChannelDehydrated
object
5 properties 3 required
OembedLinkData
object
Link OEmbed data
11 properties 2 required
EmbedCastDeep
object
2 properties 1 required
CastAndConversationsRef
object
Reference to CastAndConversations to avoid circular reference
23 properties 19 required
CastReplies
object
1 property 1 required
CastResponse
object
1 property 1 required
CastParent
string
parenturl of the channel the cast is in, or hash of the cast
LocationAddress
object
5 properties 2 required
VideoObject
object
4 properties 1 required
HtmlMetadata
object
50 properties
EmbedCast
object
2 properties 1 required
Frame
EmbedUrlMetadata
object
7 properties 1 required
ReactionRecast
object
2 properties 2 required
Idem
string
An Idempotency key is a unique identifier for the request. Note: 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) Thi…
ErrorRes
object
Details for the error response
4 properties 1 required
OembedPhotoData
object
Photo OEmbed data
14 properties 3 required
TextRange
object
2 properties 2 required
PostCastResponse
object
2 properties 2 required
CastAndConversations
object
23 properties 19 required
NextCursor
object
Returns next cursor
1 property 1 required
EmbedDeep
CastViewerContext
object
Adds context on interactions the viewer has made with the cast.
2 properties 2 required
CastReactions
object
4 properties 4 required
Cast
object
22 properties 18 required
CastsResponse
object
1 property 1 required
FrameActionButton
object
5 properties 2 required
PostCastReqBodyEmbeds
ReactionLike
object
2 properties 2 required
DeleteCastReqBody
object
2 properties 2 required
PostCastReqBodyEmbedsCastIdProperties
object
2 properties 2 required
EncodedJsonFarcasterSignature
object
Encoded JSON Farcaster signature
3 properties 3 required
CastNotificationType
string
The notification type of a cast.
Channel
object
19 properties 4 required
CastId
object
[DEPRECATED: Use "cast" key instead]
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-cast-api-openapi.yml Raw ↑