Proof for a username
cURL
curl --request GET \
--url https://snapchain-api.neynar.com/v1/userNameProofByName \
--header 'x-api-key: NEYNAR_API_DOCS'
import requests
url = "https://snapchain-api.neynar.com/v1/userNameProofByName"
headers = {"x-api-key": "NEYNAR_API_DOCS"}
response = requests.get(url, headers=headers)
print(response.text)
const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};
fetch('https://snapchain-api.neynar.com/v1/userNameProofByName', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [\
CURLOPT_URL => "https://snapchain-api.neynar.com/v1/userNameProofByName",\
CURLOPT_RETURNTRANSFER => true,\
CURLOPT_ENCODING => "",\
CURLOPT_MAXREDIRS => 10,\
CURLOPT_TIMEOUT => 30,\
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
CURLOPT_CUSTOMREQUEST => "GET",\
CURLOPT_HTTPHEADER => [\
"x-api-key: NEYNAR_API_DOCS"\
],\
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://snapchain-api.neynar.com/v1/userNameProofByName"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://snapchain-api.neynar.com/v1/userNameProofByName")
.header("x-api-key", "NEYNAR_API_DOCS")
.asString();
require 'uri'
require 'net/http'
url = URI("https://snapchain-api.neynar.com/v1/userNameProofByName")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
response = http.request(request)
puts response.read_body
Response Structure
Sample Success Response 200:
{
"timestamp": 123,
"name": "neynar",
"owner": "<string>",
"signature": "aSDinaTvuI8gbWludGxpZnk=",
"fid": 1,
"type": "USERNAME_TYPE_FNAME"
}
Sample Error Response:
{
"errCode": "<string>",
"presentable": true,
"name": "<string>",
"code": 123,
"details": "<string>",
"metadata": {
"errcode": [
"<string>"
]
}
}
Authorizations
- x-api-key: (string)
- Required: Yes
- Default: NEYNAR_API_DOCS
- Description: API key to authorize requests
Query Parameters
- name: (string)
- Required: Yes
- Description: The Farcaster username or ENS address
Response Fields
- timestamp: (integer)
- Required: Yes
- Description: Seconds since Unix Epoch which began on Jan 1, 1970 00:00:00 UTC
- name: (string)
- Required: Yes
- Example: "neynar"
- owner: (string)
- Required: Yes
- Pattern:
^0x[0-9a-fA-F]{40}$
- signature: (string)
- Required: Yes
- Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
- fid: (integer)
- type: (enum)
- Required: Yes
- Options:
USERNAME_TYPE_FNAME, USERNAME_TYPE_ENS_L1