Skip to main content
GET
/
v1
/
userNameProofByName
Proof for a username
curl --request GET \
  --url https://hub-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"
}

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
required

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

​
name
string
required
Example:

"neynar"

​
owner
string
required
​
signature
string<byte>
required
​
fid
integer
required

The FID of the user who owns this username proof Farcaster ID (FID). A unique identifier assigned to each user in the Farcaster network. This number is permanent and cannot be changed. FIDs are assigned sequentially when users register on the network.

Required range: x >= 1
Example:

1

​
type
enum<string>
default:USERNAME_TYPE_FNAME
required
Available options:
USERNAME_TYPE_FNAME,
USERNAME_TYPE_ENS_L1
⌘I