Neynar Documentation

Simulate NFT mint calldata

cURL

curl --request GET \
  --url https://api.neynar.com/v2/farcaster/nft/mint/ \
  --header 'x-api-key: NEYNAR_API_DOCS'

Python

import requests

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

headers = {"x-api-key": "NEYNAR_API_DOCS"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {method: 'GET', headers: {'x-api-key': 'NEYNAR_API_DOCS'}};

fetch('https://api.neynar.com/v2/farcaster/nft/mint/', 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/nft/mint/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
    "net/http"
    "io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "NEYNAR_API_DOCS")

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

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

fmt.Println(string(body))
}

Unirest

HttpResponse<String> response = Unirest.get("https://api.neynar.com/v2/farcaster/nft/mint/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/nft/mint/")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'

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

Response Codes

200

400

404

500

Example Response

[
  {
    "args": [
      "<unknown>"
    ],
    "calldata": "0xabcdef",
    "data": "0x1234abcd",
    "estimated_total_cost_wei": "100000000000000",
    "function_name": "mintTo",
    "network": "base",
    "recipient": {
      "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
      "fid": "<unknown>",
      "quantity": 1
    },
    "to": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "value": "0",
    "abi": "<unknown>"
  }
]

Error Response

{
  "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
}

Authorizations

• x-api-key
  string
  header
  default: NEYNAR_API_DOCS
  required
  API key to authorize requests

Query Parameters

• recipients
  string
  required
  JSON array of recipients (same structure as POST).
• nft_contract_address
  string
  required
  Ethereum address
  Pattern: ^0x[a-fA-F0-9]{40}$
  Example:
  "0x5a927ac639636e534b678e81768ca19e2c6280b7"
• network
  enum
  required
  Network to mint on.
  Available options:
  base,
  optimism,
  base-sepolia

Response Structure

200

application/json
Success

• args
  any[]
  required
• calldata
  string
  required
  Example:
  "0xabcdef"
• data
  string
  required
  Example:
  "0x1234abcd"
• estimated_total_cost_wei
  string
  required
  Example:
  "100000000000000"
• function_name
  string
  required
  Example:
  "mintTo"
• network
  string
  required
  Example:
  "base"
• recipient
  object
  required
  NFT mint recipient. Exactly one of "address" or "fid" must be set.