Neynar Documentation

Register Signed Key

cURL

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

Python

import requests

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

payload = {
    "app_fid": 3,
    "deadline": 123,
    "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
    "signature": "0x7867e84cb6a64bf6e1954e52884133f1114eb3fd97f63ff55fa76c77c80beb6434eea9d3736b59caa3130d63121177acc752dc8a2561e9edf700642f390f92d11b",
    "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

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

fetch('https://api.neynar.com/v2/farcaster/signer/developer_managed/signed_key/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neynar.com/v2/farcaster/signer/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([
    'app_fid' => 3,
    'deadline' => 123,
    'public_key' => '0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22',
    'signature' => '0x7867e84cb6a64bf6e1954e52884133f1114eb3fd97f63ff55fa76c77c80beb6434eea9d3736b59caa3130d63121177acc752dc8a2561e9edf700642f390f92d11b',
    '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;
}
?>

GNU Go

package main

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

func main() {

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

payload := strings.NewReader("{\n  \"app_fid\": 3,\n  \"deadline\": 123,\n  \"public_key\": \"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22\",\n  \"signature\": \"0x7867e84cb6a64bf6e1954e52884133f1114eb3fd97f63ff55fa76c77c80beb6434eea9d3736b59caa3130d63121177acc752dc8a2561e9edf700642f390f92d11b\",\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))
}

Unirest Java

HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/signer/developer_managed/signed_key/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_fid\": 3,\n  \"deadline\": 123,\n  \"public_key\": \"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22\",\n  \"signature\": \"0x7867e84cb6a64bf6e1954e52884133f1114eb3fd97f63ff55fa76c77c80beb6434eea9d3736b59caa3130d63121177acc752dc8a2561e9edf700642f390f92d11b\",\n  \"redirect_url\": \"<string>\",\n  \"sponsor\": {\n    \"fid\": 3,\n    \"signature\": \"<string>\",\n    \"sponsored_by_neynar\": true\n  }}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/signer/developer_managed/signed_key/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_fid\": 3,\n  \"deadline\": 123,\n  \"public_key\": \"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22\",\n  \"signature\": \"0x7867e84cb6a64bf6e1954e52884133f1114eb3fd97f63ff55fa76c77c80beb6434eea9d3736b59caa3130d63121177acc752dc8a2561e9edf700642f390f92d11b\",\n  \"redirect_url\": \"<string>\",\n  \"sponsor\": {\n    \"fid\": 3,\n    \"signature\": \"<string>\",\n    \"sponsored_by_neynar\": true\n  }}"

response = http.request(request)
puts response.read_body

Response

Success (200)

{
  "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
  "fid": 3,
  "signer_approval_url": "<string>"
}

Error Responses

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

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

Additional Information

Important Notes

Authorizations

Body Parameters