For AI agents: visit https://neynar.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Neynar Developer
API Reference
Log InNeynar Developer
API Reference
Log In
API Reference

Overview

  • Quickstart
  • Rate limits
  • Compute units pricing

Farcaster API V2

  • User
    • Fetch user information
      • Search for Usernamesget
      • By FIDsget
      • Power usersget
      • Power user FIDsget
      • By Eth or Sol addressesget
      • By custody-addressget
      • By usernameget
      • By locationget
    • Fetch user's casts
      • 10 most popular castsget
      • Replies and recastsget
      • Chronologicallyget
    • Register new user
      • Fetch fresh FIDget
      • Register new accountpost
    • Update user profile
      • Update user profilepatch
      • Add verificationpost
      • Delete verificationdel
    • Fetch authorization urlget
    • By X usernameget
  • Signer
    • Neynar managed
      • Statusget
      • Create signerpost
      • Register Signed Keypost
    • Developer managed
      • Status by public keyget
      • Register Signed Keypost
      • Publish messagepost
    • List signersget
  • Cast
    • Embedded URL metadataget
    • By hash or URLget
    • Post a castpost
    • Delete a castdel
    • Bulk fetch castsget
    • Search for castsget
    • Conversation for a castget
    • Fetch composer actionsget
  • Feed
    • User
      • Followingget
      • For youget
    • Channels
      • By channel IDsget
      • By parent URLsget
    • By filtersget
    • Casts with mini appsget
    • Trending feedsget
  • Reaction
    • Post a reactionpost
    • Delete reactiondel
    • Reactions for userget
    • Reactions for castget
  • Notifications
    • For userget
    • For user by channelget
    • For user by parent_urlsget
    • Mark as seenpost
  • Channel
    • Fetch channel info
      • Search by ID or nameget
      • Bulk fetchget
      • By ID or parent_urlget
    • Members
      • Remove userdel
      • Fetch membersget
      • Invitepost
      • Accept or reject an inviteput
      • Open invitesget
    • Fetch Followers
      • For channelget
      • Relevant followersget
    • User's channels
      • Followingget
      • Member ofget
      • Follow a channelpost
      • Unfollow a channeldel
    • Trending
      • Channels by activityget
    • Fetch all channels with their detailsget
    • Fetch channels that user is active inget
  • Follows
    • Followersget
    • Relevant followersget
    • Followingget
    • Suggest Followsget
    • Update follow / unfollow
      • Follow userpost
      • Unfollow userdel
  • Storage
    • Allocation of userget
    • Usage of userget
    • Buy storagepost
  • Frame
    • Notifications
      • List of mini app notification tokensget
      • Send notificationspost
    • Developer hosted frames
      • Post a mini app action, cast action or a cast composer actionpost
      • Validate mini app actionpost
      • All mini apps validated by userget
      • Analytics for the mini appget
    • Neynar hosted frames
      • Mini app by UUID or URLget
      • Create mini apppost
      • Update mini appput
      • Delete mini appdel
      • List of mini appsget
    • Mini apps catalogget
    • Relevant mini appsget
    • Meta tags from URLget
    • Signature packetpost
  • Agents
    • Cast conversation summaryget
    • User interactionsget
    • Dynamic transaction frames
      • Create transaction pay mini apppost
      • Get transaction pay mini appget
  • fname
    • Check fname availabilityget
  • Webhook
    • Fetch a webhookget
    • Create a webhookpost
    • Update webhook statuspatch
    • Update a webhookput
    • Delete a webhookdel
    • Associated webhooks of userget
  • Action
    • User actions across appspost
  • Mute
    • Muted FIDs of userget
    • Mute FIDpost
    • Unmute FIDdel
  • Block
    • Blocked / Blocked by FIDsget
    • Block FIDpost
    • Unblock FIDdel
  • Ban
    • Banned FIDs of appget
    • Ban FIDs from apppost
    • Unban FIDs from appdel
  • Onchain
    • Token balanceget
    • Relevant ownersget
    • Subscribers
      • Subscriptions created by FIDget
      • Subscribed toget
      • Subscribers of a userget
      • Hypersub subscription checkget
  • Login
    • Fetch nonceget
  • Metrics
    • Metrics for castsget

Onchain

  • Deploy fungiblepost

Farcaster Hub API

  • Info
    • Sync Methodsget
  • Casts
    • By FID and Hashget
    • By FIDget
    • Mentioning an FIDget
    • By parent castget
  • Reactions
    • By FID or castget
    • On castget
    • By FIDget
    • To a target URLget
  • Links
    • By its FID and target FIDget
    • From source FIDget
    • To target FIDget
  • 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
    • Fetch an on-chain ID Registry Event for a given Addressget
    • Fetch a list of on-chain events provided by an FIDget
    • Fetch a list of signers provided by an FIDget
  • 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 about 1 year ago


Updated about 1 year ago