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 App Host API

Operations related to mini app host notifications

This API exposes 3 operations across 2 paths, and defines 10 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 10 schemas 2 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 App Host 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

App Host 3

Operations related to mini app host notifications

GET
/v2/farcaster/app_host/user/event/
Generate event
app-host-get-event 3 params → 200400404500
POST
/v2/farcaster/app_host/user/event/
Send event
app-host-post-event body → 200400404500502
GET
/v2/farcaster/app_host/user/state/
Enabled notifications
app-host-get-user-state 1 param → 200400404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SignerUuidBody (4 properties), ErrorRes (4 properties), EncodedJsonFarcasterSignature (3 properties), AppHostPostEventResponse (2 properties). Each schema is shown below with its type and property counts.

Fid
integer
The unique identifier of a farcaster user or app (unsigned integer)
AppHostPostEventReqBody
Request body for app host events. Can either provide a signedmessage or a signeruuid with event details.
AppHostUserStateResponse
object
1 property 1 required
SignedMessageBody
object
2 properties 2 required
ErrorRes
object
Details for the error response
4 properties 1 required
AppHostGetEventResponse
object
2 properties 1 required
EncodedJsonFarcasterSignature
object
Encoded JSON Farcaster signature
3 properties 3 required
SignerUUID
string
UUID of the signer. signeruuid is paired with API key, can't use a uuid made with a different API key.
AppHostPostEventResponse
object
2 properties 1 required
SignerUuidBody
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-app-host-api-openapi.yml Raw ↑