Upload NFT token metadata
curl --request POST \
--url https://api.neynar.com/v2/farcaster/nft/metadata/token \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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>"
}
]
}
'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": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-wallet-id': '<x-wallet-id>',
'x-api-key': '<api-key>',
'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: <api-key>",
"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;
}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", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/nft/metadata/token")
.header("x-wallet-id", "<x-wallet-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/nft/metadata/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-wallet-id"] = '<x-wallet-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"
response = http.request(request)
puts response.read_body{
"tokens": [
{
"token_id": "<string>",
"uri": "<string>"
}
]
}{
"code": "InvalidField",
"errors": [
{
"code": "<string>",
"expected": "<string>",
"message": "<string>",
"path": [
"<string>"
],
"received": "<string>"
}
],
"message": "Invalid query parameters"
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}NFTs
Upload NFT token metadata
Uploads metadata JSON to S3 for one or more tokens on a deployed contract. Requires contract ownership via the wallet header.
POST
/
v2
/
farcaster
/
nft
/
metadata
/
token
Upload NFT token metadata
curl --request POST \
--url https://api.neynar.com/v2/farcaster/nft/metadata/token \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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>"
}
]
}
'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": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-wallet-id': '<x-wallet-id>',
'x-api-key': '<api-key>',
'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: <api-key>",
"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;
}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", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/nft/metadata/token")
.header("x-wallet-id", "<x-wallet-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/nft/metadata/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-wallet-id"] = '<x-wallet-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"
response = http.request(request)
puts response.read_body{
"tokens": [
{
"token_id": "<string>",
"uri": "<string>"
}
]
}{
"code": "InvalidField",
"errors": [
{
"code": "<string>",
"expected": "<string>",
"message": "<string>",
"path": [
"<string>"
],
"received": "<string>"
}
],
"message": "Invalid query parameters"
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}Related docs: Managing Onchain Wallets
Node.js SDK
🔗 SDK Method: uploadTokenMetadata Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.Authorizations
API key to authorize requests
Headers
Wallet ID to use for transactions
Body
application/json
Response
Success
- Option 1
- Option 2
Show child attributes
Show child attributes
Was this page helpful?
⌘I