--- updatedAt: 2025-05-19T21:30:24.000Z agentTools: projectIndex: https://docs.rarible.org/llms.txt --- # Get NFT by Ids Returns NFT Items by specified list of Ids # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "OpenAPI definition", "version": "v0.1", "description": "# Exciting News\n\nHey there, amazing developers! 👋\n\nWe've got some fantastic news to share that will make your experience with our product even better. We're thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let's dive right into the details! ✨\n\n## API-Keys for Enhanced Functionality 🔑\n\nStarting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter `X-API-KEY` in the Header of your request. Simple as that!\n\n## Get Your API-Key in a Snap! ⚡️\n\nSecuring your API-Key is a breeze. We've made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you've done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧\n\n[Get Your API-Key Here](https://api.rarible.org/registration)\n[Configure SDK with API-key](https://github.com/rarible/sdk#api-querying)\n\n## Unlock the Power of the Rarible Protocol 🔓\n\nAs passionate developers, we know you're always hungry for knowledge and eager to explore new frontiers. That's why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you'll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀\n\n[Explore the Rarible Protocol](https://rarible.org)\n\nSo, buckle up and get ready for an enhanced development journey with our API-Keys. We're excited to see what you'll create using our revamped system! 💪🚀\n\nStay curious, keep innovating, and happy coding! ✨\n\n[P.S. Join our Discord Server to stay up to date and ask questions](https://discord.gg/rarifoundation)\n" }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "NFT Items", "x-controller": "ItemController" } ], "servers": [ { "url": "https://{environment}.rarible.org", "description": "Production (Mainnet)", "variables": { "environment": { "enum": [ "api", "testnet-api" ], "default": "api" } } } ], "paths": { "/v0.1/items/byIds": { "post": { "tags": [ "NFT Items" ], "summary": "Get NFT by Ids", "description": "Returns NFT Items by specified list of Ids", "operationId": "getItemByIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "x-default": "11111111-1111-1111-1111-111111111111" } }, "schemas": { "Platform": { "type": "string", "enum": [ "RARIBLE", "OPEN_SEA", "CRYPTO_PUNKS", "IMMUTABLEX", "HEN", "OBJKT", "VERSUM", "TEIA", "OTHER", "FXHASH" ] }, "Blockchain": { "type": "string", "enum": [ "APTOS", "ETHEREUM", "POLYGON", "FLOW", "SOLANA", "IMMUTABLEX", "MANTLE", "ARBITRUM", "CHILIZ", "LIGHTLINK", "ZKSYNC", "ASTARZKEVM", "BASE", "RARI", "CELO", "FIEF", "KROMA", "ZKLINK", "OASYS", "QUAI", "ECLIPSE", "ELECTRONEUM", "SAAKURU", "OASIS", "PALM", "MATCH", "SEI", "LISK", "MOONBEAM", "ETHERLINK", "ZKCANDY", "ALEPHZERO", "BERACHAIN", "ABSTRACT", "SHAPE", "TELOS", "HEDERAEVM", "VICTION", "SETTLUS", "GOAT", "HYPEREVM", "CROSSFI", "MEGAETH", "MEGAETHTESTNET", "MEGAETHTESTNETV2", "BASECAMP", "CAMP", "SOMNIA", "ARENAZ", "INJECTIVE", "INJECTIVETESTNET", "APECHAIN", "BLOCKCHAINKEK", "STELLAR", "ZILLIQA", "FRAXTAL", "MONAD" ], "example": "ETHEREUM" }, "Payout": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "type": "integer" } }, "required": [ "account", "value" ] }, "Meta": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the NFT item" }, "description": { "type": "string", "description": "Description of the NFT item" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" } }, "genres": { "type": "array", "items": { "type": "string" } }, "language": { "description": "Language in RFC 1176 format", "type": "string" }, "rights": { "type": "string" }, "rightsUri": { "type": "string" }, "externalUri": { "description": "URI to external page related to the Item", "type": "string" }, "originalMetaUri": { "description": "URI to the original meta JSON", "type": "string" }, "attributes": { "type": "array", "description": "Attributes of the NFT item", "items": { "$ref": "#/components/schemas/MetaAttribute" } }, "content": { "type": "array", "description": "NFT content information", "items": { "$ref": "#/components/schemas/MetaContent" } }, "extraContent": { "type": "array", "description": "NFT additional content information", "items": { "$ref": "#/components/schemas/MetaContent" } } }, "required": [ "name", "attributes", "content" ] }, "MetaAttribute": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" }, "format": { "type": "string" } } }, "MetaContent": { "type": "object", "properties": { "fileName": { "type": "string" }, "url": { "type": "string" }, "representation": { "type": "string", "enum": [ "PREVIEW", "BIG", "INITIAL", "ORIGINAL", "PORTRAIT" ] }, "mimeType": { "type": "string", "example": "image/png" }, "size": { "type": "integer", "format": "int64" }, "available": { "type": "boolean" } }, "required": [ "url", "representation" ], "oneOf": [ { "$ref": "#/components/schemas/ImageContent" }, { "$ref": "#/components/schemas/VideoContent" }, { "$ref": "#/components/schemas/AudioContent" }, { "$ref": "#/components/schemas/Model3dContent" }, { "$ref": "#/components/schemas/HtmlContent" } ] }, "ImageContent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "IMAGE" ] }, "width": { "type": "integer" }, "height": { "type": "integer" } } }, "VideoContent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "VIDEO" ] }, "width": { "type": "integer" }, "height": { "type": "integer" } } }, "AudioContent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "AUDIO" ] } } }, "Model3dContent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "MODEL_3D" ] } } }, "HtmlContent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "HTML" ] } } }, "ItemId": { "type": "string", "description": "Item Id, has format `ETHEREUM:${token}:${tokenId}`", "example": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410" }, "ItemIds": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "description": "List of the item id", "items": { "$ref": "#/components/schemas/ItemId" } } } }, "Item": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/ItemId" }, "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "creators": { "type": "array", "description": "Creators of the target item", "default": [], "items": { "$ref": "#/components/schemas/Creator" } }, "ownerIfSingle": { "$ref": "#/components/schemas/UnionAddress" }, "ownerChangeDate": { "type": "string", "format": "date-time" }, "lazySupply": { "$ref": "#/components/schemas/BigInteger" }, "pending": { "type": "array", "description": "Pending information about the item", "default": [], "items": { "$ref": "#/components/schemas/ItemTransfer" } }, "mintedAt": { "type": "string", "format": "date-time", "description": "Date and time of the item minting" }, "lastUpdatedAt": { "type": "string", "format": "date-time", "description": "Filter condition to return only items that have been updated at this date" }, "supply": { "$ref": "#/components/schemas/BigInteger" }, "meta": { "$ref": "#/components/schemas/Meta" }, "deleted": { "type": "boolean", "description": "Item was deleted or not" }, "bestSellOrder": { "$ref": "#/components/schemas/Order" }, "bestBidOrder": { "$ref": "#/components/schemas/Order" }, "bestBidOrdersByCurrency": { "type": "array", "description": "Contains best bid order for each currency if exists", "items": { "$ref": "#/components/schemas/Order" } }, "totalStock": { "$ref": "#/components/schemas/BigInteger" }, "sellers": { "type": "integer", "description": "Total count of users selling this item ATM" }, "lastSale": { "$ref": "#/components/schemas/ItemLastSale" }, "self": { "type": "boolean" }, "suspicious": { "type": "boolean" }, "itemCollection": { "$ref": "#/components/schemas/ItemCollection" }, "features": { "type": "array", "default": [], "uniqueItems": true, "items": { "type": "string", "enum": [ "NOT_FOR_SALE" ] } }, "rarity": { "$ref": "#/components/schemas/Rarity" }, "extra": { "type": "object", "description": "Blockchain-specific information about this NFT item particular to that blockchain's data model", "additionalProperties": { "type": "string" } }, "version": { "type": "integer", "format": "int64" } }, "required": [ "id", "blockchain", "creators", "lazySupply", "pending", "mintedAt", "lastUpdatedAt", "supply", "deleted", "sellers" ] }, "ItemCollection": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CollectionId" }, "name": { "type": "string" }, "bestBidOrder": { "$ref": "#/components/schemas/Order" }, "bestSellOrder": { "$ref": "#/components/schemas/Order" } }, "required": [ "id", "name" ] }, "ItemLastSale": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "seller": { "$ref": "#/components/schemas/UnionAddress" }, "buyer": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "$ref": "#/components/schemas/BigDecimal" }, "currency": { "$ref": "#/components/schemas/AssetType" }, "price": { "$ref": "#/components/schemas/BigDecimal" } }, "required": [ "date", "from", "to", "value", "currency", "price" ] }, "Rarity": { "type": "object", "properties": { "score": { "type": "number", "format": "float", "description": "Higher score corresponds to a rarer item" }, "rank": { "type": "integer", "format": "int64", "description": "Item with rank 1 is the rarest" } } }, "Items": { "type": "object", "properties": { "total": { "deprecated": true, "type": "integer", "format": "int64", "description": "Number of items were found by request" }, "continuation": { "type": "string", "description": "Continuation token to paginate items search result" }, "items": { "type": "array", "description": "List of found items", "default": [], "items": { "$ref": "#/components/schemas/Item" } } }, "required": [ "items" ] }, "ItemTransfer": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "TRANSFER" ] }, "from": { "$ref": "#/components/schemas/UnionAddress" } }, "required": [ "@type", "owner", "value", "from" ] }, "Royalty": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "type": "integer" } }, "required": [ "account", "value" ] }, "Creator": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "type": "integer" } }, "required": [ "account", "value" ] }, "OrderId": { "type": "string", "example": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143" }, "Order": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/OrderId" }, "fill": { "$ref": "#/components/schemas/BigDecimal" }, "platform": { "$ref": "#/components/schemas/Platform" }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "startedAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": "string", "format": "date-time" }, "makeStock": { "$ref": "#/components/schemas/BigDecimal" }, "cancelled": { "type": "boolean" }, "optionalRoyalties": { "type": "boolean", "description": "True if the execution of this order does not guarantee that the royalties will be paid. In this case, it is up to the buyer to pay the royalties.", "default": false }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "dbUpdatedAt": { "type": "string", "format": "date-time" }, "makePrice": { "$ref": "#/components/schemas/BigDecimal" }, "takePrice": { "$ref": "#/components/schemas/BigDecimal" }, "makePriceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "takePriceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "maker": { "$ref": "#/components/schemas/UnionAddress" }, "taker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/Asset" }, "take": { "$ref": "#/components/schemas/Asset" }, "salt": { "type": "string" }, "signature": { "type": "string" }, "feeTakers": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/UnionAddress" } }, "data": { "$ref": "#/components/schemas/OrderData" }, "version": { "type": "integer", "format": "int64" } }, "required": [ "id", "platform", "status", "fill", "makeStock", "cancelled", "createdAt", "lastUpdatedAt", "type", "maker", "make", "take", "salt", "data" ] }, "OrderData": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RawOrderData" }, { "$ref": "#/components/schemas/EthOrderDataLegacy" }, { "$ref": "#/components/schemas/EthRaribleV2OrderData" }, { "$ref": "#/components/schemas/EthOrderOpenSeaV1DataV1" }, { "$ref": "#/components/schemas/EthOrderSeaportDataV1" }, { "$ref": "#/components/schemas/EthOrderCryptoPunksData" }, { "$ref": "#/components/schemas/FlowOrderDataV1" }, { "$ref": "#/components/schemas/SolanaAuctionHouseDataV1" }, { "$ref": "#/components/schemas/ImmutablexOrderDataV1" } ] }, "EthRaribleV2OrderData": { "oneOf": [ { "$ref": "#/components/schemas/EthOrderDataRaribleV2DataV1" }, { "$ref": "#/components/schemas/EthOrderDataRaribleV2DataV2" }, { "$ref": "#/components/schemas/EthOrderDataRaribleV2DataV3" }, { "$ref": "#/components/schemas/EthOrderDataRaribleV2DataV3Sell" }, { "$ref": "#/components/schemas/EthOrderDataRaribleV2DataV3Buy" } ] }, "OrderStatus": { "type": "string", "enum": [ "ACTIVE", "FILLED", "INACTIVE", "CANCELLED" ] }, "CollectionId": { "type": "string", "description": "Collection id", "example": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8" }, "UnionApiErrorEntityNotFound": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "enum": [ "NOT_FOUND" ], "default": "NOT_FOUND" }, "message": { "type": "string", "description": "Error message" } } }, "UnionApiErrorBadRequest": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "enum": [ "BAD_REQUEST", "VALIDATION" ], "default": "BAD_REQUEST" }, "message": { "type": "string", "description": "Error message" } } }, "UnionApiErrorServerError": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "enum": [ "UNKNOWN" ], "default": "UNKNOWN" }, "message": { "type": "string", "description": "Error message" } } }, "RawOrderData": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "RAW" ] }, "data": { "$ref": "#/components/schemas/RawJson" } }, "required": [ "@type" ] }, "EthOrderDataLegacy": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V1" ] }, "fee": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "fee", "@type" ] }, "EthOrderDataRaribleV2DataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V2" ] }, "payouts": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } } }, "required": [ "@type", "payouts", "originFees" ] }, "EthOrderDataRaribleV2DataV2": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V2_2" ] }, "payouts": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "isMakeFill": { "type": "boolean", "description": "If true, the 'fill' part of the order applies to the 'make' side, otherwise to the 'take' side" } }, "required": [ "@type", "payouts", "originFees", "isMakeFill" ] }, "EthOrderDataRaribleV2DataV3": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V2_3" ] }, "payouts": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "isMakeFill": { "type": "boolean", "description": "If true, the 'fill' part of the order applies to the 'make' side, otherwise to the 'take' side" } }, "required": [ "@type", "payouts", "originFees", "isMakeFill" ] }, "EthOrderDataRaribleV2DataV3Sell": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V2_DATA_V3_SELL" ] }, "payout": { "$ref": "#/components/schemas/Payout" }, "originFeeFirst": { "$ref": "#/components/schemas/Payout" }, "originFeeSecond": { "$ref": "#/components/schemas/Payout" }, "maxFeesBasePoint": { "type": "integer" }, "marketplaceMarker": { "type": "string" } }, "required": [ "@type", "maxFeesBasePoint" ] }, "EthOrderDataRaribleV2DataV3Buy": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_RARIBLE_V2_DATA_V3_BUY" ] }, "payout": { "$ref": "#/components/schemas/Payout" }, "originFeeFirst": { "$ref": "#/components/schemas/Payout" }, "originFeeSecond": { "$ref": "#/components/schemas/Payout" }, "marketplaceMarker": { "type": "string" } }, "required": [ "@type" ] }, "EthOrderOpenSeaV1DataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_OPEN_SEA_V1" ] }, "exchange": { "$ref": "#/components/schemas/UnionAddress" }, "makerRelayerFee": { "$ref": "#/components/schemas/BigInteger" }, "takerRelayerFee": { "$ref": "#/components/schemas/BigInteger" }, "makerProtocolFee": { "$ref": "#/components/schemas/BigInteger" }, "takerProtocolFee": { "$ref": "#/components/schemas/BigInteger" }, "feeRecipient": { "$ref": "#/components/schemas/UnionAddress" }, "feeMethod": { "type": "string", "enum": [ "PROTOCOL_FEE", "SPLIT_FEE" ] }, "side": { "type": "string", "enum": [ "BUY", "SELL" ] }, "saleKind": { "type": "string", "enum": [ "FIXED_PRICE", "DUTCH_AUCTION" ] }, "howToCall": { "type": "string", "enum": [ "CALL", "DELEGATE_CALL" ] }, "callData": { "type": "string" }, "replacementPattern": { "type": "string" }, "staticTarget": { "$ref": "#/components/schemas/UnionAddress" }, "staticExtraData": { "type": "string" }, "extra": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "@type", "dataType", "exchange", "makerRelayerFee", "takerRelayerFee", "makerProtocolFee", "takerProtocolFee", "feeRecipient", "feeMethod", "side", "saleKind", "howToCall", "callData", "replacementPattern", "staticTarget", "staticExtraData", "extra" ] }, "EthOrderCryptoPunksData": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_CRYPTO_PUNKS" ] }, "stub": { "type": "string", "default": "STUB" } }, "required": [ "@type" ] }, "EthSeaportOrderType": { "type": "string", "enum": [ "FULL_OPEN", "PARTIAL_OPEN", "FULL_RESTRICTED", "PARTIAL_RESTRICTED", "CONTRACT" ] }, "EthSeaportItemType": { "type": "string", "enum": [ "NATIVE", "ERC20", "ERC721", "ERC1155", "ERC721_WITH_CRITERIA", "ERC1155_WITH_CRITERIA" ] }, "EthSeaportOffer": { "type": "object", "properties": { "itemType": { "$ref": "#/components/schemas/EthSeaportItemType" }, "token": { "$ref": "#/components/schemas/UnionAddress" }, "identifierOrCriteria": { "$ref": "#/components/schemas/BigInteger" }, "startAmount": { "$ref": "#/components/schemas/BigInteger" }, "endAmount": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "itemType", "token", "identifierOrCriteria", "startAmount", "endAmount" ] }, "EthSeaportConsideration": { "type": "object", "properties": { "itemType": { "$ref": "#/components/schemas/EthSeaportItemType" }, "token": { "$ref": "#/components/schemas/UnionAddress" }, "identifierOrCriteria": { "$ref": "#/components/schemas/BigInteger" }, "startAmount": { "$ref": "#/components/schemas/BigInteger" }, "endAmount": { "$ref": "#/components/schemas/BigInteger" }, "recipient": { "$ref": "#/components/schemas/UnionAddress" } }, "required": [ "itemType", "token", "identifierOrCriteria", "startAmount", "endAmount", "recipient" ] }, "EthOrderSeaportDataV1": { "type": "object", "properties": { "protocol": { "$ref": "#/components/schemas/UnionAddress" }, "orderType": { "$ref": "#/components/schemas/EthSeaportOrderType" }, "offer": { "type": "array", "items": { "$ref": "#/components/schemas/EthSeaportOffer" } }, "consideration": { "type": "array", "items": { "$ref": "#/components/schemas/EthSeaportConsideration" } }, "zone": { "$ref": "#/components/schemas/UnionAddress" }, "zoneHash": { "type": "string" }, "conduitKey": { "type": "string" }, "counter": { "deprecated": true, "type": "integer", "format": "int64" }, "nonce": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "protocol", "orderType", "offer", "consideration", "zone", "zoneHash", "conduitKey" ], "oneOf": [ { "$ref": "#/components/schemas/EthOrderBasicSeaportDataV1" } ] }, "EthOrderBasicSeaportDataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH_BASIC_SEAPORT_DATA_V1" ] } }, "required": [ "@type" ] }, "Asset": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AssetType" }, "value": { "$ref": "#/components/schemas/BigDecimal" } }, "required": [ "type", "value" ] }, "AssetType": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/NativeCurrencyAssetType" }, { "$ref": "#/components/schemas/TokenCurrencyAssetType" }, { "$ref": "#/components/schemas/NftAssetType" }, { "$ref": "#/components/schemas/NftOfCollectionAssetType" }, { "$ref": "#/components/schemas/FlowAssetTypeNft" }, { "$ref": "#/components/schemas/FlowAssetTypeFt" }, { "$ref": "#/components/schemas/EthEthereumAssetType" }, { "$ref": "#/components/schemas/EthErc20AssetType" }, { "$ref": "#/components/schemas/EthErc721AssetType" }, { "$ref": "#/components/schemas/EthErc721LazyAssetType" }, { "$ref": "#/components/schemas/EthErc1155AssetType" }, { "$ref": "#/components/schemas/EthErc1155LazyAssetType" }, { "$ref": "#/components/schemas/EthCryptoPunksAssetType" }, { "$ref": "#/components/schemas/EthGenerativeArtAssetType" }, { "$ref": "#/components/schemas/EthCollectionAssetType" }, { "$ref": "#/components/schemas/SolanaNftAssetType" }, { "$ref": "#/components/schemas/SolanaFtAssetType" }, { "$ref": "#/components/schemas/SolanaSolAssetType" } ] }, "NativeCurrencyAssetType": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "@type": { "type": "string", "enum": [ "CURRENCY_NATIVE" ] } }, "required": [ "@type", "blockchain" ] }, "TokenCurrencyAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "CURRENCY_TOKEN" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" } }, "required": [ "@type", "contract" ] }, "NftAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "NFT" ] }, "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "standard": { "type": "string", "enum": [ "SINGLE", "MULTIPLE" ] } }, "required": [ "@type", "itemId", "collectionId" ] }, "NftOfCollectionAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "NFT_OF_COLLECTION" ] }, "collectionId": { "$ref": "#/components/schemas/CollectionId" } }, "required": [ "@type", "collectionId" ] }, "FlowAssetTypeNft": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "FLOW_NFT" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "@type", "tokenId", "contract" ] }, "FlowAssetTypeFt": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "FLOW_FT" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" } }, "required": [ "@type", "contract" ] }, "EthEthereumAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETH" ] }, "blockchain": { "$ref": "#/components/schemas/Blockchain" } }, "required": [ "@type" ] }, "EthErc20AssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ERC20" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" } }, "required": [ "@type", "contract" ] }, "EthErc721AssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ERC721" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "@type", "contract", "tokenId" ] }, "EthErc721LazyAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ERC721_Lazy" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "uri": { "type": "string" }, "creators": { "type": "array", "description": "Creators of the target item", "default": [], "items": { "$ref": "#/components/schemas/Creator" } }, "royalties": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Royalty" } }, "signatures": { "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "@type", "contract", "tokenId", "uri", "creators", "royalties", "signatures" ] }, "EthErc1155AssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ERC1155" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" } }, "required": [ "@type", "contract", "tokenId" ] }, "EthErc1155LazyAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ERC1155_Lazy" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "uri": { "type": "string" }, "supply": { "$ref": "#/components/schemas/BigInteger" }, "creators": { "type": "array", "description": "Creators of the target item", "default": [], "items": { "$ref": "#/components/schemas/Creator" } }, "royalties": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Royalty" } }, "signatures": { "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "@type", "contract", "tokenId", "uri", "creators", "supply", "royalties", "signatures" ] }, "EthCryptoPunksAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "CRYPTO_PUNKS" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "type": "integer" } }, "required": [ "@type", "contract", "tokenId" ] }, "EthGenerativeArtAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "GEN_ART" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" } }, "required": [ "@type", "contract" ] }, "EthCollectionAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "COLLECTION" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" } }, "required": [ "@type", "contract" ] }, "SolanaNftAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SOLANA_NFT" ] }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "itemId": { "$ref": "#/components/schemas/ItemId" } }, "required": [ "@type", "itemId" ] }, "SolanaFtAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SOLANA_FT" ] }, "address": { "$ref": "#/components/schemas/ContractAddress" } }, "required": [ "@type", "address" ] }, "SolanaSolAssetType": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SOLANA_SOL" ] } }, "required": [ "@type" ] }, "FlowOrderDataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "FLOW_RARIBLE_V1" ] }, "payouts": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } } }, "required": [ "@type", "payouts", "originFees" ] }, "ImmutablexOrderDataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "IMMUTABLEX_RARIBLE_V1" ] }, "payouts": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Payout" } } }, "required": [ "@type", "payouts", "originFees" ] }, "SolanaAuctionHouseDataV1": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SOLANA_AUCTION_HOUSE_V1" ] }, "fee": { "type": "integer" }, "requiresSignOff": { "type": "boolean" }, "auctionHouse": { "$ref": "#/components/schemas/ContractAddress" } }, "required": [ "@type" ] }, "BigInteger": { "type": "string", "example": 123456 }, "BigDecimal": { "type": "string", "example": 123456.789 }, "RawJson": { "type": "object" }, "ContractAddress": { "type": "string", "description": "Blockchain contract address in Union format `ETHEREUM:${token}`", "example": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430" }, "UnionAddress": { "type": "string", "description": "Blockchain address in Union format `${blockchainGroup}:${token}`", "example": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb" } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnionApiErrorBadRequest" } } } }, "ServerError": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnionApiErrorServerError" } } } }, "EntityNotFound": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnionApiErrorEntityNotFound" } } } } } } } ```