Neynar Notifications API

Operations related to notifications

Documentation Provider Profile APIs.io OpenAPI GitHub

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

4 operations 4 paths 53 schemas 3 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

Neynar

Resource Areas

Authentication & Security 1

Neynar Notifications 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 4

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

Notifications 4

Operations related to notifications

GET

/v2/farcaster/notifications/

For user

fetch-all-notifications 5 params → 200400

GET

/v2/farcaster/notifications/channel/

For user by channel

fetch-channel-notifications-for-user 5 params → 200400

GET

/v2/farcaster/notifications/parent_url/

For user by parenturls

fetch-notifications-by-parent-url-for-user 5 params → 200400

POST

/v2/farcaster/notifications/seen/

Mark as seen

mark-notifications-as-seen 1 param body → 200400500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are HtmlMetadata (50 properties), Cast (22 properties), Channel (19 properties), User (18 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

CastEmbedded

object

11 properties 10 required

OperationResponse

object

2 properties

SolAddress

string

Solana address

FrameV1

object

Mini app v1 object

9 properties 3 required

Notification

object

8 properties 4 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

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

CastReplies

object

1 property 1 required

MarkNotificationsAsSeenReqBody

object

2 properties

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

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

NextCursor

object

Returns next cursor

1 property 1 required

EmbedDeep

NotificationType

string

The type of notification to mark as seen. If not provided, all notifications will be marked as seen.

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

FrameActionButton

object

5 properties 2 required

ReactionLike

object

2 properties 2 required

NotificationsResponse

object

3 properties 3 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

ReactionWithUserInfo

object

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

#Notifications

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Neynar Notifications API

Metadata

Authentication & Security 1

Paths & Operations 4

Schemas 53

Specification

Source

API Details

Provider

Explore more