Deploy Erc721 is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses
Example Payload
{
"operationId": "deploy-erc721",
"method": "POST",
"path": "/v2/farcaster/nft/deploy/erc721/",
"summary": "Deploy ERC-721 collection",
"description": "Deploy a new ERC-721A (series) NFT collection.",
"tags": [
"Onchain"
],
"parameters": [
{
"name": "",
"in": "",
"required": false,
"description": ""
}
],
"requestBody": {
"required": true,
"schema": {
"properties": {
"description": {
"type": "string"
},
"external_link": {
"type": "string"
},
"image": {
"type": "string"
},
"max_supply": {
"default": 0,
"description": "Max supply (0 = unlimited)",
"maximum": 281474976710655,
"minimum": 0,
"type": "integer"
},
"mint_config": {
"properties": {
"end_timestamp": {
"description": "Unix timestamp (defaults to no end date)",
"maximum": 281474976710655,
"minimum": 0,
"type": "integer"
},
"max_per_tx": {
"default": 0,
"description": "Max tokens per transaction (0 = unlimited)",
"maximum": 281474976710655,
"minimum": 0,
"type": "integer"
},
"max_per_wallet": {
"default": 0,
"description": "Max tokens per wallet (0 = unlimited)",
"maximum": 281474976710655,
"minimum": 0,
"type": "integer"
},
"price_per_token": {
"default": "0",
"description": "Price per token in wei (0 = free mint)",
"pattern": "^\\d{1,57}$",
"type": "string"
},
"start_timestamp": {
"description": "Unix timestamp (defaults to current time)",
"maximum": 281474976710655,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"network": {
"enum": [
"base",
"optimism",
"base-sepolia"
],
"type": "string"
},
"royalty_bps": {
"default": 0,
"description": "Royalty in basis points (500 = 5%, max 2500 = 25%)",
"maximum": 2500,
"minimum": 0,
"type": "integer"
},
"royalty_recipient": {
"description": "Defaults to creator wallet",
"example": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pattern": "^0x[a-fA-F0-9]{40}$",
"type": "string"
},
"symbol": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"required": [
"network",
"name",
"symbol"
],
"type": "object"
},
"example": null
},
"responses": {
"201": {
"description": "201",
"schema": {
"properties": {
"collection": {
"properties": {
"address": {
"$ref": "#/components/schemas/EthAddress"
},
"name": {
"type": "string"
},
"network": {
"enum": [
"base",
"optimism",
"base-sepolia"
],
"type": "string"
},
"symbol": {
"type": "string"
},
"transaction_hash": {
"pattern": "^0x[a-fA-F0-9]{64}$",
"type": "string"
},
"type": {
"enum": [
"ERC721"
],
"type": "string"
}
},
"required": [
"type",
"network",
"address",
"name",
"symbol",
"transaction_hash"
],
"type": "object"
},
"object": {
"enum": [
"nft_collection"
],
"type": "string"
}
},
"required": [
"object",
"collection"
],
"type": "object"
},
"example": null
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/components/schemas/ErrorRes"
},
"example": null
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/components/schemas/ErrorRes"
},
"example": null
},
"404": {
"description": "Resource not found",
"schema": {
"$ref": "#/components/schemas/ErrorRes"
},
"example": null
},
"500": {
"description": "Server Error",
"schema": {
"$ref": "#/components/schemas/ErrorRes"
},
"example": null
}
}
}