Skip to main content
GET
/
v1
/
userNameProofByName
Proof for a username
curl --request GET \
  --url https://snapchain-api.neynar.com/v1/userNameProofByName \
  --header 'x-api-key: <api-key>'
{
  "timestamp": 123,
  "name": "neynar",
  "owner": "<string>",
  "signature": "aSDinaTvuI8gbWludGxpZnk=",
  "fid": 1,
  "type": "USERNAME_TYPE_FNAME"
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

ā€‹
name
string
required

The Farcaster username or ENS address

Response

A successful response.

ā€‹
timestamp
integer<uint64>
required

Seconds since Unix Epoch which began on Jan 1, 1970 00:00:00 UTC

ā€‹
name
string
required
Example:

"neynar"

ā€‹
owner
string
required
Pattern: ^0x[0-9a-fA-F]{40}$
ā€‹
signature
string<byte>
required
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
ā€‹
fid
integer<uint64>
required

The FID of the user who owns this username proof

Required range: x >= 1
Example:

1

ā€‹
type
enum<string>
default:USERNAME_TYPE_FNAME
required
Available options:
USERNAME_TYPE_FNAME,
USERNAME_TYPE_ENS_L1