Overview

Farcaster API V2

User
- Fetch User Information
- Fetch User's Casts
- Register New User
- Update User Profile
- GET
  Fetch authorization url
Signer
Cast
Feed
Reaction
Notifications
Channel
Follows
Storage
Frame
Agents
Fname
Webhook
Action
Mute
Block
Ban
Onchain
Login
Metrics

Onchain

POST
Deploy fungible

Farcaster Hub API

Info
Casts
Reactions
Links
UserData
Fids
Storage
Usernames
Verifications
OnChainEvents
Message
HubEvents

Neynar SDK

Getting Started with Neynar NodeJS SDK
SDK v1 to v2 migration guide

Github

Fetch User Information

By Eth or Sol addresses

Fetches all users based on multiple Ethereum or Solana addresses.

Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses.

A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses.

GET

farcaster

user

bulk-by-address

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/user/bulk-by-address \
  --header 'x-api-key: <api-key>'

{}

Authorizations

x-api-key

string

header

default:NEYNAR_API_DOCS

required

API key to authorize requests

Headers

x-neynar-experimental

boolean

default:false

Enables experimental features including filtering based on the Neynar score. See docs for more details.

Query Parameters

addresses

string

required

Comma separated list of Ethereum addresses, up to 350 at a time

address_types

enum<string>[]

Customize which address types the request should search for. This is a comma-separated string that can include the following values: 'custody_address' and 'verified_address'. By default api returns both. To select multiple types, use a comma-separated list of these values.

Available options:

custody_address,

verified_address

viewer_fid

integer

The unique identifier of a farcaster user (unsigned integer)

Example:

3

Response

200

application/json

Successful operation.

{key}

object[]

{key}.object

enum<string>

required

Available options:

user

{key}.fid

integer

required

The unique identifier of a farcaster user (unsigned integer)

Example:

3

{key}.username

string

required

{key}.custody_address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

{key}.profile

object

required

{key}.profile.bio

object

required

{key}.profile.location

object

Coordinates and place names for a location

{key}.follower_count

integer

required

The number of followers the user has.

{key}.following_count

integer

required

The number of users the user is following.

{key}.verifications

string[]

required

Ethereum address

{key}.verified_addresses

object

required

{key}.verified_accounts

object[]

required

Verified accounts of the user on other platforms, currently only X is supported.

{key}.power_badge

boolean

required

{key}.display_name

string

{key}.pfp_url

string

The URL of the user's profile picture

{key}.experimental

object

{key}.viewer_context

object

Adds context on the viewer's follow relationship with the user.

Was this page helpful?

Power user FIDs By custody-address

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/user/bulk-by-address \
  --header 'x-api-key: <api-key>'

{}

Overview

Farcaster API V2

Onchain

Farcaster Hub API

Neynar SDK

Github

​See related guide: User by wallet address

Authorizations

Headers

Query Parameters

Response

See related guide: User by wallet address