Neynar User API

Operations related to user

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 16 operations across 13 paths, and defines 40 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.

16 operations 13 paths 40 schemas 2 DELETE10 GET1 PATCH3 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

Neynar

Resource Areas

Authentication & Security 1

Neynar User 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 16

Across 13 paths, the API surfaces 16 operations — 2 DELETE, 10 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

User 16

Operations related to user

PATCH

/v2/farcaster/user/

Update user profile

update-user body → 200207400403404500

POST

/v2/farcaster/user/

GET

/v2/farcaster/user/best_friends/

Best friends

get-user-best-friends 3 params → 200400500

GET

/v2/farcaster/user/bulk-by-address/

By Eth or Sol addresses

fetch-bulk-users-by-eth-or-sol-address 4 params → 200400404

GET

/v2/farcaster/user/bulk/

By FIDs

fetch-bulk-users 3 params → 200400

GET

/v2/farcaster/user/by_location/

By location

fetch-users-by-location 6 params → 200400404500

GET

/v2/farcaster/user/by_username/

By username

lookup-user-by-username 3 params → 200400404500

GET

/v2/farcaster/user/by_x_username/

By X username

lookup-users-by-x-username 3 params → 200400404500

GET

/v2/farcaster/user/custody-address/

By custody-address

lookup-user-by-custody-address 1 param → 200400404

GET

/v2/farcaster/user/fid/

Fetch fresh FID

get-fresh-account-FID 2 params → 200500

DELETE

/v2/farcaster/user/follow/

Unfollow user

unfollow-user body → 200400403404500

POST

/v2/farcaster/user/follow/

Follow user

follow-user body → 200400403404500

GET

/v2/farcaster/user/search/

Search for Usernames

search-user 5 params → 200400

DELETE

/v2/farcaster/user/verification/

Delete verification

delete-verification body → 200

POST

/v2/farcaster/user/verification/

Add verification

publish-verification body → 200

GET

/v2/farcaster/user/verifications/

Fetch verifications

fetch-verifications 1 param → 200400500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are User (18 properties), UpdateUserReqBody (11 properties), UserDehydrated (7 properties), Signer (7 properties). Each schema is shown below with its type and property counts.

ChannelUserContext

object

Adds context on the viewer's or author's role in the channel.

2 properties 1 required

Protocol

string

Blockchain protocol for the linked wallet: evm for Ethereum/EVM-compatible chains (Base, Optimism, etc.) and solana for Solana

VerificationChainId

integer

Chain ID for farcaster verifications. 0 for EOA verifications, 1 or 10 for contract verifications

OperationResponse

object

2 properties

SignerUUID

string

UUID of the signer. signeruuid is paired with API key, can't use a uuid made with a different API key.

SolAddress

string

Solana address

User

object

18 properties 12 required

ChannelMemberRole

string

The role of a channel member

UserViewerContext

object

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

4 properties 4 required

Signer

object

7 properties 3 required

UserResponse

object

1 property 1 required

EthAddress

string

Ethereum address

Location

object

Coordinates and place names for a location

4 properties 2 required

UsersResponse

object

2 properties 2 required

Verification

object

Verification details of an address

5 properties 4 required

UserDehydrated

object

7 properties 2 required

FollowReqBody

object

2 properties 2 required

UpdateUserReqBody

object

11 properties 1 required

ChannelDehydrated

object

5 properties 3 required

AddVerificationReqBody

object

6 properties 4 required

RegisterUserResponse

object

5 properties 3 required

FollowResponse

object

3 properties 3 required

UserFIDResponse

object

1 property 1 required

BestFriendsResponse

object

2 properties 1 required

SharedSignerPermission

string

LocationAddress

object

5 properties 2 required

Ed25519PublicKey

string

Ed25519 public key

UserSearchResponse

object

1 property 1 required

ZodError

object

3 properties 3 required

ErrorRes

object

Details for the error response

4 properties 1 required

TextRange

object

2 properties 2 required

BulkFollowResponse

object

2 properties 2 required

RegisterUserReqBody

object

7 properties 4 required

NextCursor

object

Returns next cursor

1 property 1 required

BulkUsersResponse

object

1 property 1 required

ConflictErrorRes

object

Details for the conflict error response

4 properties 1 required

VerificationType

integer

Type of verification. 0 = EOA, 1 = contract

RemoveVerificationReqBody

object

4 properties 4 required

BulkUsersByAddressResponse

object

Fid

integer

The unique identifier of a farcaster user or app (unsigned integer)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#User

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Neynar User API

Metadata

Authentication & Security 1

Paths & Operations 16

Schemas 40

Specification

Source

API Details

Provider

Explore more