**Note:** one of two different response schemas is returned based on whether the caller provides the `user_data_type` parameter. If included, a single `UserDataAdd` message is returned (or a `not_found` error). If omitted, a paginated list of `UserDataAdd` messages is returned instead.

Fetch UserData for a FID

Farcaster network the message is intended for.
- FARCASTER_NETWORK_MAINNET: Public primary network
- FARCASTER_NETWORK_TESTNET: Public test network
- FARCASTER_NETWORK_DEVNET: Private test network

Type of hashing scheme used to produce a digest of MessageData. - HASH_SCHEME_BLAKE3: Default scheme for hashing MessageData


Hash digest of data

Signature of the hash digest

Public key or address of the key pair that produced the signature

Common properties shared by all Farcaster message types. These properties provide essential metadata about the message's origin, timing, and network context.

The unique identifier (FID) of the user who created this message. FIDs are assigned sequentially when users register on the network and cannot be changed.

Farcaster ID of the user producing the message

Seconds since Farcaster Epoch (2021-01-01T00:00:00Z). Used to order messages chronologically and determine the most recent state. Must be within 10 minutes of the current time when the message is created.

Contains the type of profile metadata being updated and its new value.

Represents a message that updates a user's profile metadata. This can include changes to profile picture, display name, bio, URL, or preferred username. Each update modifies a single profile field.

Type of the MessageBody.
- MESSAGE_TYPE_CAST_ADD: Add a new Cast
- MESSAGE_TYPE_CAST_REMOVE: Remove an existing Cast
- MESSAGE_TYPE_REACTION_ADD: Add a Reaction to a Cast
- MESSAGE_TYPE_REACTION_REMOVE: Remove a Reaction from a Cast
- MESSAGE_TYPE_LINK_ADD: Add a new Link
- MESSAGE_TYPE_LINK_REMOVE: Remove an existing Link
- MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS: Add a Verification of an Ethereum Address
- MESSAGE_TYPE_VERIFICATION_REMOVE: Remove a Verification
- MESSAGE_TYPE_USER_DATA_ADD: Add metadata about a user
- MESSAGE_TYPE_USERNAME_PROOF: Add or replace a username proof
- MESSAGE_TYPE_FRAME_ACTION: A Farcaster Frame action

Type of signature scheme used to sign the Message hash
- SIGNATURE_SCHEME_ED25519: Ed25519 signature (default)
- SIGNATURE_SCHEME_EIP712: ECDSA signature using EIP-712 scheme

Contains the data for updating a specific field of a user's profile metadata. Each update operation modifies one profile field at a time, allowing granular control over profile information.

Specifies which profile field is being updated (e.g., profile picture, display name, bio).

The new value for the specified profile field. The format depends on the type: URLs for profile pictures, plain text for display names and bios, etc.

Profile Field Value

Specifies which field of a user's profile is being updated.
- USER_DATA_TYPE_PFP: Profile Picture URL for the user's avatar
- USER_DATA_TYPE_DISPLAY: Display Name shown on the user's profile
- USER_DATA_TYPE_BIO: Biography or description of the user
- USER_DATA_TYPE_URL: Website or social media link for the user
- USER_DATA_TYPE_USERNAME: Preferred username for the user

ApiKeyAuth

Neynar

Overview

Getting Started

Start developing on Farcaster with Neynar and AI enabled Cursor

Cursor and MCP setup

Set up Neynar with Cursor and MCP server

Supercharge Sign In with Ethereum and/or Solana in your app with Farcaster profile and social graph data

Supercharge EVM & Solana Sign-in

Find Farcaster user profile based on ethereum address

User by Wallet Address

Show good recommendations when users search for Farcaster users in your app

Username Search

Hide users and their activity based on user or developer preference

Mutes, Blocks, and Bans

Create a v2 Farcaster mini app in less than 60 seconds

Create Farcaster Mini App (v2 frame) in < 60s

Update any JavaScript web app to be a Farcaster mini app

Convert a Web App to a Farcaster Mini App

This guide walks you through a simple setup for enabling notifications for your Frame

Send Notifications to Frame Users

Create Transaction Frames

Neynar's API now supports HTML metadata for mini apps (prev. called Frames) and catalogs, providing rich information about embedded content. This feature allows you to access Open Graph (OG) data and oEmbed information for frames and catalogs, similar to how it works with casts.

Mini App Metadata

HTML & OpenGraph Metadata in Mini Apps

Get notified when someone tags your bot in a cast

Listen for @bot Mentions

Agents prompt transactions to humans with Farcaster frames

Make Agents Prompt Transactions

Show casts from a Farcaster channel with Neynar

Channel Feeds

Fetch & Display Farcaster Feeds with Neynar API

Make a Farcaster feed showing casts from a specific set of users

Farcaster Feed of NFT Owners

Show Farcaster casts that have attachments with Neynar

Casts by Embed in Farcaster

A guide on how to get feed from the Feed API using fid, fids, and parent_url.

How to Use the Neynar Feed API

Understand the differences between the various ways to manage signers and pick the right one for your app

Choose the Right Signer

Add "like" and "recast" reactions on Farcaster casts

Like & Recast

Check for quality users using Neynar's user score

Neynar User Score

Neynar APIs rank high quality casts higher

Rank High Quality Conversations

Pick between pulling or pushing data in the format that works for you

Choose Among Data Products

This guide will look at creating a Farcaster client using Next.js and the Neynar React SDK.

React client

Convert Warpcast URL into full cast data from Farcaster network through Neynar

Warpcast URLs

Write casts to a Farcaster channel with Neynar

Write Casts to Channel

Fetch stream of casts with Farcaster hubs

Cast Stream

Archive Casts

User Neynar dev portal to set up webhooks for your app

Webhooks in Dashboard

Neynar webhooks are a way to receive real-time updates about events on the Farcaster protocol. You can use webhooks to build integrations that respond to events on the protocol, such as when a user creates a cast or when a user updates their profile.

Programmatic Webhooks

This guide highlights the steps to verify incoming webhooks using signatures

Verify Webhooks

Get an addresses' connected fid on-chain.

ETH Address FID Contract

Get user quality score for an address connected to a Farcaster profile.

Address User Score Contract

Fetch notifications for any Farcaster user

Notifications for FID

Show notifications from a specific channel for a Farcaster user

Notifications in Channel

This guide provides a step-by-step process to deploy a fungible token on the Base network using Neynar's API. The deployment process is simplified to a single API call, eliminating the need for developers to write Solidity code or handle on-chain transaction signing. Neynar covers the on-chain deployment fees and assigns the specified owner address as the token owner.

Deploy a Token on Base with 1 API Call

This guide provides a comprehensive overview of how to use the Neynar API to fetch relevant holders of a fungible token on the Base network.

Relevant Holders for Coins on Base

This guide provides a step-by-step approach to fetching token balances for a user using their Farcaster FID via the Neynar API.

User Balances Directly with FID

In this guide, we’ll make a webhook which will send a DC to the user based on any action they perform on Farcaster! For this guide, I'll send direct casts to people whose casts include a specific keyword.

Overview

Farcaster API V2

Onchain

Farcaster Hub API

Neynar SDK

Github

Fetch UserData for a FID

Authorizations

Query Parameters

Response