NFT Items

Get NFT by Id

Returns NFT Item by Id

SecurityApiKeyAuth
Request
path Parameters
itemId
required
string (ItemId)

ItemId in format ETHEREUM:${token}:${tokenId}

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/items/{itemId}
Response samples
application/json
{
  • "id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  • "blockchain": "ETHEREUM",
  • "collection": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8",
  • "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
  • "tokenId": 123456,
  • "creators": [ ],
  • "lazySupply": 123456,
  • "pending": [ ],
  • "mintedAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "supply": 123456,
  • "meta": {
    },
  • "deleted": true,
  • "bestSellOrder": {
    },
  • "bestBidOrder": {
    },
  • "bestBidOrdersByCurrency": [
    ],
  • "originOrders": [
    ],
  • "ammOrders": {
    },
  • "auctions": [ ],
  • "totalStock": 123456,
  • "sellers": 0,
  • "lastSale": {
    },
  • "self": true,
  • "suspicious": true,
  • "itemCollection": {
    },
  • "features": [ ],
  • "extra": {
    }
}

Get NFT by Ids

Returns NFT Items by specified list of Ids

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
ids
required
Array of strings (ItemId)

List of the item id

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/v0.1/items/byIds
Request samples
application/json
{
  • "ids": [
    ]
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get NFT royalties by Id

Returns NFT royalties by Id

SecurityApiKeyAuth
Request
path Parameters
itemId
required
string (ItemId)

Item Id in format ETHEREUM:${token}:${tokenId}

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/{itemId}/royalties
Response samples
application/json
{
  • "royalties": [
    ]
}

Reset NFT metadata

Reloads NFT metadata from the source. If source not available, old metadata stays.

SecurityApiKeyAuth
Request
path Parameters
itemId
required
string (ItemId)

Item Id in format ETHEREUM:${token}:${tokenId}

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
query Parameters
sync
boolean

Request meta for Item if true

Responses
200

OK

400

Bad Request

500

Internal Server Error

delete/v0.1/items/{itemId}/resetMeta
Response samples
application/json
{
  • "code": "BAD_REQUEST",
  • "message": "string"
}

Get NFT owned by user

Returns list of NFTs belong to specified user and sorted by last updated date

SecurityApiKeyAuth
Request
query Parameters
blockchains
Array of strings (Blockchain)

Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON), you can use this filter to get Orders only for specific blockchains. Or keep it empty to get Order from all blockchains

Items Enum: "APTOS" "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" "MANTLE" "ARBITRUM" "CHILIZ" "LIGHTLINK" "ZKSYNC" "ASTARZKEVM" "BASE" "RARI" "CELO" "FIEF" "XAI" "KROMA" "ZKLINK" "OASYS" "QUAI" "ECLIPSE" "SAAKURU" "OASIS" "PALM" "MATCH" "FIVIRE" "SEI" "CAMP" "LISK" "MOONBEAM" "ETHERLINK" "ZKCANDY"
Example: blockchains=ETHEREUM
owner
required
string (UnionAddress)

Address of the item owner

Example: owner=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/byOwner
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get NFT created by user

Returns list of NFTs created by specified user and sorted by last updated date

SecurityApiKeyAuth
Request
query Parameters
blockchains
Array of strings (Blockchain)

Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON), you can use this filter to get Orders only for specific blockchains. Or keep it empty to get Order from all blockchains

Items Enum: "APTOS" "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" "MANTLE" "ARBITRUM" "CHILIZ" "LIGHTLINK" "ZKSYNC" "ASTARZKEVM" "BASE" "RARI" "CELO" "FIEF" "XAI" "KROMA" "ZKLINK" "OASYS" "QUAI" "ECLIPSE" "SAAKURU" "OASIS" "PALM" "MATCH" "FIVIRE" "SEI" "CAMP" "LISK" "MOONBEAM" "ETHERLINK" "ZKCANDY"
Example: blockchains=ETHEREUM
creator
required
string (UnionAddress)

Address of the item creator

Example: creator=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/byCreator
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get NFT from collection

Returns list of NFTs from specified collection and sorted by last updated date

SecurityApiKeyAuth
Request
query Parameters
collection
required
string (ContractAddress)

Address of the collection

Example: collection=ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/byCollection
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get NFT owned by user - detailed

Returns list of NFTs belong to specified user and sorted by last updated date of ownership

SecurityApiKeyAuth
Request
query Parameters
owner
required
string (UnionAddress)

Address of the owner

Example: owner=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/byOwnerWithOwnership
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get all NFTsDeprecated

Returns all NFT Items in accordance with specified filters and sorted by last updated date

SecurityApiKeyAuth
Request
query Parameters
blockchains
Array of strings (Blockchain)

Names of the blockchain networks. If no one specified, NFTs from all blockchains will be returned

Items Enum: "APTOS" "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" "MANTLE" "ARBITRUM" "CHILIZ" "LIGHTLINK" "ZKSYNC" "ASTARZKEVM" "BASE" "RARI" "CELO" "FIEF" "XAI" "KROMA" "ZKLINK" "OASYS" "QUAI" "ECLIPSE" "SAAKURU" "OASIS" "PALM" "MATCH" "FIVIRE" "SEI" "CAMP" "LISK" "MOONBEAM" "ETHERLINK" "ZKCANDY"
Example: blockchains=ETHEREUM
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

showDeleted
boolean

Include deleted items

lastUpdatedFrom
integer <int64>

Filter condition to return only items that have been updated after this date (timestamp)

lastUpdatedTo
integer <int64>

Filter condition to return only items that have been updated before this date (timestamp)

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/all
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Get NFT collection traits

Returns aggregation of existing traits for specified collections with counter for each trait type/value.

SecurityApiKeyAuth
Request
query Parameters
keys
Array of strings

Trait keys for strict filtering (if not specified - all traits will be returned)

Example: keys=Hat
collectionIds
required
Array of strings

Collections identifiers to which traits belong

Example: collectionIds=ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/traits
Response samples
application/json
{
  • "continuation": "string",
  • "traits": [ ]
}

Get NFT traits rarity

Returns the rarity of the trait

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
collectionId
required
string
required
Array of objects (TraitProperty)
Responses
200

OK

post/v0.1/items/traits/rarity
Request samples
application/json
{
  • "collectionId": "ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6",
  • "properties": [
    ]
}
Response samples
application/json
{
  • "continuation": "string",
  • "traits": [ ]
}

Get Lazy NFT

Returns Lazy NFT Item by Id

SecurityApiKeyAuth
Request
path Parameters
itemId
required
string (ItemId)

Item Id in format ETHEREUM:${token}:${tokenId}

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/items/lazy/{itemId}
Response samples
application/json
{
  • "@type": "ETH_ERC721",
  • "id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  • "uri": "string",
  • "creators": [
    ],
  • "royalties": [
    ],
  • "signatures": [
    ]
}

Mint Lazy NFT

Create Lazy NFT (supported only for some blockchains)

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
required
(EthLazyItem (EthLazyItemErc721 (object) or EthLazyItemErc1155 (object))) (LazyItem)

Type of an Asset

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/v0.1/items/lazy/mint
Request samples
application/json
{
  • "item": {
    }
}
Response samples
application/json
{
  • "id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  • "blockchain": "ETHEREUM",
  • "collection": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8",
  • "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
  • "tokenId": 123456,
  • "creators": [ ],
  • "lazySupply": 123456,
  • "pending": [ ],
  • "mintedAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "supply": 123456,
  • "meta": {
    },
  • "deleted": true,
  • "bestSellOrder": {
    },
  • "bestBidOrder": {
    },
  • "bestBidOrdersByCurrency": [
    ],
  • "originOrders": [
    ],
  • "ammOrders": {
    },
  • "auctions": [ ],
  • "totalStock": 123456,
  • "sellers": 0,
  • "lastSale": {
    },
  • "self": true,
  • "suspicious": true,
  • "itemCollection": {
    },
  • "features": [ ],
  • "extra": {
    }
}

Burn Lazy NFT

Deletes Lazy NFT (supported only for some blockchains)

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
id
required
string (ItemId)

Item Id, has format ETHEREUM:${token}:${tokenId}

creators
required
Array of strings (UnionAddress)

Address of the NFT item creators

signatures
required
Array of strings

Digital signatures

Responses
204

No Content

400

Bad Request

404

Not Found

500

Internal Server Error

post/v0.1/items/lazy/burn
Request samples
application/json
{
  • "id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  • "creators": [
    ],
  • "signatures": [
    ]
}
Response samples
application/json
{
  • "code": "BAD_REQUEST",
  • "message": "string"
}
➔ Next to NFT Ownerships