item-controller

getItemById

Returns Item by Id

Request

path Parameters

itemId

required

string (ItemId)

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

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410

Responses

200

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": {"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"genres": ["string"
],
"language": "string",
"rights": "string",
"rightsUri": "string",
"externalUri": "string",
"originalMetaUri": "string",
"attributes": [{"key": "string",
"value": "string",
"type": "string",
"format": "string"
}
],
"content": [{"fileName": "string",
"url": "string",
"representation": "PREVIEW",
"mimeType": "image/png",
"size": 0,
"available": true,
"@type": "IMAGE",
"width": 0,
"height": 0
}
],
"restrictions": ["OWNERSHIP"
]
},
"deleted": true,
"bestSellOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
},
"bestBidOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
},
"originOrders": [{"origin": "string",
"bestSellOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
},
"bestBidOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
}
}
],
"ammOrders": {"ids": ["ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143"
]
},
"auctions": [ ],
"totalStock": 123456,
"sellers": 0,
"lastSale": {"date": "2019-08-24T14:15:22Z",
"seller": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"buyer": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 123456.789,
"currency": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"price": 123456.789
},
"self": true,
"suspicious": 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

400

Bad Request

404

Not Found

500

Internal Server Error

post/v0.1/items/byIds

Request samples

Payload

application/json

{"ids": ["ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410"
]
}

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:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/items/{itemId}/royalties

Response samples

application/json

{"royalties": [{"account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 0
}
]
}

resetItemMeta

Deletes the NFT item meta by Id

Request

path Parameters

itemId

required

string (ItemId)

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

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410

query Parameters

sync	boolean Request meta for Item if true

Responses

200

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:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410

Request Body schema: application/json

One of:

@type	string Value: "OWNERSHIP"
user required	string (UnionAddress) Blockchain address in Union format `${blockchainGroup}:${token}`

Responses

200

400

Bad Request

500

Internal Server Error

post/v0.1/items/{itemId}/checkRestriction

Request samples

Payload

application/json

{"@type": "OWNERSHIP",
"user": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
}

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: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

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: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

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

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: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

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

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=Hat
collectionIds required	Array of strings Collections identifiers to which traits belong Example: collectionIds=ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6

Responses

200

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=Hat
collectionIds required	Array of strings Collections identifiers to which traits belong Example: collectionIds=ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6

Responses

200

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

post/v0.1/items/traits/rarity

Request samples

Payload

application/json

{"collectionId": "ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6",
"properties": [{"key": "Hat",
"value": "Halo"
}
]
}

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

400

Bad Request

500

Internal Server Error

post/v0.1/items/search

Request samples

Payload

application/json

{"size": 10,
"filter": {"blockchains": ["ETHEREUM"
],
"deleted": false,
"sellPriceFrom": 0,
"sellPriceTo": 100,
"sellCurrency": "ETHEREUM:0x0000000000000000000000000000000000000000",
"lastUpdatedAtFrom": "2022-12-01T00:00:00Z",
"lastUpdatedAtTo": "2029-12-01T00:00:00Z"
},
"sort": "EARLIEST"
}

Response samples

application/json

{"total": 0,
"continuation": "string",
"items": [ ]
}

➔ Next to ownership-controller