NFTs API

API is for creating and managing NFTs. To prepare images and metadata for your NFT collection you can use the Storage API. To learn more about metadata standards you can visit: https://docs.opensea.io/docs/metadata-standardsopen in new window

Get NFT Collection

Get NFT collection by UUID

GET /nfts/collections/:uuid

URL parameters

Name	Description	Required
uuid	Unique key of collection. Key is displayed in developer dashboard.	true

Possible errors

Code	Description
40300000	Not allowed to access collection.
50012009	Collection does not exist.

Response Fields

Name	Type	Description
createTime	`DateTime`	Collection create time.
updateTime	`DateTime`	Collection last update time.
collectionType	`number`	Type of smart contract to use for collection. Available types are described here.
collectionUuid	`string`	Unique key of a collection.
symbol	`string`	NFT collection symbol (usually 3-4 characters long).
name	`string`	NFT collection name.
description	`string`	NFT collection description.
maxSupply	`number`	Maximal number of NFTs ever in existence (0 stands for unlimited).
bucketUuid	`string`	UUID of the bucket where metadata is stored.
baseUri	`string`	Base URI for collection metadata (token id and file extension is appended to it).
baseExtension	`string`	File extension that is auto appended after token id to form a full URL.
isSoulbound	`boolean`	Soul bound tokens are NFTs that are bounded to wallet and not transferable.
isRevokable	`boolean`	For revocable collection owner can destroy NFTs at any time.
isAutoIncrement	`boolean`	If set to false, enables minting NFTs with a custom token ID
royaltiesFees	`number`	Percentage (between 0 and 100) of each NFT sale sent to wallet specified under royalties address.
royaltiesAddress	`string`	Address where royalties are sent to.
collectionStatus	`number`	Apillon internal/database collection status.
contractAddress	`string`	Smart address of contract for deployed collection.
transactionHash	`string`	Deployment transaction hash/id.
deployerAddress	`string`	Wallet address of deployer.
chain	`number`	Blockchain id on which you want to release your collection.
drop	`boolean`	Determines if collection is mintable by public.
dropStart	`number`	UNIX timestamp which determines public mint opening date and time.
dropPrice	`number`	Price of NFT at mint stage in token that is used on `chain`.
dropReserve	`number`	Amount of NFTs reserved by owner.

curl --location 'https://api.apillon.io/nfts/collections/:uuid' \
--header 'Authorization: Basic :credentials'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "createTime": "2023-06-13T10:15:58.000Z",
    "updateTime": "2023-06-13T10:15:58.000Z",
    "collectionType": 1,
    "collectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a",
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection Description",
    "maxSupply": 1000,
    "bucketUuid": "a9425ff7-4802-4a38-b771-84a790112c30",
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": ".json",
    "isSoulbound": false,
    "isRevokable": true,
    "royaltiesFees": 0.1,
    "royaltiesAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "collectionStatus": 0,
    "contractAddress": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241557",
    "transactionHash": "0x6b97424de3367cd0335b08265787b83053b62bee2d1c8bec1f776936bea4fb26",
    "deployerAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "chain": 1287,
    "drop": true,
    "dropStart": 1687251003,
    "dropPrice": 0.1,
    "dropReserve": 5
  }
}

Collection Type

Number	Description
0	Generic NFT collection.
1	Nestable NFT collection.

Collection Statuses

Number	Description
0	Collection was created.
1	Deploying collection was initiated.
2	Collection is being deployed.
3	Collection was deployed successfully.
4	Collection was transferred successfully.
5	Failed deploying collection.

List NFT Collections

List NFT collections. Items are paginated and can be filtered and ordered through query parameters.

GET /nfts/collections

Query parameters

All query parameters from listing request plus:

Name	Description	Required
collectionStatus	Collection status. Find available statuses here.	false

Response

Response is a list of items described under Response Fields above.

curl --location 'https://api.apillon.io/nfts/collections' \
--header 'Authorization: Basic :credentials'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "items": [
      {
        "createTime": "2023-06-13T10:15:58.000Z",
        "updateTime": "2023-06-13T10:15:58.000Z",
        "collectionType": 1,
        "collectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a",
        "symbol": "NFT",
        "name": "NFT Collection",
        "description": "NFT Collection Description",
        "maxSupply": 1000,
        "bucketUuid": "a9425ff7-4802-4a38-b771-84a790112c30",
        "baseUri": "https://ipfs.apillon.io/metadata/",
        "baseExtension": ".json",
        "isSoulbound": false,
        "isRevokable": true,
        "royaltiesFees": 0.1,
        "royaltiesAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
        "collectionStatus": 0,
        "contractAddress": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241557",
        "transactionHash": "0x6b97424de3367cd0335b08265787b83053b62bee2d1c8bec1f776936bea4fb26",
        "deployerAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
        "chain": 1287,
        "drop": true,
        "dropStart": 1687251003,
        "dropPrice": 0.1,
        "dropReserve": 5
      }
    ],
    "total": 1
  }
}

List Collection Transactions

List NFT collections. Items are paginated and can be filtered and ordered through query parameters.

GET /nfts/collections/:uuid/transactions

URL parameters

Name	Description	Required
uuid	Unique key of collection. Key is displayed in developer dashboard.	true

Query parameters

All query parameters from listing request plus:

Name	Description	Required
transactionStatus	Transaction status.	false
transactionType	Transaction type.	false

Response Fields

Name	Type	Description
chainId	`number`	Blockchain id on which you want to release your collection.
transactionType	`number`	Transaction type.
transactionStatus	`number`	Transaction status
transactionHash	`number`	Transaction hash/id.
updateTime	`DateTime`	Transaction last update time.
createTime	`DateTime`	Transaction create time.

curl --location 'https://api.apillon.io/nfts/collections/:uuid/transactions' \
--header 'Authorization: Basic :credentials'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "items": [
      {
        "chainId": 1287,
        "transactionType": 1,
        "transactionStatus": 1,
        "transactionHash": "0xb988c8cda7ec8b441611b208360e0aace9c294e1ca5672375b21e815890a54d1",
        "updateTime": "2023-06-13T10:15:58.000Z",
        "createTime": "2023-06-13T10:15:58.000Z"
      }
    ],
    "total": 1
  }
}

Transaction Types

Number	Description
1	Deploy Contract
2	Transfer Contract Ownership
3	Mint NFT
4	Set Collection Base URI
5	Burn NFT
6	Nest mint NFT

Transaction Status

Number	Description
1	Pending
2	Confirmed
3	Failed
4	Error

Create NFT Collection

API endpoint that creates NFT collection and deploys it on selected network.

An NFT Collection can be created with a few features/functionalities:

drop: collection can be minted/purchased by users
revokable: NFTs can be revoked by collection owner who can burn them
soulbound: NFTs are bound to wallet address and can't be transferred
royalties: owner can enable royalties to earn specified percentage per each NFT trade

2 types of collections are supported:

Generic collection, which represents an extension of the ERC-721 standard for EVM collections and the PSP-34 standard for substrate collections. You can read more about these standards here
Nestable collection which allows nesting NFTs under each other (based on RMRKs ERC-7401open in new window NFT standard - EVM only)

Additionally, 2 chain types/environments are supported: EVM and Substrate.

Create Substrate NFT Collection

POST /nfts/collections/substrate

Body fields

Name	Type	Description	Required
collectionType	`number`	Type of smart contract to use when deploying collection (1 for generic, 2 for nestable).	true
chain	`number`	Blockchain ID on which you want to release your collection. Options: (`8` - Astar)	true
symbol	`string`	NFT collection symbol (usually 3-4 characters long).	true
name	`string`	NFT collection name.	true
description	`string`	NFT collection description.	false
maxSupply	`number`	Maximal number of NFTs ever in existence (0 stands for unlimited).	true
baseUri	`string`	Base URI for collection metadata (token id and file extension is appended to it).	true
baseExtension	`string`	File extension that is auto appended after token id to form a full URL.	true
royaltiesAddress	`string`	Address where royalties are sent to.	true
royaltiesFees	`number`	Percentage of royalties earned per each NFT trade.	true
drop	`boolean`	Determines if collection is mintable by public.	true
dropStart*	`number`	UNIX timestamp (in seconds) which determines public mint opening date and time.	true
dropPrice*	`number`	Price of NFT at mint stage.	true
dropReserve*	`number`	Amount of NFTs reserved by owner.	true

Notes:

*dropStart, dropPrice and dropReserve are only used if drop is set to boolean true.

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40012002	Collection quota reached
50012003	Failed deploying NFT contract on chain.
50012010	Failed to create bucket for storing metadata.

Response

Response payload is described under Response Fields above.

curl --location 'https://api.apillon.io/nfts/collections/substrate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{
    "collectionType": 1,
    "chain": 8,
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection description",
    "maxSupply": 1000,
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": "json",
    "royaltiesAddress": "5TdmScYtgDGg13mG1pvQ5zAooMXMK45bHBt3meGDXrNBKua",
    "royaltiesFees": 10,
    "drop": true,
    "dropStart": 1687251003,
    "dropReserve": 5,
    "dropPrice": 0.1
}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "createTime": "2023-06-13T10:15:58.000Z",
    "updateTime": "2023-06-13T10:15:58.000Z",
    "chain": 8,
    "collectionType": 1,
    "collectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a",
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection Description",
    "maxSupply": 1000,
    "bucketUuid": "a9425ff7-4802-4a38-b771-84a790112c30",
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": ".json",
    "isSoulbound": false,
    "isRevokable": false,
    "royaltiesFees": 0.1,
    "royaltiesAddress": "5TdmScYtgDGg13mG1pvQ5zAooMXMK45bHBt3meGDXrNBKua",
    "collectionStatus": 0,
    "contractAddress": "XjuXMnFxcJoAgMCdUQKvvt2Daykq4H9rsCfYEVpF6noFP5u",
    "transactionHash": "0xb59d8497feb121b0ca0b8480df72a456333edddc68ad65f23b6b8b9028e3a6b3",
    "deployerAddress": "WmMcyrPY4fivB5FUPN85QPhCMKtnrjmUyAgtXC2oW2XbcnY",
    "drop": true,
    "dropStart": 1687251003,
    "dropPrice": 0.1,
    "dropReserve": 5
  }
}

Create EVM NFT Collection

POST /nfts/collections/evm

Body fields

All the fields from substrate collection, plus:

Name	Type	Description	Required
chain	`number`	Blockchain ID on which you want to release your collection. Options: (`1284` - Moonbeam, `1287` - Moonbase, `592` - Astar)	true
isRevokable	`boolean`	For revocable collection owner can destroy NFTs at any time. (default: false)	true
isSoulbound	`boolean`	Soul bound tokens are NFTs that are bound to wallet and not transferable. (default: false)	true
isAutoIncrement	`boolean`	If set to false, enables minting NFTs with a custom token ID, otherwise defaults to isAutoIncrement = true	false

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40012002	Collection quota reached
50012003	Failed deploying NFT contract on chain.
50012010	Failed to create bucket for storing metadata.

Response

Response payload is described under Response Fields above.

curl --location 'https://api.apillon.io/nfts/collections/evm' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{
    "collectionType": 1,
    "chain": 1287,
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection description",
    "maxSupply": 1000,
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": "json",
    "royaltiesAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "royaltiesFees": 10,
    "drop": true,
    "dropStart": 1687251003,
    "dropReserve": 5,
    "dropPrice": 0.1,
    "isRevokable": true,
    "isSoulbound": true
}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "createTime": "2023-06-13T10:15:58.000Z",
    "updateTime": "2023-06-13T10:15:58.000Z",
    "chain": 1287,
    "collectionType": 1,
    "collectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a",
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection Description",
    "maxSupply": 1000,
    "bucketUuid": "a9425ff7-4802-4a38-b771-84a790112c30",
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": ".json",
    "isSoulbound": false,
    "isRevokable": false,
    "royaltiesFees": 0.1,
    "royaltiesAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "collectionStatus": 0,
    "contractAddress": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241557",
    "transactionHash": "0x6b97424de3367cd0335b08265787b83053b62bee2d1c8bec1f776936bea4fb26",
    "deployerAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "drop": true,
    "dropStart": 1687251003,
    "dropPrice": 0.1,
    "dropReserve": 5,
    "isRevokable": true,
    "isSoulbound": true
  }
}

Transfer Collection

Transfer collection ownership from a wallet owned by caller to a new wallet address.

POST/nfts/collections/:uuid/transfer

URL parameters

Name	Description	Required
uuid	Unique key of collection. Key is displayed in developer dashboard.	true

Body fields

Name	Type	Description	Required
address	`string`	Wallet address of a new owner.	true

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40012003	Contract can't be transferred to wallet address that already owns this collection.
40012004	Transfer transaction already exists.
40300000	Not allowed to access collection
50012002	Collection doesn't exist, wasn't deployed or was already transferred.
50012004	Collection transfer failed.

Response

Response payload is described under Response Fields above.

curl --location 'https://api.apillon.io/nfts/collections/:uuid/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{"address": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241551"}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "createTime": "2023-06-13T10:15:58.000Z",
    "updateTime": "2023-06-13T10:15:58.000Z",
    "collectionType": 1,
    "collectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a",
    "symbol": "NFT",
    "name": "NFT Collection",
    "description": "NFT Collection Description",
    "maxSupply": 1000,
    "bucketUuid": "a9425ff7-4802-4a38-b771-84a790112c30",
    "baseUri": "https://ipfs.apillon.io/metadata/",
    "baseExtension": ".json",
    "isSoulbound": false,
    "isRevokable": true,
    "royaltiesFees": 0.1,
    "royaltiesAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "collectionStatus": 0,
    "contractAddress": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241557",
    "transactionHash": "0x6b97424de3367cd0335b08265787b83053b62bee2d1c8bec1f776936bea4fb26",
    "deployerAddress": "0x4156edbafc5091507de2dd2a53ded551a346f83b",
    "chain": 1287,
    "drop": true,
    "dropStart": 1687251003,
    "dropPrice": 0.1,
    "dropReserve": 5
  }
}

Mint Collection NFTs

Mint specified amount of NFTs to a wallet address provided in request.

Note: if the collection is set as drop this endpoint can only mint reserved NFTs.

POST/nfts/collections/:uuid/mint

URL parameters

Name	Description	Required
uuid	Unique key of collection. Key is displayed in developer dashboard.	true

Body fields

Name	Type	Description	Required
receivingAddress	`string`	Wallet address of NFT receiver.	true
quantity	`number`	Number of NFTs to mint.	true

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40300000	Not allowed to access collection.
50012002	Collection doesn't exist, wasn't deployed or was already transferred.
50012005	Error minting NFT.
50012007	Total number of minted NFTs would exceed max supply for this collection.
50012008	All of the reserved NFTs were already minted.

Response Fields

Field	Type	Description
success	`boolean`	Status of action.

curl --location 'https://api.apillon.io/nfts/collections/:uuid/mint' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{"receivingAddress": "0x452101C96A1Cf2cBDfa5BB5353e4a7F235241557", "quantity": 1}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "success": true
  }
}

Nest Mint Collection NFTs

Nest mint specified amount of NFTs under a parent NFT defined by the parent collection UUID and token id.

POST/nfts/collections/:uuid/nest-mint

URL parameters

Name	Description	Required
uuid	Unique key of (child) collection we are minting.	true

Body fields

Name	Type	Description	Required
parentCollectionUuid	`string`	Collection UUID of NFT receiving nest-minted NFT.	true
parentNftId	`number`	Token id of NFT receiving nest-minted NFT.	true
quantity	`number`	Number of NFTs to nest-mint.	true

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40300000	Not allowed to access collection.
50012002	Collection doesn't exist, wasn't deployed or was already transferred.
50012007	Total number of minted NFTs would exceed max supply for this collection.
50012008	All of the reserved NFTs were already minted.
50012013	Parrent collection doesn't support nesting.
50012014	Parrent and child collection chain missmatch.

Response Fields

Field	Type	Description
success	`boolean`	Status of action.

curl --location 'https://api.apillon.io/nfts/collections/:uuid/next-mint' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{"parentCollectionUuid": "d6355fd3-640d-4803-a4d9-79d875abcb5a", "parentNftId": 1, "quantity": 1}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "success": true
  }
}

Burn Collection NFT

Burn specific NFT belonging to collection specified.

Note: burning NFTs is only available if isRevokable is enabled on collection.

POST/nfts/collections/:uuid/burn

URL parameters

Name	Description	Required
uuid	Unique key of collection. Key is displayed in developer dashboard.	true

Body fields

Name	Type	Description	Required
tokenId	`number`	Non fungible token id that we are burning.	true

Possible errors

Beside validation errors (with 422 http status code) these are the error codes may be returned:

Code	Description
40300000	Not allowed to access collection.
50012002	Collection doesn't exist, wasn't deployed or was already transferred.
50012012	Burning NFT failed.

Response fields

Field	Type	Description
success	`boolean`	Status of action.

curl --location 'https://api.apillon.io/nfts/collections/:uuid/burn' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic :credentials' \
--data '{"tokenId": 1}'

{
  "id": "b5935c73-204d-4365-9f9a-6a1792adab5b",
  "status": 200,
  "data": {
    "status": true
  }
}

# NFTs API

# Get NFT Collection

# URL parameters

# Possible errors

# Response Fields

# Collection Type

# Collection Statuses

# List NFT Collections

# Query parameters

# Response

# List Collection Transactions

# URL parameters

# Query parameters

# Response Fields

# Transaction Types

# Transaction Status

# Create NFT Collection

# Create Substrate NFT Collection

# Body fields

# Possible errors

# Response

# Create EVM NFT Collection

# Body fields

# Possible errors

# Response

# Transfer Collection

# URL parameters

# Body fields

# Possible errors

# Response

# Mint Collection NFTs

# URL parameters

# Body fields

# Possible errors

# Response Fields

# Nest Mint Collection NFTs

# URL parameters

# Body fields

# Possible errors

# Response Fields

# Burn Collection NFT

# URL parameters

# Body fields

# Possible errors

# Response fields

NFTs API

Get NFT Collection

URL parameters

Possible errors

Response Fields

Collection Type

Collection Statuses

List NFT Collections

Query parameters

Response

List Collection Transactions

URL parameters

Query parameters

Response Fields

Transaction Types

Transaction Status

Create NFT Collection

Create Substrate NFT Collection

Body fields

Possible errors

Response

Create EVM NFT Collection

Body fields

Possible errors

Response

Transfer Collection

URL parameters

Body fields

Possible errors

Response

Mint Collection NFTs

URL parameters

Body fields

Possible errors

Response Fields

Nest Mint Collection NFTs

URL parameters

Body fields

Possible errors

Response Fields

Burn Collection NFT

URL parameters

Body fields

Possible errors

Response fields