Neynar Documentation

Upload NFT Token Metadata

Use the following examples to upload NFT token metadata to the Neynar API.

cURL

curl --request POST \
  --url https://api.neynar.com/v2/farcaster/nft/metadata/token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --header 'x-wallet-id: <x-wallet-id>' \
  --data '
{
  "contract_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "tokens": [
    {
      "metadata": {
        "image": "<string>",
        "name": "<string>",
        "animation_url": "<string>",
        "attributes": [
          {
            "trait_type": "<string>",
            "value": "<string>",
            "max_value": 123
          }
        ],
        "background_color": "<string>",
        "description": "<string>",
        "external_url": "<string>",
        "youtube_url": "<string>"
      },
      "token_id": "<string>"
    }
  ]
}
'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/nft/metadata/token"

payload = {
    "contract_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "tokens": [
        {
            "metadata": {
                "image": "<string>",
                "name": "<string>",
                "animation_url": "<string>",
                "attributes": [
                    {
                        "trait_type": "<string>",
                        "value": "<string>",
                        "max_value": 123
                    }
                ],
                "background_color": "<string>",
                "description": "<string>",
                "external_url": "<string>",
                "youtube_url": "<string>"
            },
            "token_id": "<string>"
        }
    ]
}
headers = {
    "x-wallet-id": "<x-wallet-id>",
    "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-wallet-id': '<x-wallet-id>',
    'x-api-key': 'NEYNAR_API_DOCS',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contract_address: '0x5a927ac639636e534b678e81768ca19e2c6280b7',
    tokens: [
      {
        metadata: {
          image: '<string>',
          name: '<string>',
          animation_url: '<string>',
          attributes: [{trait_type: '<string>', value: '<string>', max_value: 123}],
          background_color: '<string>',
          description: '<string>',
          external_url: '<string>',
          youtube_url: '<string>'
        },
        token_id: '<string>'
      }
    ]
  })
};

fetch('https://api.neynar.com/v2/farcaster/nft/metadata/token', 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/nft/metadata/token",
  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([
    'contract_address' => '0x5a927ac639636e534b678e81768ca19e2c6280b7',
    'tokens' => [
        [
                'metadata' => [
                                'image' => '<string>',
                                'name' => '<string>',
                                'animation_url' => '<string>',
                                'attributes' => [
                                                                [
                                                                                                                                'trait_type' => '<string>',
                                                                                                                                'value' => '<string>',
                                                                                                                                'max_value' => 123
                                                                ]
                                ],
                                'background_color' => '<string>',
                                'description' => '<string>',
                                'external_url' => '<string>',
                                'youtube_url' => '<string>'
                ],
                'token_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: NEYNAR_API_DOCS",
    "x-wallet-id: <x-wallet-id>"
  ],
]);

$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/nft/metadata/token"

payload := strings.NewReader("{\n  \"contract_address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n  \"tokens\": [\n    {\n      \"metadata\": {\n        \"image\": \"<string>\",\n        \"name\": \"<string>\",\n        \"animation_url\": \"<string>\",\n        \"attributes\": [\n          {\n            \"trait_type\": \"<string>\",\n            \"value\": \"<string>\",\n            \"max_value\": 123\n          }\n        ],\n        \"background_color\": \"<string>\",\n        \"description\": \"<string>\",\n        \"external_url\": \"<string>\",\n        \"youtube_url\": \"<string>\"\n      },\n      \"token_id\": \"<string>\"\n    }\n  ]\n}")

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

req.Header.Add("x-wallet-id", "<x-wallet-id>")
    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 Example

• Success (200)

{
  "tokens": [
    {
      "token_id": "<string>",
      "uri": "<string>"
    }
  ]
}

• Error (400)

{
  "code": "InvalidField",
  "errors": [
    {
      "code": "<string>",
      "expected": "<string>",
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "received": "<string>"
    }
  ],
  "message": "Invalid query parameters"
}

• Error (500)

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