item-controller

getItemById

Returns Item by Id

Request
path Parameters
itemId
required
string (ItemId)

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

Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/items/{itemId}
Response samples
application/json
{
  • "id": "ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313",
  • "blockchain": "ETHEREUM",
  • "collection": "ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4",
  • "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": {
    },
  • "originOrders": [
    ],
  • "ammOrders": {
    },
  • "auctions": [ ],
  • "totalStock": 123456,
  • "sellers": 0,
  • "lastSale": {
    },
  • "self": true
}

getItemByIds

Returns Items by Ids

Request
Request Body schema: application/json
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": [ ]
}

getItemRoyaltiesById

Returns item royalty by identifier

Request
path Parameters
itemId
required
string (ItemId)

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

Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
Responses
200

OK

400

Bad Request

500

Internal Server Error

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

resetItemMeta

Deletes the NFT item meta by Id

Request
path Parameters
itemId
required
string (ItemId)

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

Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
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"
}

checkItemRestriction

Check restrictions for specified user and action with item

Request
path Parameters
itemId
required
string (ItemId)

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

Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
Request Body schema: application/json
One of:
@type
string
Value: "OWNERSHIP"
user
required
string (UnionAddress)

Blockchain address in Union format ${blockchainGroup}:${token}

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/items/{itemId}/checkRestriction
Request samples
application/json
{
  • "@type": "OWNERSHIP",
  • "user": "ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string"
}

getItemsByOwner

Returns Item by owner

Request
query Parameters
blockchains
Array of strings (Blockchain)
Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
owner
required
string (UnionAddress)

Address of the item owner

Example: owner=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
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": [ ]
}

getItemsByCreator

Returns Item by creator

Request
query Parameters
blockchains
Array of strings (Blockchain)
Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
creator
required
string (UnionAddress)

Address of the item creator

Example: creator=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
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": [ ]
}

getItemsByCollection

Returns items by collection

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": [ ]
}

getItemsByOwnerWithOwnership

Returns items by owner with ownership

Request
query Parameters
owner
required
string (UnionAddress)

Address of the owner

Example: owner=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
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": [ ]
}

getAllItemsDeprecated

Returns all items

Request
query Parameters
blockchains
Array of strings (Blockchain)

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

Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
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": [ ]
}

queryTraits

Returns possible trait values by key

Request
query Parameters
keys
Array of strings

Trait keys

Example: keys=Color
collectionIds
required
Array of strings

Collections identifiers to which traits belong

Example: collectionIds=ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4
Responses
200

OK

400

Bad Request

500

Internal Server Error

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

searchTraits

Returns combination of Item attribute key with list of values

Request
query Parameters
filter
required
string

filter

Example: filter=Color
collectionIds
required
Array of strings

Collections identifiers to which traits belong

Example: collectionIds=ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4
Responses
200

OK

400

Bad Request

500

Internal Server Error

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

queryTraitsWithRarity

Returns the rarity of the trait

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

OK

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

searchItems

Complex search for items

Request
Request Body schema: application/json
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

continuation
string

Continuation token to paginate items search result

required
object (ItemsSearchFilter)

Filter for items search query

sort
string (ItemsSearchSort)
Enum: "LATEST" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL" "HIGHEST_BID" "LOWEST_BID"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/items/search
Request samples
application/json
{
  • "size": 50,
  • "continuation": "string",
  • "filter": {
    },
  • "sort": "LATEST"
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}