Neynar Documentation

Deploy ERC-721 collection

cURL

curl --request POST \
  --url https://api.neynar.com/v2/farcaster/nft/deploy/erc721/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --header 'x-wallet-id: <x-wallet-id>' \
  --data '
{
  "name": "<string>",
  "symbol": "<string>",
  "description": "<string>",
  "external_link": "<string>",
  "image": "<string>",
  "max_supply": 0,
  "mint_config": {
    "end_timestamp": 140737488355327,
    "max_per_tx": 0,
    "max_per_wallet": 0,
    "price_per_token": "0",
    "start_timestamp": 140737488355327
  },
  "royalty_bps": 0,
  "royalty_recipient": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/nft/deploy/erc721/"

payload = {
    "name": "<string>",
    "symbol": "<string>",
    "description": "<string>",
    "external_link": "<string>",
    "image": "<string>",
    "max_supply": 0,
    "mint_config": {
        "end_timestamp": 140737488355327,
        "max_per_tx": 0,
        "max_per_wallet": 0,
        "price_per_token": "0",
        "start_timestamp": 140737488355327
    },
    "royalty_bps": 0,
    "royalty_recipient": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
}
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({
    name: '<string>',
    symbol: '<string>',
    description: '<string>',
    external_link: '<string>',
    image: '<string>',
    max_supply: 0,
    mint_config: {
      end_timestamp: 140737488355327,
      max_per_tx: 0,
      max_per_wallet: 0,
      price_per_token: '0',
      start_timestamp: 140737488355327
    },
    royalty_bps: 0,
    royalty_recipient: '0x5a927ac639636e534b678e81768ca19e2c6280b7'
  })
};

fetch('https://api.neynar.com/v2/farcaster/nft/deploy/erc721/', 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/deploy/erc721/",
  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([
    'name' => '<string>',
    'symbol' => '<string>',
    'description' => '<string>',
    'external_link' => '<string>',
    'image' => '<string>',
    'max_supply' => 0,
    'mint_config' => [
        'end_timestamp' => 140737488355327,
        'max_per_tx' => 0,
        'max_per_wallet' => 0,
        'price_per_token' => '0',
        'start_timestamp' => 140737488355327
    ],
    'royalty_bps' => 0,
    'royalty_recipient' => '0x5a927ac639636e534b678e81768ca19e2c6280b7'
  ]),
  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/deploy/erc721/"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"symbol\": \"<string>\",\n  \"description\": \"<string>\",\n  \"external_link\": \"<string>\",\n  \"image\": \"<string>\",\n  \"max_supply\": 0,\n  \"mint_config\": {\n    \"end_timestamp\": 140737488355327,\n    \"max_per_tx\": 0,\n    \"max_per_wallet\": 0,\n    \"price_per_token\": \"0\",\n    \"start_timestamp\": 140737488355327\n  },\n  \"royalty_bps\": 0,\n  \"royalty_recipient\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\"}")

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))
}

Responses

201

{
  "collection": {
    "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "name": "<string>",
    "symbol": "<string>",
    "transaction_hash": "<string>",
    "type": "ERC721"
  },
  "object": "nft_collection"
}

Error Responses

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

Authorization