For AI agents: visit https://neynar.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

API Reference

Overview

Quickstart
Rate limits
Compute units pricing

Farcaster API V2

User
Signer
Cast
Feed
Reaction
Notifications
Channel
Follows
Storage
Frame
Agents
fname
- Check fname availabilityget
Webhook
Action
- User actions across appspost
Mute
Block
Ban
Onchain
Login
- Fetch nonceget
Metrics
- Metrics for castsget

Onchain

Deploy fungiblepost

Farcaster Hub API

Info
- Sync Methodsget
Casts
Reactions
Links
UserData
- Fetch UserData for a FIDget
Fids
- Fetch a list of all the FIDsget
Storage
- FID's limitsget
Usernames
- Proofs provided by an FIDget
- Proof for a usernameget
Verifications
- Provided by an FIDget
OnChainEvents
Message
- Submit signed messagepost
- Validate signed messagepost
HubEvents
- Page of eventsget
- Event by IDget

⚙️ NEYNAR SDK

Getting started with Neynar NodeJS SDK
SDK v1 to v2 migration guide
- Using github copilot

GITHUB

nodejs-SDK
Frontend react SDK
OpenAPI specification
Example Apps

Powered by

Developer hosted frames

Build your own frames and use Neynar to

Validate frame action against Farcaster Hub
Post a frame action on your Farcaster enabled client
Retrieve analytics for frames validated with Neynar
Access HTML OG metadata for frames

Updated over 1 year ago

Did this page help you?

Updated over 1 year ago

Did this page help you?