Neynar Documentation

Register Signed Key

cURL

curl --request POST \
  --url https://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --data '
{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "app_fid": 3,
  "deadline": 123,
  "signature": "0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c",
  "redirect_url": "<string>",
  "sponsor": {
    "fid": 3,
    "signature": "<string>",
    "sponsored_by_neynar": true
  }
}
'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/"

payload = {
    "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "app_fid": 3,
    "deadline": 123,
    "signature": "0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c",
    "redirect_url": "<string>",
    "sponsor": {
        "fid": 3,
        "signature": "<string>",
        "sponsored_by_neynar": True
    }
}
headers = {
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '0x5a927ac639636e534b678e81768ca19e2c6280b7',
    app_fid: 3,
    deadline: 123,
    signature: '0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c',
    redirect_url: '<string>',
    sponsor: {fid: 3, signature: '<string>', sponsored_by_neynar: true}
  })
};

fetch('https://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/', 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://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '0x5a927ac639636e534b678e81768ca19e2c6280b7',
    'app_fid' => 3,
    'deadline' => 123,
    'signature' => '0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c',
    'redirect_url' => '<string>',
    'sponsor' => [
        'fid' => 3,
        'signature' => '<string>',
        'sponsored_by_neynar' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/"

payload := strings.NewReader("{\n  \"address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n  \"app_fid\": 3,\n  \"deadline\": 123,\n  \"signature\": \"0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c\",\n  \"redirect_url\": \"<string>\",\n  \"sponsor\": {\n    \"fid\": 3,\n    \"signature\": \"<string>\",\n    \"sponsored_by_neynar\": true\n  }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Response Codes

200

400

500

Sample Success Response

{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "auth_address_approval_url": "<string>",
  "fid": 3
}

Sample Error Response

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}