{ "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" }, "servers": [ { "url": "https://{environment}.rarible.org", "description": "Production (Mainnet)", "variables": { "environment": { "enum": [ "api", "testnet-api" ], "default": "api" } } } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Search API", "x-controller": "SearchController" }, { "name": "NFT Items", "x-controller": "ItemController" }, { "name": "NFT Ownerships", "x-controller": "OwnershipController" }, { "name": "NFT Sales", "x-controller": "OrderController" }, { "name": "NFT Activities", "x-controller": "ActivityController" }, { "name": "NFT Collections", "x-controller": "CollectionController" }, { "name": "Collection Leader Board", "x-controller": "CollectionLeaderboardController" }, { "name": "Collection Statistics", "x-controller": "CollectionStatisticsController" }, { "name": "Charts", "x-controller": "ChartController" }, { "name": "NFT Data and Historical Statistics", "x-controller": "DataController" }, { "name": "Domain lookup", "x-controller": "DomainController" }, { "name": "Signature operations", "x-controller": "SignatureController" }, { "name": "Encode operations", "x-controller": "EncodeController" }, { "name": "Currencies and rates", "x-controller": "CurrencyController" }, { "name": "User balances", "x-controller": "BalanceController" }, { "name": "Indexer blocks", "x-controller": "BlockController" }, { "name": "Reconciliation", "x-controller": "ReconciliationController" } ], "paths": { "/v0.1/items/{itemId}": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT by Id", "description": "Returns NFT Item by Id", "operationId": "getItemById", "parameters": [ { "name": "itemId", "in": "path", "required": true, "description": "ItemId in format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/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" } } } }, "/v0.1/items/{itemId}/royalties": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT royalties by Id", "description": "Returns NFT royalties by Id", "operationId": "getItemRoyaltiesById", "parameters": [ { "name": "itemId", "in": "path", "required": true, "description": "Item Id in format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Royalties" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/{itemId}/resetMeta": { "delete": { "tags": [ "NFT Items" ], "summary": "Reset NFT metadata", "description": "Reloads NFT metadata from the source. If source not available, old metadata stays.", "operationId": "resetItemMeta", "parameters": [ { "name": "itemId", "in": "path", "required": true, "description": "Item Id in format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } }, { "name": "sync", "in": "query", "required": false, "description": "Request meta for Item if true", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/byOwner": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT owned by user", "description": "Returns list of NFTs belong to specified user and sorted by `last updated` date", "operationId": "getItemsByOwner", "parameters": [ { "name": "blockchains", "description": "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", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "owner", "in": "query", "required": true, "description": "Address of the item owner", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/byCreator": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT created by user", "description": "Returns list of NFTs created by specified user and sorted by `last updated` date", "operationId": "getItemsByCreator", "parameters": [ { "name": "blockchains", "description": "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", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "creator", "in": "query", "required": true, "description": "Address of the item creator", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/byCollection": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT from collection", "description": "Returns list of NFTs from specified collection and sorted by `last updated` date", "operationId": "getItemsByCollection", "parameters": [ { "name": "collection", "in": "query", "required": true, "description": "Address of the collection", "schema": { "$ref": "#/components/schemas/ContractAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/byOwnerWithOwnership": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT owned by user - detailed", "description": "Returns list of NFTs belong to specified user and sorted by `last updated` date of ownership", "operationId": "getItemsByOwnerWithOwnership", "parameters": [ { "name": "owner", "in": "query", "required": true, "description": "Address of the owner", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsWithOwnership" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/all": { "get": { "deprecated": true, "tags": [ "NFT Items" ], "summary": "Get all NFTs", "description": "Returns all NFT Items in accordance with specified filters and sorted by `last updated` date", "operationId": "getAllItems", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "Names of the blockchain networks. If no one specified, NFTs from all blockchains will be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "showDeleted", "in": "query", "required": false, "description": "Include deleted items", "schema": { "type": "boolean" } }, { "name": "lastUpdatedFrom", "in": "query", "required": false, "description": "Filter condition to return only items that have been updated after this date (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "lastUpdatedTo", "in": "query", "required": false, "description": "Filter condition to return only items that have been updated before this date (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/traits": { "get": { "tags": [ "NFT Items" ], "summary": "Get NFT collection traits", "description": "Returns aggregation of existing traits for specified collections with counter for each trait type/value.", "operationId": "queryTraits", "parameters": [ { "name": "keys", "description": "Trait keys for strict filtering (if not specified - all traits will be returned)", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "Hat" } } }, { "name": "collectionIds", "description": "Collections identifiers to which traits belong", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6" } } }, { "name": "owners", "description": "Return traits only for items owned by user", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "${filterOwners}" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Traits" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/traits/search": { "get": { "tags": [ "Search API" ], "summary": "Search NFT collection traits", "description": "Returns aggregation of existing traits for specified collections with counter for each trait type/value.\\ This is full-text-search, where you can specify filter for trait keys not precisely\\ (for example, results `back` filter include `Background` trait)", "operationId": "searchTraits", "parameters": [ { "name": "filter", "description": "filter", "in": "query", "required": true, "schema": { "type": "string", "example": "Hat" } }, { "name": "collectionIds", "description": "Collections identifiers to which traits belong", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6" } } }, { "name": "owners", "description": "Return traits only for items owned by user", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "${filterOwners}" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Traits" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/traits/rarity": { "post": { "tags": [ "NFT Items" ], "summary": "Get NFT traits rarity", "description": "Returns the rarity of the trait", "operationId": "queryTraitsWithRarity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraitsRarityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedTraitProperties" } } } } } } }, "/v0.1/items/search": { "post": { "tags": [ "Search API" ], "summary": "Search NFTs", "description": "Advanced search returns NFTs satisfying provided filter", "operationId": "searchItems", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsSearchRequest" }, "example": { "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" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/search/duplicates": { "post": { "tags": [ "Search API" ], "summary": "Search Duplicated NFTs", "description": "Advanced search returns NFTs satisfying provided filter and with duplicated traits", "operationId": "searchDuplicatedItems", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicatedItemsSearchRequest" }, "example": { "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" }, "traits": [ "series" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicatedItemGroups" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/lazy/{itemId}": { "get": { "tags": [ "NFT Items" ], "summary": "Get Lazy NFT", "description": "Returns Lazy NFT Item by Id", "operationId": "getLazyItemById", "deprecated": true, "parameters": [ { "name": "itemId", "in": "path", "required": true, "description": "Item Id in format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LazyItem" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/lazy/mint": { "post": { "tags": [ "NFT Items" ], "summary": "Mint Lazy NFT", "description": "Create Lazy NFT (supported only for some blockchains)", "operationId": "mintLazyItem", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LazyItemMintForm" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/items/lazy/burn": { "post": { "tags": [ "NFT Items" ], "summary": "Burn Lazy NFT", "description": "Deletes Lazy NFT (supported only for some blockchains)", "operationId": "burnLazyItem", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LazyItemBurnForm" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/{ownershipId}": { "get": { "tags": [ "NFT Ownerships" ], "summary": "Get NFT Ownership by Id", "description": "Returns Ownership by Id", "operationId": "getOwnershipById", "parameters": [ { "name": "ownershipId", "in": "path", "required": true, "description": "Ownership Id in format: 'ETHEREUM:${token}:${tokenId}:${owner}'", "schema": { "$ref": "#/components/schemas/OwnershipId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ownership" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/byIds": { "post": { "tags": [ "NFT Ownerships" ], "summary": "Get NFT Ownerships by Ids", "description": "Returns Ownerships by specified list of Ids", "operationId": "getOwnershipsByIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ownerships" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/byCollection": { "get": { "tags": [ "NFT Ownerships" ], "summary": "Get NFT Collection's Ownerships", "description": "Returns list of NFTs Ownerships from specified collection and sorted by `last updated` date", "operationId": "getOwnershipsByCollection", "parameters": [ { "name": "collection", "in": "query", "required": true, "description": "Address of the collection", "schema": { "$ref": "#/components/schemas/ContractAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ownerships" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/byItem": { "get": { "tags": [ "NFT Ownerships" ], "summary": "Get NFTs Ownerships", "description": "Returns list of NFTs Ownerships for specified NFT and sorted by `last updated` date", "operationId": "getOwnershipsByItem", "parameters": [ { "name": "itemId", "in": "query", "required": true, "description": "Item Id, has format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ownerships" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/search": { "post": { "tags": [ "Search API" ], "summary": "Search NFT Ownerships", "description": "Advanced search returns NFT Ownerships satisfying provided filter", "operationId": "searchOwnerships", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipSearchRequest" }, "example": { "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" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ownerships" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/ownerships/collections": { "get": { "tags": [ "NFT Ownerships" ], "summary": "Get collections owned items by owner", "description": "Returns list of collection with owned items by specified owner", "operationId": "getCollectionsWithOwnedItems", "parameters": [ { "name": "owners", "in": "query", "required": true, "description": "Addresses of the owner", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "blockchains", "description": "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", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionsWithOwnedItems" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/{id}": { "get": { "tags": [ "NFT Sales" ], "summary": "Get Order", "description": "Returns Order by Id", "operationId": "getOrderById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order Id, has format 'ETHEREUM:${id}'", "schema": { "$ref": "#/components/schemas/OrderId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/{id}/prepareTx": { "post": { "tags": [ "NFT Sales" ], "summary": "Prepare order transaction", "description": "Prepare all required data to match given order on the blockchain", "operationId": "prepareOrderTransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order Id, has format 'ETHEREUM:${id}'", "schema": { "$ref": "#/components/schemas/OrderId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareOrderTxForm" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareOrderTxResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/{id}/prepareCancelTx": { "post": { "tags": [ "NFT Sales" ], "summary": "Prepare order cancel transaction", "description": "Prepare all required data to cancel given order on the blockchain", "operationId": "prepareOrderCancelTransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order Id, has format 'ETHEREUM:${id}'", "schema": { "$ref": "#/components/schemas/OrderId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreparedOrderTx" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/{id}/report": { "post": { "tags": [ "NFT Sales" ], "summary": "Report Order", "description": "Report Error Order", "operationId": "reportOrderById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order Id, has format 'ETHEREUM:${id}'", "schema": { "$ref": "#/components/schemas/OrderId" } } ], "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders": { "post": { "tags": [ "NFT Sales" ], "summary": "Create or update Order", "description": "Create or update off-chain Order (supported only for some blockchains)", "operationId": "upsertOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderForm" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/{id}/validate": { "get": { "tags": [ "NFT Sales" ], "summary": "Get validated Order by Id", "description": "Validates and returns order by Id. IMPORTANT - validation is time-consuming operation!", "operationId": "getValidatedOrderById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order Id, has format 'ETHEREUM:${id}'", "schema": { "$ref": "#/components/schemas/OrderId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/byIds": { "post": { "tags": [ "NFT Sales" ], "summary": "Get Orders by Ids", "description": "Returns Orders by specified list of Ids", "operationId": "getOrdersByIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/all": { "get": { "tags": [ "NFT Sales" ], "summary": "Get all Orders", "description": "Returns all Orders in accordance with specified filters and sorted by `last updated` date", "operationId": "getOrdersAll", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "Type of the blockchain network", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of orders to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Order sort", "schema": { "$ref": "#/components/schemas/OrderSort" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/sync": { "get": { "tags": [ "NFT Sales" ], "summary": "Get all Orders (for sync)", "description": "Returns all sales & transfers in accordance with specified filters and sorted by `db updated` date. During internal updates (like migrations) Orders can be updated for technical reasons. In such case, `last update` date won't be changed. If you want to store Orders in your own storage and keep it synced, use this method.", "operationId": "getAllSync", "parameters": [ { "name": "blockchain", "in": "query", "required": true, "description": "Type of the blockchain network", "schema": { "$ref": "#/components/schemas/Blockchain" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of orders to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Order sort", "schema": { "$ref": "#/components/schemas/SyncSort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/sell/byMaker": { "get": { "tags": [ "NFT Sales" ], "summary": "Get user's sell Orders", "description": "Returns sell NFT Sales created by specified user and sorted by `last update` date", "operationId": "getSellOrdersByMaker", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "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", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "maker", "in": "query", "required": true, "description": "The maker of the order", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "collection", "in": "query", "required": false, "description": "The nft collection of order", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionId" } } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/sell/byItem": { "get": { "tags": [ "NFT Sales" ], "summary": "Get sell Orders for NFT", "description": "Returns sell sales & transfer created for specified NFT and sorted by price in USD (cheapest first)", "operationId": "getSellOrdersByItem", "parameters": [ { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "itemId", "in": "query", "required": true, "description": "Item Id, has format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } }, { "name": "maker", "in": "query", "required": false, "description": "The maker of the bid", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/sell": { "get": { "tags": [ "NFT Sales" ], "summary": "Get sell Orders", "description": "Returns sell Orders satisfying specified filters and sorted by `last update` date", "operationId": "getSellOrders", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "Names of the blockchain networks. If no one specified, data from all blockchains will be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/bids/byMaker": { "get": { "tags": [ "NFT Sales" ], "summary": "Get user's bid Orders", "description": "Returns bid Orders created by specified user and sorted by `last update` date", "operationId": "getOrderBidsByMaker", "parameters": [ { "name": "maker", "in": "query", "required": true, "description": "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", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "blockchains", "in": "query", "required": false, "description": "Names of the blockchain networks. If no one specified, data from all blockchains will be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "collection", "in": "query", "required": false, "description": "The nft collection of order", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionId" } } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "currencies", "in": "query", "required": false, "description": "Currencies for bids", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "start", "in": "query", "required": false, "description": "Lower time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "end", "in": "query", "required": false, "description": "Upper time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/bids/byItem": { "get": { "tags": [ "NFT Sales" ], "summary": "Get bid Orders for NFT", "description": "Returns bid Orders created for specified NFT and sorted by price in USD (expensive first)", "operationId": "getOrderBidsByItem", "parameters": [ { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "itemId", "in": "query", "required": true, "description": "Item Id, has format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } }, { "name": "maker", "in": "query", "required": false, "description": "The maker of the bid", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "currencies", "in": "query", "required": false, "description": "Currencies for bids", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "start", "in": "query", "required": false, "description": "Lower time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "end", "in": "query", "required": false, "description": "Upper time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "searchEngine", "in": "query", "required": false, "deprecated": true, "description": "Search engine to use for search", "schema": { "$ref": "#/components/schemas/SearchEngine" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/floorBids/byCollection": { "get": { "tags": [ "NFT Sales" ], "summary": "Get floor bids for Collection", "description": "Returns floor bids created for specified NFT Collection and sorted by price in USD (expensive first)", "operationId": "getOrderFloorBidsByCollection", "parameters": [ { "name": "platform", "in": "query", "required": false, "description": "The platform where the order was created", "schema": { "$ref": "#/components/schemas/Platform" } }, { "name": "collectionId", "in": "query", "required": true, "description": "Collection Id, has format `ETHEREUM:${token}`", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "origin", "in": "query", "required": false, "description": "Address of the consumer to receive the commission for the order", "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } }, { "name": "currencies", "in": "query", "required": false, "description": "Currencies for bids", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "start", "in": "query", "required": false, "description": "Lower time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "end", "in": "query", "required": false, "description": "Upper time border of data (timestamp)", "schema": { "type": "integer", "format": "int64" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/orders/settings/fees": { "get": { "tags": [ "NFT Sales" ], "summary": "Get fee settings", "description": "Returns Protocol fee settings for Orders", "operationId": "getOrderFees", "parameters": [ { "name": "blockchain", "in": "query", "required": false, "description": "Type of the blockchain network", "schema": { "$ref": "#/components/schemas/Blockchain" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderFees" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/byUser": { "get": { "tags": [ "NFT Activities" ], "summary": "Get user Activities", "description": "Returns user's Activities (like transfers, mints, sells etc) sorted by date. This API is deprecated in favor of `Search Activities`", "deprecated": true, "operationId": "getActivitiesByUser", "parameters": [ { "name": "type", "in": "query", "required": true, "description": "Activity type", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserActivityType" } } }, { "name": "blockchains", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "user", "in": "query", "required": true, "description": "Addresses of the users", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "bidCurrencies", "in": "query", "required": false, "description": "Currency for BID and CANCEL_BID activity types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "from", "in": "query", "required": false, "description": "Lower time border of data", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "description": "Upper time border of data", "schema": { "type": "string", "format": "date-time" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Combined continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Sorting by data update time", "schema": { "$ref": "#/components/schemas/ActivitySort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/byUsers": { "post": { "tags": [ "NFT Activities" ], "summary": "Get users Activities", "description": "Returns users Activities (like transfers, mints, sells etc) sorted by date. This API is deprecated in favor of `Search Activities`", "deprecated": true, "operationId": "getActivitiesByUsers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivitiesByUsersRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/byItem": { "get": { "tags": [ "NFT Activities" ], "summary": "Get NFT Activities", "description": "Returns Activities related to specified NFT and sorted by date. This API is deprecated in favor of `Search Activities`", "deprecated": true, "operationId": "getActivitiesByItem", "parameters": [ { "name": "type", "in": "query", "required": true, "description": "Activity type", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } } }, { "name": "itemId", "in": "query", "required": true, "description": "Item Id, has format `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/ItemId" } }, { "name": "bidCurrencies", "in": "query", "required": false, "description": "Currency for BID and CANCEL_BID activity types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Combined continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Sorting by data update time", "schema": { "$ref": "#/components/schemas/ActivitySort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/byCollection": { "get": { "tags": [ "NFT Activities" ], "summary": "Get NFT Collection Activities", "description": "Returns Activities related to NFTs from specified Collection and sorted by date. This API is deprecated in favor of `Search Activities`", "deprecated": true, "operationId": "getActivitiesByCollection", "parameters": [ { "name": "type", "in": "query", "required": true, "description": "Activity type", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } } }, { "name": "collection", "in": "query", "required": true, "description": "Address of the collection", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractAddress" } } }, { "name": "bidCurrencies", "in": "query", "required": false, "description": "Currency for BID and CANCEL_BID activity types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Combined continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Sorting by data update time", "schema": { "$ref": "#/components/schemas/ActivitySort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/sync": { "get": { "tags": [ "NFT Activities" ], "summary": "Get all Activities (for sync)", "description": "Returns all Activities in accordance with specified filters and sorted by `db updated` date. During internal updates (like migrations) Activities can be updated for technical reasons. In such case, `date` field won't be changed. If you want to store Activities in your own storage and keep it synced, use this method.", "operationId": "getAllActivitiesSync", "parameters": [ { "name": "blockchain", "in": "query", "required": true, "description": "Type of the blockchain network", "schema": { "$ref": "#/components/schemas/Blockchain" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Sorting by data base update time", "schema": { "$ref": "#/components/schemas/SyncSort" } }, { "name": "type", "in": "query", "required": false, "description": "Filtering by activity type", "schema": { "$ref": "#/components/schemas/SyncType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/all": { "get": { "tags": [ "NFT Activities" ], "summary": "Get all Activities", "description": "Returns all Activities in accordance with specified filters and sorted by date. This API is deprecated in favor of `Search Activities`", "deprecated": true, "operationId": "getAllActivities", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "Names of the blockchain networks. If no one specified, data from all blockchains will be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "type", "in": "query", "required": true, "description": "Activity type", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } } }, { "name": "bidCurrencies", "in": "query", "required": false, "description": "Currency for BID and CANCEL_BID activity types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Combined continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "required": false, "description": "Sorting by data update time", "schema": { "$ref": "#/components/schemas/ActivitySort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/{id}/charts/sales": { "get": { "tags": [ "NFT Activities" ], "summary": "Get sales chart", "description": "Returns list of sales by collection", "operationId": "getSalesChart", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Collection ID", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "from", "in": "query", "required": false, "description": "Time period from", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "description": "Time period to", "schema": { "type": "string", "format": "date-time" } }, { "name": "size", "in": "query", "required": false, "description": "Number of data points to return", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor from previous response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChart" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/activities/search": { "post": { "tags": [ "Search API" ], "summary": "Search Activities", "description": "Advanced search returns Activities satisfying provided filter", "operationId": "searchActivities", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivitySearchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/{collection}": { "get": { "tags": [ "NFT Collections" ], "summary": "Get NFT Collection by Id", "description": "Returns NFT Collection by Id", "operationId": "getCollectionById", "parameters": [ { "name": "collection", "in": "path", "required": true, "description": "Address of the collection", "schema": { "$ref": "#/components/schemas/ContractAddress" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collection" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/{collection}/generateTokenId": { "get": { "tags": [ "NFT Collections" ], "summary": "Generate TokenId", "description": "Returns next available TokenId for specified minter", "operationId": "generateTokenId", "parameters": [ { "name": "collection", "in": "path", "description": "Address of the NFT collection", "required": true, "schema": { "$ref": "#/components/schemas/ContractAddress" } }, { "name": "minter", "in": "query", "description": "Minter address", "required": true, "schema": { "$ref": "#/components/schemas/UnionAddress" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionTokenId" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/{collection}/refreshMeta": { "delete": { "tags": [ "NFT Collections" ], "summary": "Reset NFT metadata", "description": "Reloads metadata for all NFTs in the Collection (see 'Reset NFT metadata' API)", "operationId": "refreshCollectionItemsMeta", "parameters": [ { "name": "collection", "in": "path", "required": true, "description": "Address of the collection", "schema": { "$ref": "#/components/schemas/CollectionId" } } ], "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/{collection}/resetMeta": { "delete": { "tags": [ "NFT Collections" ], "summary": "Reset Collection metadata", "description": "Reloads metadata for Collection (NOT for collection's NFTs)", "operationId": "resetCollectionMeta", "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CollectionId" } } ], "responses": { "200": { "description": "OK" }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/byOwner": { "get": { "tags": [ "NFT Collections" ], "summary": "Get NFT Collections owned by user", "description": "Returns list of NFT Collections belong to specified user", "operationId": "getCollectionsByOwner", "parameters": [ { "name": "blockchains", "description": "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", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "owner", "in": "query", "description": "Owner of searching collections", "required": true, "schema": { "$ref": "#/components/schemas/UnionAddress" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collections" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/all": { "get": { "tags": [ "NFT Collections" ], "summary": "Get all NFT Collections", "description": "Returns all NFT Collections in accordance with specified filters", "operationId": "getAllCollections", "parameters": [ { "name": "blockchains", "in": "query", "required": false, "description": "Names of the blockchain networks. If no one specified, data from all blockchains will be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of items to return", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collections" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/collections/search": { "post": { "tags": [ "Search API" ], "summary": "Search NFT Collections", "description": "Advanced search returns NFT Collections satisfying provided filter", "operationId": "searchCollection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionsSearchRequest" }, "example": { "size": 10, "filter": { "blockchains": [ "ETHEREUM" ], "text": "Apes" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collections" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/data/rankings/{entity}/volume": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get user volume", "description": "Users (top buyers/sellers) leaderboard. Calculated as traded worth for the period.", "operationId": "getUserRankingByVolume", "parameters": [ { "name": "entity", "in": "path", "description": "Type of users in leaderboard", "required": true, "schema": { "$ref": "#/components/schemas/OlapUserType" } }, { "name": "blockchain", "in": "query", "description": "Blockchain", "required": false, "schema": { "$ref": "#/components/schemas/OlapBlockchain" } }, { "name": "source", "in": "query", "description": "Source", "required": false, "schema": { "$ref": "#/components/schemas/OlapPlatformSource" } }, { "name": "period", "in": "query", "description": "Time period of leaderboard. Default: D7", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardPeriod" } }, { "name": "limit", "in": "query", "description": "Limit of records in leaderboard", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapUserVolumeRankingResponse" }, "example": { "result": [ { "id": "ETHEREUM:0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85", "items": 178, "transactions": 11, "volumeUsd": { "currency": "USD", "value": 1000 }, "volumeNative": { "currency": "ETH", "value": 0.75 } } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/rankings/collections/volume": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collections volume", "description": "Collections leaderboard by trade activity", "operationId": "getCollectionRankingByVolume", "parameters": [ { "name": "source", "in": "query", "description": "Group of platform used for volume calculation and collection ranging.", "required": false, "schema": { "$ref": "#/components/schemas/OlapTradesLeaderboardSourceGroup" } }, { "name": "blockchain", "in": "query", "description": "Blockchain", "required": false, "schema": { "$ref": "#/components/schemas/OlapBlockchain" } }, { "name": "ids", "in": "query", "description": "Collection ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "period", "in": "query", "description": "Time period for aggregation", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardPeriod" } }, { "name": "minFloorPriceNative", "in": "query", "description": "Show collections which floor price (native currency) more or equal than specified value", "required": false, "schema": { "type": "number", "format": "bigdecimal" } }, { "name": "maxFloorPriceNative", "in": "query", "description": "Show collections which floor price (native currency) less or equal than specified value", "required": false, "schema": { "type": "number", "format": "bigdecimal" } }, { "name": "sort", "in": "query", "description": "Collections sorting", "required": false, "schema": { "$ref": "#/components/schemas/OlapTradesLeaderboardSort" } }, { "name": "limit", "in": "query", "description": "Limit of records in leaderboard", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "continuation", "in": "query", "description": "Page reference. Taken from previous response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapCollectionVolumeRankingResponse" }, "example": { "continuation": "45325.07_ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d", "result": [ { "id": "ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d", "volumeUsd": { "currency": "USD", "value": 45325.07, "changePercent": -51.196335 }, "volumeNative": { "currency": "ETH", "value": 23.95 }, "itemsBought": 1, "floorPrice": { "currency": "ETH", "value": 24, "changePercent": -13.5332 }, "listed": 33, "totalItemSupply": 250, "ownersCount": 187 } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/leaderboard/collections": { "get": { "tags": [ "Collection Leader Board" ], "summary": "Get NFT Collections leaderboard", "description": "Collections leaderboard", "operationId": "getCollectionLeaderboard", "parameters": [ { "name": "blockchains", "in": "query", "description": "Blockchain networks", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OlapBlockchain" } } }, { "name": "period", "in": "query", "description": "Time period for aggregation", "required": false, "schema": { "$ref": "#/components/schemas/OlapPeriod" } }, { "name": "sort", "in": "query", "description": "Collections sorting", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardSort" } }, { "name": "direction", "in": "query", "description": "Collections sorting direction", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardSortDirection" } }, { "name": "limit", "in": "query", "description": "Limit of records in leaderboard", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "description": "Offset reference", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapCollectionLeaderboardResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/leaderboard/collections/byOwner": { "get": { "tags": [ "Collection Leader Board" ], "summary": "Get NFT Collections leaderboard for a specific owner adresses", "description": "User collections leaderboard", "operationId": "getCollectionLeaderboardByOwner", "parameters": [ { "name": "owners", "in": "query", "required": true, "description": "Addresses of the owner", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } }, { "name": "blockchains", "in": "query", "description": "Blockchain networks", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OlapBlockchain" } } }, { "name": "period", "in": "query", "description": "Time period for aggregation", "required": false, "schema": { "$ref": "#/components/schemas/OlapPeriod" } }, { "name": "sort", "in": "query", "description": "Collections sorting", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardSort" } }, { "name": "direction", "in": "query", "description": "Collections sorting direction", "required": false, "schema": { "$ref": "#/components/schemas/OlapLeaderboardSortDirection" } }, { "name": "limit", "in": "query", "description": "Limit of records in leaderboard", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapCollectionLeaderboardResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/statistics/global": { "get": { "tags": [ "Collection Statistics" ], "summary": "Get global (period-independent) statistics by collection ID", "description": "Global collection statistics by ID", "operationId": "getGlobalCollectionStatistics", "parameters": [ { "name": "id", "in": "path", "description": "Collection ID", "required": true, "schema": { "$ref": "#/components/schemas/CollectionId" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapGlobalCollectionStatisticsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/statistics/global/byIds": { "post": { "tags": [ "Collection Statistics" ], "summary": "Get global (period-independent) statistics by collection IDs", "description": "Global collection statistics by IDs", "operationId": "getGlobalCollectionStatisticsByIds", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/CollectionId" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OlapGlobalCollectionStatisticsResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/statistics/period": { "get": { "tags": [ "Collection Statistics" ], "summary": "Get period-based statistics by collection ID", "description": "Period-based collection statistics by ID", "operationId": "getPeriodCollectionStatistics", "parameters": [ { "name": "id", "in": "path", "description": "Collection ID", "required": true, "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "period", "in": "query", "description": "Time period for aggregation", "required": true, "schema": { "$ref": "#/components/schemas/OlapPeriod" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapPeriodCollectionStatisticsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/statistics/period/byIds": { "post": { "tags": [ "Collection Statistics" ], "summary": "Get period-based statistics by collection IDs", "description": "Period-based collection statistics by IDs", "operationId": "getPeriodCollectionStatisticsByIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapPeriodCollectionsByIdsStatisticsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OlapPeriodCollectionStatisticsResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/owners": { "get": { "tags": [ "Collection Statistics" ], "summary": "Get distribution of the number of owned items by owner", "description": "Returns list of owners of items in the collection along with the number of owned items", "operationId": "getOwners", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Collection ID", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of results to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapOwnerStatistics" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/bidsByPrice": { "get": { "tags": [ "Collection Statistics" ], "summary": "Get distribution of the number of bids by price", "description": "Returns list of bid prices with number of bids and bidders", "operationId": "getBidsByPrice", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Collection ID", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "continuation", "in": "query", "required": false, "description": "Continuation token from the previous response", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The number of results to return", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Result sorting", "schema": { "$ref": "#/components/schemas/OlapBidsByPriceSort" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapBidsByPriceStatistics" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/charts/floorPrice": { "get": { "tags": [ "Charts" ], "summary": "Get historical data of floor price for collection for charting purposes", "description": "Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc. Each points represents the aggregated value of the interval after it. The last point represents the current floor price.", "operationId": "getFloorPriceChart", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Collection ID", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "period", "in": "query", "required": true, "description": "Time period for aggregation", "schema": { "$ref": "#/components/schemas/OlapPeriod" } }, { "name": "size", "in": "query", "required": true, "description": "Number of data points to return", "schema": { "type": "integer" } }, { "name": "endTime", "in": "query", "required": false, "description": "Optionally, the date-time of the last point of the graph. Defaults to current time.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapChartResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v2.0/data/collections/{id}/charts/volume": { "get": { "tags": [ "Charts" ], "summary": "Get historical data of collection volume (total sales worth) for charting purposes", "description": "Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point. The last point always has no value.", "operationId": "getVolumeChart", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Collection ID", "schema": { "$ref": "#/components/schemas/CollectionId" } }, { "name": "period", "in": "query", "required": true, "description": "Time period for aggregation", "schema": { "$ref": "#/components/schemas/OlapPeriod" } }, { "name": "size", "in": "query", "required": true, "description": "Number of data points to return", "schema": { "type": "integer" } }, { "name": "endTime", "in": "query", "required": false, "description": "Optionally, the date-time of the last point of the graph. Defaults to current time.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapChartResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/transactions": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection tx stats", "description": "Get historical statistics about Collection transactions", "operationId": "getTransactions", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filters of statistics", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-05", "2022-05-06", "2022-05-07" ], "historicalValues": [ 3602, 2566, 285 ], "currentValue": 260 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/stats": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection stats", "description": "Get general statistics about Collection", "operationId": "getCollectionStats", "deprecated": true, "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of statistics", "required": false, "schema": { "$ref": "#/components/schemas/OlapCurrencyType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapGeneralStatsResponse" }, "example": { "highestSale": 43.71, "floorPrice": 1.45, "marketCap": 14529, "items": 10020, "owners": 6472, "volume": 41913.50477591493 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/statistics": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection statistics", "description": "Get statistics about a collection", "operationId": "getCollectionStatistics", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapCollectionStatisticsResponse" }, "example": { "listed": 5, "items": 10020, "owners": 6472, "highestSale": [ { "currency": "USD", "value": 37.66 }, { "currency": "ETH", "value": 0.009 } ], "floorPrice": [ { "currency": "USD", "value": 2635 }, { "currency": "ETH", "value": 1 } ], "marketCap": [ { "currency": "USD", "value": 12195397 }, { "currency": "ETH", "value": 4627 } ], "volume": [ { "currency": "USD", "value": 37.66 }, { "currency": "ETH", "value": 0.009 } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/sellers": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection seller stats", "description": "Get historical statistics about Collection sellers", "operationId": "getSellers", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filters of statistics", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-05", "2022-05-06", "2022-05-07" ], "historicalValues": [ 2744, 5487, 895 ], "currentValue": 1767 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/gmv": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collections GVM", "description": "Get historical statistics about Collection gross merchandise value", "operationId": "getGmv", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of statistics", "required": false, "schema": { "$ref": "#/components/schemas/OlapCurrencyType" } }, { "name": "period", "in": "query", "description": "Time period of statistics. Default: D1", "required": false, "schema": { "$ref": "#/components/schemas/OlapPeriod" } }, { "name": "filters", "in": "query", "description": "Filters of statistics", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-05", "2022-05-06", "2022-05-07" ], "historicalValues": [ 10934.527094503102, 7876.5886882554005, 1164.1458323599143 ], "currentValue": 498.19370351666873 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/floorPrice": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection floor price", "description": "Get historical statistics about Collection's NFT floor price", "operationId": "getFloorPrice", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of statistics", "required": false, "schema": { "$ref": "#/components/schemas/OlapCurrencyType" } }, { "name": "filters", "in": "query", "description": "Filters of statistics", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-05", "2022-05-06", "2022-05-07" ], "historicalValues": [ 1.7, 1.69, 1.9 ], "currentValue": 1.45 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/buyers": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection buyer stats", "description": "Get historical statistics about Collection buyers", "operationId": "getBuyers", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filters of statistics", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-08", "2022-05-09", "2022-05-10" ], "historicalValues": [ 524, 791, 1619 ], "currentValue": 1767 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/data/collections/{collection}/listed": { "get": { "tags": [ "NFT Data and Historical Statistics" ], "summary": "Get NFT Collection listing stats", "description": "Get historical statistics of collection listed count", "operationId": "getListed", "parameters": [ { "name": "collection", "in": "path", "description": "Identifier of collection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapStatsGraphResponse" }, "example": { "historicalDates": [ "2022-05-08", "2022-05-09", "2022-05-10" ], "historicalValues": [ 524, 791, 1619 ], "currentValue": 1767 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OlapError" } } } } } } }, "/v0.1/domains/{domain}/resolution": { "post": { "tags": [ "Domain lookup" ], "summary": "Resolve domain", "description": "Resolves domain's blockchain address by its name (for example, from ENS domains collection)", "operationId": "resolve", "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "Name of a domain to resolve", "example": "nick.eth", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainResolveResult" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/signature/validate": { "post": { "tags": [ "Signature operations" ], "summary": "Check Order's signature", "description": "Checks if Order's signature is valid and returns 'true' if it so, 'false' otherwise", "operationId": "validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureValidationForm" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/signature/input": { "post": { "tags": [ "Signature operations" ], "summary": "Generate signed input", "description": "Generate input string to sign operation", "operationId": "getInput", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureInputForm" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureInput" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/encode/order": { "post": { "tags": [ "Encode operations" ], "summary": "Generate order encode data for sign operations", "description": "Generate order encode data for sign operations", "operationId": "encode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderForm" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodedOrder" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/currencies/{currencyId}/rates/usd": { "get": { "tags": [ "Currencies and rates" ], "summary": "Get USD rate", "description": "Get currency USD rate by currency blockchain's address", "operationId": "getUsdRate", "parameters": [ { "name": "currencyId", "in": "path", "required": true, "description": "Currency Id, has format `ETHEREUM:${token}` or `ETHEREUM:${token}:${tokenId}`", "schema": { "$ref": "#/components/schemas/CurrencyId" } }, { "name": "at", "in": "query", "required": true, "description": "Date and time for getting currency USD rate (if not specified, returns actual rate)", "example": "2022-01-01T12:00:00Z", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyUsdRate" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/currencies/all": { "get": { "tags": [ "Currencies and rates" ], "summary": "Get supported currencies", "description": "List of currencies, supported by Protocol", "operationId": "getAllCurrencies", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Currencies" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/balances/{currencyId}/{owner}": { "get": { "tags": [ "User balances" ], "summary": "Get balance", "description": "Return user's balance of specified currency", "operationId": "getBalance", "parameters": [ { "name": "currencyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CurrencyId" } }, { "name": "owner", "description": "Address of the token's owner", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UnionAddress" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Balance" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/EntityNotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/reconciliation/items": { "get": { "tags": [ "Reconciliation" ], "summary": "Get IDs of items updated after a specific datetime.", "description": "Return short view of items updated after a specific datetime.", "operationId": "getReconciliationItems", "parameters": [ { "name": "blockchain", "in": "query", "required": true, "allowEmptyValue": true, "description": "Blockchain name", "schema": { "$ref": "#/components/schemas/Blockchain" } }, { "name": "updatedAfterInclusive", "in": "query", "required": true, "allowEmptyValue": true, "description": "Only items with lastUpdatedAt after (inclusive) will be returned", "schema": { "type": "string", "format": "date-time" } }, { "name": "updatedBeforeExclusive", "in": "query", "required": true, "allowEmptyValue": true, "description": "Only items with lastUpdatedAt before (exclusive) will be returned", "schema": { "type": "string", "format": "date-time" } }, { "name": "continuation", "in": "query", "required": false, "description": "Paging cursor", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "The maximum number of results to be returned. If not specified, a predefined number is used.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationEntities" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v0.1/blocks/latestIndexed": { "get": { "tags": [ "Indexer blocks" ], "summary": "Get latest indexed block", "description": "Get latest indexed block for blockchain", "operationId": "getLatestIndexedBlock", "parameters": [ { "name": "blockchain", "in": "query", "required": true, "description": "Blockchain name", "example": "ETHEREUM", "schema": { "$ref": "#/components/schemas/Blockchain" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatestIndexedBlock" } } } }, "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", "XAI", "KROMA", "ZKLINK", "OASYS", "QUAI", "ECLIPSE", "SAAKURU", "OASIS", "PALM", "MATCH", "FIVIRE", "SEI", "CAMP", "LISK", "MOONBEAM", "ETHERLINK", "ZKCANDY", "ALEPHZERO", "BERACHAIN", "ABSTRACT", "SHAPE", "TELOS", "HEDERAEVM", "VICTION", "SETTLUS", "GOAT", "HYPEREVM", "CROSSFI", "MEGAETH", "MEGAETHTESTNET", "BASECAMP", "BASECAMPTESTNET", "SOMNIA" ], "example": "ETHEREUM" }, "BlockchainGroup": { "type": "string", "enum": [ "APTOS", "ETHEREUM", "FLOW", "SOLANA" ] }, "Payout": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "type": "integer" } }, "required": [ "account", "value" ] }, "OrderFees": { "type": "object", "description": "Base fees", "required": [ "fees" ], "properties": { "fees": { "type": "object", "additionalProperties": { "type": "integer", "description": "Basic points from 0 to 10000" } } } }, "EventTimeMarks": { "type": "object", "required": [ "source", "marks" ], "properties": { "source": { "type": "string", "description": "Describes what was the trigger of the event" }, "marks": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/EventTimeMark" } } } }, "EventTimeMark": { "type": "object", "required": [ "name", "date" ], "properties": { "name": { "type": "string", "description": "Describes 'place' where event has been handled/received" }, "date": { "type": "string", "format": "date-time" } } }, "DomainResolveResult": { "type": "object", "required": [ "blockchain", "registrant" ], "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "registrant": { "type": "string", "description": "Resolved domain value" } } }, "SignatureValidationForm": { "required": [ "signer", "message", "signature" ], "type": "object", "properties": { "signer": { "$ref": "#/components/schemas/UnionAddress" }, "publicKey": { "type": "string", "description": "The creator's public key" }, "message": { "type": "string" }, "signature": { "type": "string", "description": "Digital signature of the signer" }, "algorithm": { "description": "Algorithm used for signature generation (don't specify if default algo is used)", "type": "string" }, "weight": { "description": "Weight arg (only for Flow)", "type": "integer" } } }, "SignatureInputForm": { "type": "object", "description": "Form contains required data to generate input message for signing. All fields should be specified in 'native' manner, i.e. without BLOCKCHAIN prefixes", "required": [ "blockchain" ], "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" } }, "oneOf": [ { "$ref": "#/components/schemas/OpenSeaFillOrderSignatureInputForm" } ] }, "OpenSeaFillOrderSignatureInputForm": { "type": "object", "required": [ "orderId" ], "properties": { "@type": { "type": "string", "enum": [ "OPEN_SEA_ORDER_FILL" ] }, "signature": { "description": "SeaPort order hash in 'native' format", "example": "0xf3104d38a35c59d2612a6128c9e2bbfabf16f26b2db393801cc20398f10079f2", "type": "string" } } }, "SignatureInput": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "string" } } }, "EncodedOrder": { "type": "object", "required": [ "blockchain" ], "oneOf": [ { "$ref": "#/components/schemas/EncodedEthOrder" } ], "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" } } }, "EncodedEthOrder": { "type": "object", "required": [ "orderHash", "signHash" ], "properties": { "@type": { "type": "string", "enum": [ "ETH_ORDER_ENCODE" ] }, "orderHash": { "type": "string" }, "signHash": { "type": "string" }, "transferProxy": { "$ref": "#/components/schemas/UnionAddress" } } }, "Balance": { "type": "object", "required": [ "currencyId", "owner", "balance", "decimal" ], "properties": { "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "balance": { "$ref": "#/components/schemas/BigInteger" }, "decimal": { "$ref": "#/components/schemas/BigDecimal" } } }, "CurrencyId": { "type": "string", "description": "Currency Id, has format `ETHEREUM:${token}` or `ETHEREUM:${token}:${tokenId}`", "example": "ETHEREUM:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2" }, "CurrencyUsdRate": { "type": "object", "required": [ "symbol", "rate", "date" ], "properties": { "currencyId": { "deprecated": true, "type": "string", "description": "Currency Id", "example": "usdc" }, "symbol": { "type": "string", "description": "Currency Symbol", "example": "usdc" }, "abbreviation": { "type": "string" }, "rate": { "$ref": "#/components/schemas/BigDecimal" }, "date": { "type": "string", "format": "date-time", "description": "Date and time of currency USD rate" } } }, "Currency": { "type": "object", "properties": { "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "symbol": { "type": "string" }, "abbreviation": { "type": "string" }, "alias": { "type": "string", "description": "Alias to real coin, 'usd' means 1:1 to USD" }, "rate": { "$ref": "#/components/schemas/BigDecimal" }, "decimals": { "type": "integer", "format": "int32", "description": "Number of decimals" } }, "required": [ "currencyId", "symbol", "decimals" ] }, "Currencies": { "type": "object", "required": [ "currencies" ], "properties": { "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } } } }, "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" ] } } }, "OriginOrders": { "type": "object", "properties": { "origin": { "type": "string" }, "bestSellOrder": { "$ref": "#/components/schemas/Order" }, "bestBidOrder": { "$ref": "#/components/schemas/Order" } }, "required": [ "origin" ] }, "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" } }, "originOrders": { "type": "array", "items": { "$ref": "#/components/schemas/OriginOrders" } }, "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" ] } }, "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" ] }, "ItemWithOwnership": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/Item" }, "ownership": { "$ref": "#/components/schemas/ItemOwnership" } }, "required": [ "item", "ownership" ] }, "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" ] }, "DuplicatedItemGroups": { "type": "object", "properties": { "continuation": { "type": "string", "description": "Continuation token to paginate duplicates" }, "groups": { "type": "array", "description": "List of duplicated item groups", "default": [], "items": { "$ref": "#/components/schemas/DuplicatedItem" } } }, "required": [ "groups" ] }, "DuplicatedItem": { "type": "object", "properties": { "traitGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTraitProperty" } }, "count": { "type": "integer", "format": "int64", "description": "Number of duplicated items in the group" }, "item": { "$ref": "#/components/schemas/Item" } }, "required": [ "traitGroups", "count", "item" ] }, "ItemsWithOwnership": { "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/ItemWithOwnership" } } }, "required": [ "items" ] }, "LazyItem": { "type": "object", "required": [ "id", "uri", "creators", "royalties", "signatures" ], "properties": { "id": { "$ref": "#/components/schemas/ItemId" }, "uri": { "type": "string" }, "creators": { "type": "array", "description": "Addresses of the NFT item creators", "items": { "$ref": "#/components/schemas/Creator" } }, "royalties": { "type": "array", "description": "List of royalties", "items": { "$ref": "#/components/schemas/Royalty" } }, "signatures": { "type": "array", "description": "Digital signatures", "items": { "type": "string" } } }, "description": "Type of an Asset", "oneOf": [ { "$ref": "#/components/schemas/EthLazyItem" } ] }, "EthLazyItem": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EthLazyItemErc721" }, { "$ref": "#/components/schemas/EthLazyItemErc1155" } ] }, "EthLazyItemErc1155": { "type": "object", "required": [ "@type", "supply" ], "properties": { "@type": { "type": "string", "enum": [ "ETH_ERC1155" ] }, "supply": { "$ref": "#/components/schemas/BigInteger" } } }, "EthLazyItemErc721": { "type": "object", "required": [ "@type" ], "properties": { "@type": { "type": "string", "enum": [ "ETH_ERC721" ] } } }, "LazyItemMintForm": { "type": "object", "required": [ "item" ], "properties": { "item": { "$ref": "#/components/schemas/LazyItem" } } }, "LazyItemBurnForm": { "type": "object", "required": [ "id", "creators", "signatures" ], "properties": { "id": { "$ref": "#/components/schemas/ItemId" }, "creators": { "type": "array", "description": "Address of the NFT item creators", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "signatures": { "type": "array", "description": "Digital signatures", "items": { "type": "string" } } } }, "CollectionEvent": { "type": "object", "properties": { "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "eventId": { "type": "string" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "required": [ "eventId", "collectionId" ], "oneOf": [ { "$ref": "#/components/schemas/CollectionUpdateEvent" } ] }, "CollectionUpdateEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "UPDATE" ] }, "collection": { "$ref": "#/components/schemas/Collection" } }, "required": [ "@type", "collection" ] }, "ItemEvent": { "type": "object", "properties": { "itemId": { "$ref": "#/components/schemas/ItemId" }, "eventId": { "type": "string" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "required": [ "eventId", "itemId" ], "oneOf": [ { "$ref": "#/components/schemas/ItemUpdateEvent" }, { "$ref": "#/components/schemas/ItemDeleteEvent" } ] }, "ItemUpdateEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "UPDATE" ] }, "item": { "$ref": "#/components/schemas/Item" } }, "required": [ "@type", "item" ] }, "ItemDeleteEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "DELETE" ] } }, "required": [ "@type", "itemId" ] }, "Traits": { "type": "object", "properties": { "continuation": { "type": "string", "description": "Continuation token to paginate traits search result" }, "traits": { "type": "array", "description": "List of found traits", "default": [], "items": { "$ref": "#/components/schemas/Trait" } } }, "required": [ "traits" ] }, "Trait": { "title": "Trait", "type": "object", "description": "Combination of Item attribute key with list of values", "required": [ "key", "values" ], "properties": { "key": { "$ref": "#/components/schemas/TraitEntry" }, "values": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/TraitEntry" } } } }, "TraitEntry": { "title": "TraitEntry", "type": "object", "description": "Combination of Item attribute key/value with it's count", "required": [ "value", "count" ], "properties": { "value": { "type": "string" }, "count": { "type": "integer", "format": "int64" } } }, "TraitsRarityRequest": { "title": "TraitsRarityRequest", "type": "object", "description": "Request rarity of the properties in the collection", "required": [ "collectionId", "properties" ], "properties": { "collectionId": { "type": "string", "example": "ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/TraitProperty" } } } }, "TraitRange": { "title": "TraitRange", "type": "object", "description": "Trait value range", "required": [ "key", "valueRange" ], "properties": { "key": { "type": "string", "example": "Hat" }, "valueRange": { "$ref": "#/components/schemas/Range" } } }, "Range": { "title": "Range", "type": "object", "properties": { "from": { "type": "number", "format": "float" }, "to": { "type": "number", "format": "float" } } }, "ItemTraitProperty": { "title": "ItemTraitProperty", "type": "object", "description": "Item trait property", "required": [ "key" ], "properties": { "key": { "type": "string", "example": "Hat" }, "value": { "type": "string", "example": "Halo" }, "values": { "type": "array", "items": { "type": "string" } } } }, "TraitProperty": { "title": "TraitProperty", "type": "object", "description": "Item trait property", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "example": "Hat" }, "value": { "type": "string", "example": "Halo" } } }, "ExtendedTraitProperty": { "title": "ExtendedTraitProperty", "type": "object", "description": "Trait property parameters with additional features", "required": [ "key", "value", "rarity" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "rarity": { "type": "number", "format": "bigdecimal", "description": "Rarity percent" } } }, "ExtendedTraitProperties": { "type": "object", "properties": { "continuation": { "type": "string", "description": "Continuation token to paginate result" }, "traits": { "type": "array", "description": "List of ExtendedTraitProperty", "default": [], "items": { "$ref": "#/components/schemas/ExtendedTraitProperty" } } }, "required": [ "traits" ] }, "OwnershipId": { "type": "string", "example": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410:0x4765273c477c2dc484da4f1984639e943adccfeb" }, "OwnershipIds": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "description": "List of the Ownerships ids", "items": { "$ref": "#/components/schemas/OwnershipId" } } } }, "Ownership": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/OwnershipId" }, "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "source": { "$ref": "#/components/schemas/OwnershipSource" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "creators": { "type": "array", "deprecated": true, "description": "Creators of the target item", "default": [], "items": { "$ref": "#/components/schemas/Creator" } }, "lazyValue": { "$ref": "#/components/schemas/BigInteger" }, "pending": { "type": "array", "description": "Pending information about the item", "default": [], "items": { "$ref": "#/components/schemas/ItemHistory" } }, "bestSellOrder": { "$ref": "#/components/schemas/Order" }, "originOrders": { "type": "array", "items": { "$ref": "#/components/schemas/OriginOrders" } }, "version": { "type": "integer", "format": "int64" } }, "required": [ "id", "blockchain", "owner", "value", "createdAt", "lazyValue", "pending" ] }, "OwnershipSource": { "type": "string", "enum": [ "MINT", "PURCHASE", "TRANSFER" ] }, "ItemOwnership": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/OwnershipId" }, "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "createdAt": { "type": "string", "format": "date-time" }, "creators": { "type": "array", "description": "Creators of the target item", "default": [], "items": { "$ref": "#/components/schemas/Creator" } }, "lazyValue": { "$ref": "#/components/schemas/BigInteger" }, "version": { "type": "integer", "format": "int64" } }, "required": [ "id", "blockchain", "owner", "value", "createdAt", "creators", "lazyValue", "pending" ] }, "ItemHistory": { "type": "object", "properties": { "owner": { "$ref": "#/components/schemas/UnionAddress" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "date": { "type": "string", "format": "date-time" } }, "description": "History of item", "required": [ "contract", "tokenId", "date" ], "oneOf": [ { "$ref": "#/components/schemas/ItemRoyalty" }, { "$ref": "#/components/schemas/ItemTransfer" } ] }, "ItemRoyalty": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ROYALTY" ] }, "royalties": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Royalty" } } }, "required": [ "@type", "royalties" ] }, "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" ] }, "Royalties": { "type": "object", "properties": { "royalties": { "type": "array", "items": { "$ref": "#/components/schemas/Royalty" } } }, "required": [ "royalties" ] }, "Creator": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/UnionAddress" }, "value": { "type": "integer" } }, "required": [ "account", "value" ] }, "Ownerships": { "type": "object", "properties": { "total": { "deprecated": true, "type": "integer", "format": "int64", "description": "Number of ownerships were found by request" }, "continuation": { "type": "string", "description": "Continuation token to paginate Ownerships search result" }, "ownerships": { "type": "array", "default": [], "description": "List of found ownerships", "items": { "$ref": "#/components/schemas/Ownership" } } }, "required": [ "ownerships" ] }, "OwnershipEvent": { "type": "object", "properties": { "ownershipId": { "$ref": "#/components/schemas/OwnershipId" }, "eventId": { "type": "string" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "required": [ "ownershipId", "eventId" ], "oneOf": [ { "$ref": "#/components/schemas/OwnershipUpdateEvent" }, { "$ref": "#/components/schemas/OwnershipDeleteEvent" } ] }, "OwnershipUpdateEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "UPDATE" ] }, "ownership": { "$ref": "#/components/schemas/Ownership" } }, "required": [ "@type", "ownership" ] }, "OwnershipDeleteEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "DELETE" ] } }, "required": [ "@type" ] }, "OwnershipSearchRequest": { "title": "OwnershipSearchQuery", "type": "object", "description": "Ownerships complex search query", "required": [ "size", "filter" ], "properties": { "size": { "minimum": 1, "maximum": 1000, "default": 50, "type": "integer", "format": "int32", "description": "Number of entities returned" }, "continuation": { "type": "string", "description": "Continuation token to paginate ownerships search result" }, "filter": { "$ref": "#/components/schemas/OwnershipSearchFilter" }, "sort": { "$ref": "#/components/schemas/OwnershipSearchSort" } } }, "OwnershipSearchFilter": { "type": "object", "description": "Filter for ownerships search query", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionId" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemId" } }, "beforeDate": { "type": "string", "format": "date-time" }, "afterDate": { "type": "string", "format": "date-time" }, "sellPriceFrom": { "type": "number", "format": "double" }, "sellPriceTo": { "type": "number", "format": "double" }, "sellCurrency": { "type": "string" }, "sellPlatforms": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" } } } }, "OwnershipSearchSort": { "type": "string", "enum": [ "LATEST", "EARLIEST", "HIGHEST_SELL", "LOWEST_SELL" ] }, "CollectionsWithOwnedItems": { "type": "object", "properties": { "collections": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionWithOwnedItems" } }, "continuation": { "type": "string", "description": "Continuation token to paginate result" } }, "required": [ "collections" ] }, "CollectionWithOwnedItems": { "type": "object", "properties": { "collection": { "$ref": "#/components/schemas/Collection" }, "ownedItems": { "type": "integer", "format": "int64" } }, "required": [ "collection", "ownedItems" ] }, "DuplicatedItemsSearchRequest": { "type": "object", "description": "Search request for items with duplicated traits", "required": [ "size", "filter", "traits" ], "properties": { "size": { "minimum": 1, "maximum": 1000, "default": 50, "type": "integer", "format": "int32", "description": "Number of entities returned" }, "continuation": { "type": "string", "description": "Continuation token to paginate items search result" }, "filter": { "$ref": "#/components/schemas/ItemsSearchFilter" }, "traits": { "description": "Traits names to group by", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } } } }, "ItemsSearchRequest": { "type": "object", "description": "Complex search request for items", "required": [ "size", "filter" ], "properties": { "size": { "minimum": 1, "maximum": 1000, "default": 50, "type": "integer", "format": "int32", "description": "Number of entities returned" }, "continuation": { "type": "string", "description": "Continuation token to paginate items search result" }, "filter": { "$ref": "#/components/schemas/ItemsSearchFilter" }, "traitSort": { "$ref": "#/components/schemas/TraitSort" }, "sort": { "$ref": "#/components/schemas/ItemsSearchSort" } } }, "ItemsSearchFilter": { "type": "object", "description": "Filter for items search query", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionId" } }, "deleted": { "type": "boolean", "default": false, "example": "false" }, "names": { "deprecated": true, "description": "Deprecated. Please, use fullText instead", "type": "array", "items": { "type": "string", "example": "MutantApeYachtClub" } }, "fullText": { "$ref": "#/components/schemas/ItemSearchFullText" }, "traits": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTraitProperty" } }, "traitRanges": { "type": "array", "items": { "$ref": "#/components/schemas/TraitRange" } }, "creators": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "owners": { "type": "array", "description": "owner of single item", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "mintedAtFrom": { "type": "string", "format": "date-time", "example": "2021-08-25T00:00:00Z" }, "mintedAtTo": { "type": "string", "format": "date-time", "example": "2029-12-01T00:00:00Z" }, "lastUpdatedAtFrom": { "type": "string", "format": "date-time", "example": "2021-08-25T00:00:00Z" }, "lastUpdatedAtTo": { "type": "string", "format": "date-time", "example": "2029-12-01T00:00:00Z" }, "sellPriceFrom": { "type": "number", "format": "double", "example": "0" }, "sellPriceTo": { "type": "number", "format": "double", "example": "999999" }, "sellCurrency": { "type": "string", "example": "ETHEREUM:0x0000000000000000000000000000000000000000" }, "sellPlatforms": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" } }, "bidPriceFrom": { "type": "number", "format": "double", "example": "0" }, "bidPriceTo": { "type": "number", "format": "double", "example": "999999" }, "bidCurrency": { "type": "string", "example": "ETHEREUM:0x0000000000000000000000000000000000000000" }, "bidPlatforms": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" } }, "onSale": { "type": "boolean" } } }, "ItemSearchFullText": { "type": "object", "properties": { "text": { "type": "string" }, "fields": { "type": "array", "default": [ "NAME" ], "items": { "type": "string", "enum": [ "NAME", "DESCRIPTION", "TRAIT_VALUE" ] } } }, "required": [ "text" ] }, "ItemsSearchSort": { "type": "string", "enum": [ "RELEVANCE", "LATEST", "RECENTLY_LISTED", "EARLIEST", "HIGHEST_SELL", "LOWEST_SELL", "HIGHEST_BID", "LOWEST_BID", "TRAIT", "NAME_ASC", "NAME_DESC", "OWNER_CHANGE_DATE" ] }, "ActivitySearchRequest": { "type": "object", "description": "Complex search request for Activities", "required": [ "size", "filter" ], "properties": { "size": { "minimum": 1, "maximum": 1000, "default": 50, "type": "integer", "format": "int32", "description": "Number of entities returned" }, "cursor": { "type": "string", "description": "Cursor token to paginate Activity search result" }, "filter": { "$ref": "#/components/schemas/ActivitySearchFilter" }, "sort": { "$ref": "#/components/schemas/ActivitySearchSort" } } }, "ActivitySearchFilter": { "type": "object", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionId" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemId" } }, "users": { "$ref": "#/components/schemas/ActivityUserFilter" }, "currencies": { "$ref": "#/components/schemas/ActivityCurrencyFilter" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "fromBlockInclusive": { "type": "integer", "format": "int64" }, "toBlockExclusive": { "type": "integer", "format": "int64" } } }, "ActivityUserFilter": { "type": "object", "properties": { "any": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "from": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "to": { "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } } } }, "ActivityCurrencyFilter": { "type": "object", "properties": { "bid": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } } } }, "ActivitySearchSort": { "type": "string", "enum": [ "LATEST", "EARLIEST" ] }, "SortType": { "title": "SortType", "type": "string", "default": "TEXT", "enum": [ "TEXT", "NUMERIC" ] }, "SortOrder": { "title": "SortOrder", "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] }, "TraitSort": { "title": "TraitSort", "type": "object", "description": "Used when the search sort is set as TRAIT", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "Trait key", "example": "hat" }, "order": { "$ref": "#/components/schemas/SortOrder" }, "type": { "$ref": "#/components/schemas/SortType" } } }, "OrderId": { "type": "string", "example": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143" }, "OrderIds": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "description": "Array of the orders Ids in format 'ETHEREUM:${id}'", "items": { "type": "string" } } } }, "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" } ] }, "Orders": { "type": "object", "properties": { "continuation": { "type": "string", "description": "Continuation token to paginate orders search result" }, "orders": { "type": "array", "description": "List of found orders", "default": [], "items": { "$ref": "#/components/schemas/Order" } } }, "required": [ "orders" ] }, "OrderEvent": { "type": "object", "properties": { "orderId": { "$ref": "#/components/schemas/OrderId" }, "eventId": { "type": "string" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "required": [ "orderId", "eventId" ], "oneOf": [ { "$ref": "#/components/schemas/OrderUpdateEvent" } ] }, "OrderUpdateEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "UPDATE" ] }, "order": { "$ref": "#/components/schemas/Order" } }, "required": [ "@type", "order" ] }, "OrderStatus": { "type": "string", "enum": [ "ACTIVE", "FILLED", "INACTIVE", "CANCELLED" ] }, "OrderSort": { "type": "string", "enum": [ "LAST_UPDATE_ASC", "LAST_UPDATE_DESC" ] }, "PrepareOrderTxForm": { "type": "object", "required": [ "maker", "amount", "payouts", "originFees" ], "properties": { "maker": { "$ref": "#/components/schemas/UnionAddress" }, "taker": { "$ref": "#/components/schemas/UnionAddress" }, "amount": { "$ref": "#/components/schemas/BigInteger" }, "payouts": { "type": "array", "description": "Value of the payouts for the order", "items": { "$ref": "#/components/schemas/Payout" } }, "originFees": { "type": "array", "description": "Value of the origin fees for the order", "items": { "$ref": "#/components/schemas/Payout" } } } }, "PrepareOrderTxResponse": { "type": "object", "required": [ "asset", "transaction", "value" ], "properties": { "transferProxyAddress": { "$ref": "#/components/schemas/ContractAddress" }, "asset": { "$ref": "#/components/schemas/Asset" }, "transaction": { "$ref": "#/components/schemas/PreparedOrderTx" }, "value": { "$ref": "#/components/schemas/BigInteger" } } }, "PreparedOrderTx": { "type": "object", "required": [ "to", "data" ], "properties": { "to": { "$ref": "#/components/schemas/ContractAddress" }, "data": { "type": "string" } } }, "ActivityId": { "type": "string", "example": "ETHEREUM:${id}" }, "ActivitySort": { "description": "Sorting by data update time", "type": "string", "enum": [ "LATEST_FIRST", "EARLIEST_FIRST" ] }, "SyncSort": { "type": "string", "enum": [ "DB_UPDATE_ASC", "DB_UPDATE_DESC" ] }, "SyncType": { "type": "string", "enum": [ "ORDER", "NFT" ] }, "ActivityType": { "type": "string", "enum": [ "TRANSFER", "MINT", "BURN", "BID", "LIST", "SELL", "CANCEL_LIST", "CANCEL_BID", "BRIDGE_TO", "BRIDGE_FROM" ] }, "UserActivityType": { "type": "string", "enum": [ "TRANSFER_FROM", "TRANSFER_TO", "MINT", "BURN", "MAKE_BID", "GET_BID", "LIST", "BUY", "SELL", "CANCEL_LIST", "CANCEL_BID", "BRIDGE_TO", "BRIDGE_FROM" ] }, "Activity": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/ActivityId" }, "date": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "cursor": { "type": "string" }, "reverted": { "type": "boolean" }, "version": { "type": "integer", "format": "int64" } }, "oneOf": [ { "$ref": "#/components/schemas/MintActivity" }, { "$ref": "#/components/schemas/BurnActivity" }, { "$ref": "#/components/schemas/TransferActivity" }, { "$ref": "#/components/schemas/SendToChainActivity" }, { "$ref": "#/components/schemas/ReceiveFromChainActivity" }, { "$ref": "#/components/schemas/OrderMatchActivity" }, { "$ref": "#/components/schemas/OrderBidActivity" }, { "$ref": "#/components/schemas/OrderListActivity" }, { "$ref": "#/components/schemas/OrderCancelBidActivity" }, { "$ref": "#/components/schemas/OrderCancelListActivity" }, { "$ref": "#/components/schemas/L2DepositActivity" }, { "$ref": "#/components/schemas/L2WithdrawalActivity" } ], "required": [ "id", "date" ] }, "MintActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "MINT" ] }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "mintPrice": { "$ref": "#/components/schemas/BigDecimal" }, "mintPayment": { "$ref": "#/components/schemas/Asset" }, "mintPriceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "owner", "value", "transactionHash" ] }, "BurnActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "BURN" ] }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "owner", "value", "transactionHash" ] }, "TransferActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "TRANSFER" ] }, "from": { "$ref": "#/components/schemas/UnionAddress" }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "tokenId": { "$ref": "#/components/schemas/BigInteger" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "purchase": { "type": "boolean" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "from", "owner", "value", "transactionHash" ] }, "SendToChainActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SEND_TO_CHAIN" ] }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "to": { "type": "string" }, "chainId": { "$ref": "#/components/schemas/BigInteger" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "to", "itemId", "owner", "value", "transactionHash", "chainId" ] }, "ReceiveFromChainActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "RECEIVE_FROM_CHAIN" ] }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "from": { "type": "string" }, "chainId": { "$ref": "#/components/schemas/BigInteger" }, "contract": { "$ref": "#/components/schemas/ContractAddress" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "value": { "$ref": "#/components/schemas/BigInteger" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "from", "itemId", "owner", "value", "transactionHash", "chainId" ] }, "OrderActivitySource": { "type": "string", "enum": [ "RARIBLE", "OPEN_SEA", "CRYPTO_PUNKS", "IMMUTABLEX", "HEN", "OBJKT", "X2Y2", "LOOKSRARE", "SUDOSWAP", "TEIA", "VERSUM", "FXHASH", "BLUR", "TOPAZ" ] }, "OrderActivityMatchSide": { "type": "object", "properties": { "maker": { "$ref": "#/components/schemas/UnionAddress" }, "hash": { "type": "string" }, "asset": { "$ref": "#/components/schemas/Asset" } }, "required": [ "maker", "asset" ] }, "OrderMatchActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "MATCH" ] }, "orderId": { "$ref": "#/components/schemas/OrderId" }, "source": { "$ref": "#/components/schemas/OrderActivitySource" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "source", "transactionHash" ], "oneOf": [ { "$ref": "#/components/schemas/OrderMatchSwap" }, { "$ref": "#/components/schemas/OrderMatchSell" } ] }, "OrderMatchSwap": { "type": "object", "required": [ "left", "right" ], "properties": { "@type": { "type": "string", "enum": [ "SWAP" ] }, "left": { "$ref": "#/components/schemas/OrderActivityMatchSide" }, "right": { "$ref": "#/components/schemas/OrderActivityMatchSide" } } }, "OrderMatchSell": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "SELL" ] }, "nft": { "$ref": "#/components/schemas/Asset" }, "payment": { "$ref": "#/components/schemas/Asset" }, "buyer": { "$ref": "#/components/schemas/UnionAddress" }, "seller": { "$ref": "#/components/schemas/UnionAddress" }, "buyerOrderHash": { "type": "string" }, "sellerOrderHash": { "type": "string" }, "price": { "$ref": "#/components/schemas/BigDecimal" }, "priceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "amountUsd": { "$ref": "#/components/schemas/BigDecimal" }, "type": { "type": "string", "enum": [ "SELL", "ACCEPT_BID" ] }, "sellMarketplaceMarker": { "type": "string" }, "buyMarketplaceMarker": { "type": "string" } }, "required": [ "nft", "payment", "price", "type", "buyer", "seller" ] }, "OrderBidActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "BID" ] }, "orderId": { "$ref": "#/components/schemas/OrderId" }, "hash": { "type": "string" }, "maker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/Asset" }, "take": { "$ref": "#/components/schemas/Asset" }, "price": { "$ref": "#/components/schemas/BigDecimal" }, "priceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "source": { "$ref": "#/components/schemas/OrderActivitySource" }, "marketplaceMarker": { "type": "string" } }, "required": [ "@type", "hash", "maker", "make", "take", "price" ] }, "OrderListActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "LIST" ] }, "orderId": { "$ref": "#/components/schemas/OrderId" }, "hash": { "type": "string" }, "maker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/Asset" }, "take": { "$ref": "#/components/schemas/Asset" }, "price": { "$ref": "#/components/schemas/BigDecimal" }, "priceUsd": { "$ref": "#/components/schemas/BigDecimal" }, "source": { "$ref": "#/components/schemas/OrderActivitySource" } }, "required": [ "@type", "hash", "maker", "make", "take", "price" ] }, "OrderCancelBidActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "CANCEL_BID" ] }, "orderId": { "$ref": "#/components/schemas/OrderId" }, "hash": { "type": "string" }, "maker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/AssetType" }, "take": { "$ref": "#/components/schemas/AssetType" }, "source": { "$ref": "#/components/schemas/OrderActivitySource" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "hash", "maker", "make", "take", "transactionHash" ] }, "OrderCancelListActivity": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "CANCEL_LIST" ] }, "orderId": { "$ref": "#/components/schemas/OrderId" }, "hash": { "type": "string" }, "maker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/AssetType" }, "take": { "$ref": "#/components/schemas/AssetType" }, "source": { "$ref": "#/components/schemas/OrderActivitySource" }, "transactionHash": { "type": "string" }, "blockchainInfo": { "$ref": "#/components/schemas/ActivityBlockchainInfo" } }, "required": [ "@type", "hash", "maker", "make", "take", "transactionHash" ] }, "L2DepositActivity": { "type": "object", "required": [ "@type", "user", "status", "itemId" ], "properties": { "@type": { "type": "string", "enum": [ "L2_DEPOSIT" ] }, "user": { "$ref": "#/components/schemas/UnionAddress" }, "status": { "type": "string" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "value": { "$ref": "#/components/schemas/BigInteger" } } }, "L2WithdrawalActivity": { "type": "object", "required": [ "@type", "user", "status", "itemId" ], "properties": { "@type": { "type": "string", "enum": [ "L2_WITHDRAWAL" ] }, "user": { "$ref": "#/components/schemas/UnionAddress" }, "status": { "type": "string" }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "collection": { "$ref": "#/components/schemas/CollectionId" }, "value": { "$ref": "#/components/schemas/BigInteger" } } }, "SalesChart": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Combined continuation token to paginate search result" }, "dates": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "pricesNative": { "type": "array", "items": { "$ref": "#/components/schemas/BigDecimal" } }, "itemIds": { "type": "array", "items": { "$ref": "#/components/schemas/ItemId" } } }, "required": [ "dates", "pricesNative", "itemIds" ] }, "Activities": { "type": "object", "properties": { "continuation": { "type": "string", "description": "Continuation token to paginate activities search result" }, "cursor": { "type": "string", "description": "Combined continuation token to paginate activities search result" }, "activities": { "type": "array", "default": [], "description": "List of found activities", "items": { "$ref": "#/components/schemas/Activity" } } }, "required": [ "activities" ] }, "ActivitiesByUsersRequest": { "type": "object", "required": [ "types", "users" ], "properties": { "types": { "description": "Activity type", "type": "array", "items": { "$ref": "#/components/schemas/UserActivityType" } }, "users": { "description": "List of the user id", "type": "array", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "bidCurrencies": { "description": "Currency for BID and CANCEL_BID activity types", "type": "array", "items": { "$ref": "#/components/schemas/CurrencyId" } }, "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } }, "from": { "description": "Lower time border of data", "type": "string", "format": "date-time" }, "to": { "description": "Upper time border of data", "type": "string", "format": "date-time" }, "continuation": { "description": "Continuation token from the previous response", "type": "string" }, "cursor": { "description": "Combined continuation token from the previous response", "type": "string" }, "size": { "description": "The number of items to return", "type": "integer" }, "sort": { "$ref": "#/components/schemas/ActivitySort" } } }, "CollectionId": { "type": "string", "description": "Collection id", "example": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8" }, "Collection": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CollectionId" }, "parent": { "$ref": "#/components/schemas/CollectionId" }, "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "structure": { "type": "string", "enum": [ "REGULAR", "COMPOSITE", "PART" ], "description": "Collection structure can be described as:\n- REGULAR: a standalone collection that has a corresponding contract address on the blockchain.\n- COMPOSITE: an artificial collection that is composed of one or more regular collections or items.\n- PART: an artificial collection that is a part of a larger regular collection, thus has a parent collection.\n" }, "type": { "type": "string", "enum": [ "CRYPTO_PUNKS", "ERC721", "ERC1155", "FLOW", "SOLANA", "TOKEN_GROUP_2022", "IMMUTABLEX", "APTOS" ] }, "status": { "type": "string", "enum": [ "PENDING", "ERROR", "CONFIRMED" ] }, "name": { "type": "string" }, "symbol": { "type": "string" }, "owner": { "$ref": "#/components/schemas/UnionAddress" }, "features": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "APPROVE_FOR_ALL", "SET_URI_PREFIX", "BURN", "MINT_WITH_ADDRESS", "SECONDARY_SALE_FEES", "MINT_AND_TRANSFER", "PAUSABLE", "NOT_FOR_SALE" ] } }, "minters": { "type": "array", "description": "List of addresses that can mint items in this collection", "items": { "$ref": "#/components/schemas/UnionAddress" } }, "meta": { "$ref": "#/components/schemas/CollectionMeta" }, "bestBidOrder": { "$ref": "#/components/schemas/Order" }, "bestSellOrder": { "$ref": "#/components/schemas/Order" }, "bestBidOrdersByCurrency": { "type": "array", "description": "Contains best bid order for each currency if exists", "items": { "$ref": "#/components/schemas/Order" } }, "originOrders": { "type": "array", "items": { "$ref": "#/components/schemas/OriginOrders" } }, "self": { "type": "boolean" }, "scam": { "deprecated": true, "description": "Deprecated, use spamScore instead", "type": "boolean", "default": false }, "spamScore": { "description": "Spam score of the collection, 0 - not spam, 100 - spam", "type": "integer", "format": "int32" }, "hasTraits": { "type": "boolean", "default": true }, "shared": { "type": "boolean", "default": false }, "extra": { "type": "object", "description": "Blockchain-specific information about this NFT collection particular to that blockchain's data model", "additionalProperties": { "type": "string" } }, "version": { "type": "integer", "format": "int64" } }, "required": [ "id", "blockchain", "name", "type", "features" ] }, "Collections": { "type": "object", "properties": { "total": { "deprecated": true, "type": "integer", "format": "int64", "description": "Number of ownerships were found by request" }, "continuation": { "type": "string", "description": "Continuation token to paginate collections search result" }, "collections": { "default": [], "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } }, "required": [ "collections" ] }, "CollectionMeta": { "required": [ "name", "content" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the collection" }, "description": { "type": "string", "description": "Description of the collection" }, "createdAt": { "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 collection", "type": "string" }, "originalMetaUri": { "description": "URI to the original meta JSON", "type": "string" }, "content": { "default": [], "type": "array", "items": { "$ref": "#/components/schemas/MetaContent" } }, "externalLink": { "type": "string", "description": "External link to the original website for the collection" }, "sellerFeeBasisPoints": { "type": "integer", "format": "int32", "description": "Indicates a 1% seller fee" }, "feeRecipient": { "$ref": "#/components/schemas/UnionAddress" } } }, "CollectionsSearchRequest": { "type": "object", "description": "Complex search request for collections", "required": [ "size", "filter" ], "properties": { "size": { "minimum": 1, "maximum": 1000, "default": 50, "type": "integer", "format": "int32", "description": "Number of entities returned" }, "continuation": { "type": "string", "description": "Continuation token to paginate collections search result" }, "filter": { "$ref": "#/components/schemas/CollectionsSearchFilter" } } }, "CollectionsSearchFilter": { "type": "object", "description": "Filter for collections search query", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/Blockchain" } }, "text": { "type": "string", "example": "Apes" } }, "required": [ "text" ] }, "CollectionTokenId": { "required": [ "tokenId" ], "type": "object", "properties": { "tokenId": { "$ref": "#/components/schemas/BigInteger" } }, "oneOf": [ { "$ref": "#/components/schemas/DefaultCollectionTokenId" }, { "$ref": "#/components/schemas/EthCollectionTokenId" } ] }, "DefaultCollectionTokenId": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string", "enum": [ "DEFAULT" ] } } }, "EthCollectionTokenId": { "required": [ "signature", "@type" ], "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ETHEREUM" ] }, "signature": { "$ref": "#/components/schemas/EthCollectionTokenIdSignature" } } }, "EthCollectionTokenIdSignature": { "required": [ "v", "r", "s" ], "type": "object", "properties": { "v": { "type": "integer" }, "r": { "type": "string" }, "s": { "type": "string" } } }, "ActivityBlockchainInfo": { "type": "object", "deprecated": true, "properties": { "transactionHash": { "type": "string" }, "blockHash": { "type": "string" }, "blockNumber": { "type": "integer", "format": "int64" }, "logIndex": { "type": "integer" } }, "required": [ "transactionHash", "blockHash", "blockNumber", "logIndex" ] }, "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" } } }, "OrderForm": { "type": "object", "required": [ "blockchain" ], "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" } }, "oneOf": [ { "$ref": "#/components/schemas/EthRaribleOrderForm" } ] }, "EthRaribleOrderForm": { "type": "object", "required": [ "maker", "make", "take", "signature", "salt", "endedAt" ], "properties": { "maker": { "$ref": "#/components/schemas/UnionAddress" }, "taker": { "$ref": "#/components/schemas/UnionAddress" }, "make": { "$ref": "#/components/schemas/EthOrderFormAsset" }, "take": { "$ref": "#/components/schemas/EthOrderFormAsset" }, "startedAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": "string", "format": "date-time" }, "salt": { "$ref": "#/components/schemas/BigInteger" }, "signature": { "type": "string" } }, "oneOf": [ { "$ref": "#/components/schemas/EthRaribleV2OrderForm" } ] }, "RawOrderData": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "RAW" ] }, "data": { "$ref": "#/components/schemas/RawJson" } }, "required": [ "@type" ] }, "EthRaribleV2OrderForm": { "type": "object", "required": [ "type", "data" ], "properties": { "@type": { "type": "string", "enum": [ "RARIBLE_V2" ] }, "data": { "$ref": "#/components/schemas/EthRaribleV2OrderData" } } }, "EthOrderFormAsset": { "type": "object", "required": [ "assetType", "value" ], "properties": { "assetType": { "$ref": "#/components/schemas/AssetType" }, "value": { "$ref": "#/components/schemas/BigInteger" } } }, "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" ] }, "SubscriptionAction": { "type": "string", "enum": [ "SUBSCRIBE", "UNSUBSCRIBE" ] }, "SubscriptionRequest": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/SubscriptionAction" } }, "required": [ "action" ], "oneOf": [ { "$ref": "#/components/schemas/ItemSubscriptionRequest" }, { "$ref": "#/components/schemas/OwnershipSubscriptionRequest" }, { "$ref": "#/components/schemas/ItemOwnershipSubscriptionRequest" }, { "$ref": "#/components/schemas/OrdersSubscriptionRequest" }, { "$ref": "#/components/schemas/OrdersByItemSubscriptionRequest" }, { "$ref": "#/components/schemas/OrdersByCollectionSubscriptionRequest" }, { "$ref": "#/components/schemas/ActivitySubscriptionRequest" } ] }, "OrdersSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ORDERS" ] }, "platform": { "$ref": "#/components/schemas/Platform" }, "orderType": { "$ref": "#/components/schemas/OrderType" } }, "required": [ "@type" ] }, "OrdersByCollectionSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ORDERS_BY_COLLECTION" ] }, "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "platform": { "$ref": "#/components/schemas/Platform" }, "orderType": { "$ref": "#/components/schemas/OrderType" } }, "required": [ "@type", "collectionId" ] }, "OrdersByItemSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ORDERS_BY_ITEM" ] }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "platform": { "$ref": "#/components/schemas/Platform" }, "orderType": { "$ref": "#/components/schemas/OrderType" } }, "required": [ "@type", "itemId" ] }, "ItemSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ITEM" ] }, "id": { "$ref": "#/components/schemas/ItemId" } }, "required": [ "@type", "id" ] }, "OwnershipSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "OWNERSHIP" ] }, "id": { "$ref": "#/components/schemas/OwnershipId" } }, "required": [ "@type", "id" ] }, "ItemOwnershipSubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ITEM_OWNERSHIP" ] }, "id": { "$ref": "#/components/schemas/ItemId" } }, "required": [ "@type", "id" ] }, "ActivitySubscriptionRequest": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ACTIVITY" ] }, "itemId": { "$ref": "#/components/schemas/ItemId" }, "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "wallet": { "$ref": "#/components/schemas/UnionAddress" }, "type": { "$ref": "#/components/schemas/ActivityType" } }, "required": [ "@type" ] }, "SubscriptionEvent": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/FakeSubscriptionEvent" }, { "$ref": "#/components/schemas/ItemSubscriptionEvent" }, { "$ref": "#/components/schemas/ItemOwnershipSubscriptionEvent" }, { "$ref": "#/components/schemas/OwnershipSubscriptionEvent" }, { "$ref": "#/components/schemas/OrderSubscriptionEvent" }, { "$ref": "#/components/schemas/ActivitySubscriptionEvent" } ] }, "FakeSubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "FAKE" ] } }, "required": [ "@type" ] }, "ItemSubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ITEM" ] }, "value": { "$ref": "#/components/schemas/ItemEvent" } }, "required": [ "@type", "value" ] }, "ItemOwnershipSubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ITEM_OWNERSHIP" ] }, "value": { "$ref": "#/components/schemas/OwnershipEvent" } }, "required": [ "@type", "value" ] }, "OrderSubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ORDER" ] }, "value": { "$ref": "#/components/schemas/OrderEvent" } }, "required": [ "@type", "value" ] }, "OwnershipSubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "OWNERSHIP" ] }, "value": { "$ref": "#/components/schemas/OwnershipEvent" } }, "required": [ "@type", "value" ] }, "ActivitySubscriptionEvent": { "type": "object", "properties": { "@type": { "type": "string", "enum": [ "ACTIVITY" ] }, "value": { "$ref": "#/components/schemas/Activity" } }, "required": [ "@type", "value" ] }, "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" }, "SearchEngine": { "type": "string", "enum": [ "LEGACY", "V1" ] }, "OrderType": { "type": "string", "enum": [ "BID", "SELL" ] }, "LatestIndexedBlock": { "type": "object", "required": [ "blockchain", "blockNumber" ], "properties": { "blockchain": { "$ref": "#/components/schemas/Blockchain" }, "blockNumber": { "type": "integer", "format": "int64" } } }, "OlapBlockchain": { "type": "string", "enum": [ "ETHEREUM", "FLOW", "POLYGON", "SOLANA", "IMMUTABLEX", "MANTLE", "ARBITRUM", "CHILIZ", "LIGHTLINK", "ZKSYNC", "ASTARZKEVM", "BASE", "RARI", "CELO", "FIEF", "XAI", "KROMA", "APTOS", "ZKLINK", "OASYS", "QUAI", "ECLIPSE", "SAAKURU", "OASIS", "PALM", "MATCH", "FIVIRE", "SEI", "CAMP", "LISK", "MOONBEAM", "ETHERLINK", "ZKCANDY", "ALEPHZERO", "BERACHAIN", "ABSTRACT", "SHAPE", "TELOS", "HEDERAEVM", "VICTION", "SETTLUS", "GOAT", "HYPEREVM", "CROSSFI", "MEGAETH", "MEGAETHTESTNET", "BASECAMP", "BASECAMPTESTNET", "SOMNIA" ] }, "OlapPeriod": { "type": "string", "enum": [ "MIN5", "MIN30", "H1", "H6", "D1", "D7", "D30", "D180", "D365", "ALL" ], "description": "Period:\n * `MIN5` - Last 5 minutes\n * `MIN30` - Last 30 minutes\n * `H1` - Last 1 hour\n * `H6` - Last 6 hours\n * `D1` - Last 1 day\n * `D7` - Last 7 days\n * `D30` - Last 30 days\n * `D180` - Last 180 days (roughly 6 months)\n * `D365` - Last 365 days (roughly 1 year)\n * `ALL` - For all time\n" }, "OlapCurrencyType": { "type": "string", "default": "USD", "enum": [ "USD", "ETH", "XTZ", "FLOW", "MATIC", "POL", "SOL", "MNT", "CHZ", "CELO", "FIEF", "XAI", "APT", "OAS", "QUAI", "ROSE", "BNB", "PALM", "FIVIRE", "SEI", "GLMR", "AZERO", "BERA", "TLOS", "HBAR", "VIC", "BTC", "HYPE", "XFI", "CAMP", "STT" ] }, "OlapCurrencyAmount": { "required": [ "currency", "value" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/OlapCurrencyType" }, "value": { "type": "number", "description": "Amount of currency", "format": "bigdecimal" } } }, "OlapPriceWithUsd": { "required": [ "currency", "value" ], "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "description": "Amount of currency", "format": "bigdecimal" }, "valueUsd": { "type": "number", "description": "Amount in USD", "format": "bigdecimal" } } }, "OlapHistoryValuesByTimestamps": { "required": [ "timestamps", "values" ], "type": "object", "properties": { "timestamps": { "type": "array", "description": "Timestamps of historical statistics", "items": { "type": "integer", "format": "int64", "description": "Unix epoch of historical statistics" } }, "values": { "type": "array", "description": "Values of historical statistics", "items": { "type": "number", "description": "Value of historical statistics", "format": "bigdecimal" } } } }, "OlapCurrencyAmountWithChange": { "required": [ "currency", "value" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/OlapCurrencyType" }, "value": { "type": "number", "description": "Amount of currency", "format": "bigdecimal" }, "changePercent": { "type": "number", "description": "Change in percent. Calculated as / - 1", "format": "bigdecimal" } } }, "OlapIntegerNumberWithChange": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "Value of integer number", "format": "int64" }, "changePercent": { "type": "number", "description": "Change in percent. Calculated as / - 1", "format": "bigdecimal" } } }, "OlapTrendingCollectionEntry": { "required": [ "id", "numberOfSales", "volumeNative", "volumeUsd" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of collection" }, "numberOfSales": { "$ref": "#/components/schemas/OlapIntegerNumberWithChange" }, "volumeUsd": { "$ref": "#/components/schemas/OlapCurrencyAmountWithChange" }, "volumeNative": { "$ref": "#/components/schemas/OlapCurrencyAmount" }, "floorPrice": { "$ref": "#/components/schemas/OlapCurrencyAmount" } } }, "OlapError": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code", "enum": [ "INVALID_INPUT", "NOT_FOUND", "UNKNOWN" ] }, "message": { "type": "string", "description": "Message" } } }, "OlapUserLeaderboardEntry": { "required": [ "id", "items", "transactions", "volumeNative", "volumeUsd" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of user" }, "volumeUsd": { "$ref": "#/components/schemas/OlapCurrencyAmount" }, "volumeNative": { "$ref": "#/components/schemas/OlapCurrencyAmount" }, "items": { "type": "integer", "description": "(non-unique) amount of traded items", "format": "int64" }, "transactions": { "type": "integer", "description": "Amount of transactions were made", "format": "int64" } } }, "OlapUserType": { "type": "string", "enum": [ "sellers", "buyers" ] }, "OlapPlatformSource": { "type": "string", "enum": [ "RARIBLE", "OPEN_SEA" ] }, "OlapTradesLeaderboardSort": { "type": "string", "default": "VOLUME_USD_DESC", "enum": [ "VOLUME_USD_ASC", "VOLUME_USD_DESC", "COLLECTION_ASC", "COLLECTION_DESC" ], "description": "Sort order:\n * `VOLUME_USD_ASC` - sort by usd collection volume, ascending order\n * `VOLUME_USD_DESC` - sort by usd collection volume, descending order\n * `COLLECTION_ASC` - sort by collection id, ascending order\n * `COLLECTION_DESC` - sort by collection id, descending order\n" }, "OlapLeaderboardSort": { "type": "string", "default": "VOLUME", "enum": [ "VOLUME", "VOLUME_CHANGE", "FLOOR", "FLOOR_CHANGE", "SALES", "SALES_CHANGE", "LISTED", "OWNERS" ] }, "OlapLeaderboardSortDirection": { "type": "string", "default": "DESC", "enum": [ "ASC", "DESC" ] }, "OlapTradesLeaderboardSourceGroup": { "type": "string", "enum": [ "RARIBLE", "EXTERNAL" ], "description": "Source group:\n * `RARIBLE` - source group includes rarible sources (rarible.com + all communities)\n * `EXTERNAL` - source group includes external marketplaces as sources\n" }, "OlapCollectionVolumeRankingResponse": { "type": "object", "properties": { "continuation": { "type": "string" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OlapCollectionLeaderboardEntry" } } } }, "OlapCollectionLeaderboardResponse": { "type": "object", "properties": { "continuation": { "type": "string" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OlapCollectionLeaderboardItem" } } } }, "OlapUserVolumeRankingResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/OlapUserLeaderboardEntry" } } } }, "OlapCollectionLeaderboardEntry": { "required": [ "id", "itemsBought", "listed", "ownersCount", "totalItemSupply", "volumeNative", "volumeUsd" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of collection" }, "volumeUsd": { "$ref": "#/components/schemas/OlapCurrencyAmountWithChange" }, "volumeNative": { "$ref": "#/components/schemas/OlapCurrencyAmount" }, "itemsBought": { "type": "integer", "format": "int32" }, "floorPrice": { "$ref": "#/components/schemas/OlapCurrencyAmountWithChange" }, "listed": { "type": "integer", "format": "int32" }, "totalItemSupply": { "type": "integer", "format": "int32" }, "ownersCount": { "type": "integer", "format": "int32" } } }, "OlapCollectionLeaderboardItem": { "required": [ "id", "sales", "volume", "floorHistory", "globalStats" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of collection" }, "sales": { "type": "integer", "format": "int64" }, "volume": { "$ref": "#/components/schemas/OlapPriceWithUsd" }, "floorChangePercent": { "type": "number", "format": "bigdecimal" }, "floorHistory": { "$ref": "#/components/schemas/OlapHistoryValuesByTimestamps" }, "globalStats": { "$ref": "#/components/schemas/OlapCollectionLeaderboardStatistics" } } }, "OlapCollectionLeaderboardStatistics": { "type": "object", "required": [ "listed", "items", "owners" ], "properties": { "listed": { "type": "integer", "format": "int64" }, "items": { "type": "integer", "format": "int64" }, "owners": { "type": "integer", "format": "int64" }, "floor": { "$ref": "#/components/schemas/OlapPriceWithUsd" }, "topOffer": { "$ref": "#/components/schemas/OlapPriceWithUsd" } } }, "OlapLeaderboardPeriod": { "type": "string", "enum": [ "MIN5", "MIN30", "H1", "H6", "D1", "D7", "D30", "ALL" ], "description": "Period:\n * `MIN5` - Last 5 minutes\n * `MIN30` - Last 30 minutes\n * `H1` - Last 1 hour\n * `H6` - Last 6 hours\n * `D1` - Last 1 day\n * `D7` - Last 7 days\n * `D30` - Last 30 days\n * `ALL` - For all time\n" }, "OlapStatsGraphResponse": { "required": [ "historicalDates", "historicalValues" ], "type": "object", "properties": { "historicalDates": { "type": "array", "description": "Dates of historical statistics", "items": { "type": "string", "description": "Dates of historical statistics" } }, "historicalValues": { "type": "array", "description": "Values of historical statistics", "items": { "type": "number", "description": "Values of historical statistics", "format": "bigdecimal" } }, "currentValue": { "type": "number", "description": "Current value", "format": "bigdecimal" } } }, "OlapGeneralStatsResponse": { "required": [ "highestSale", "items", "listed", "owners", "volume" ], "type": "object", "properties": { "highestSale": { "type": "number", "description": "Highest worth transaction in collection", "format": "bigdecimal" }, "floorPrice": { "type": "number", "description": "Minimal price of nft in this collection available on rarible", "format": "bigdecimal" }, "marketCap": { "type": "number", "description": "Market cap of collection (floor price * total item supply)", "format": "bigdecimal" }, "listed": { "type": "integer", "description": "Amount of currently listed items", "format": "int32" }, "items": { "type": "integer", "description": "Total item supply of all nfts in the collection", "format": "int32" }, "owners": { "type": "integer", "description": "Current amount of unique owners who hold nfts of this collection", "format": "int32" }, "volume": { "type": "number", "description": "Total worth of all transactions were made with nfts in this collection", "format": "bigdecimal" } } }, "OlapCollectionStatisticsResponse": { "required": [ "highestSale", "items", "listed", "owners", "volume", "marketCap", "floorPrice" ], "type": "object", "properties": { "highestSale": { "description": "Highest worth transaction in collection", "type": "array", "items": { "$ref": "#/components/schemas/OlapCurrencyAmount" } }, "floorPrice": { "description": "Minimal price of nft in this collection available on rarible", "type": "array", "items": { "$ref": "#/components/schemas/OlapCurrencyAmount" } }, "marketCap": { "description": "Market cap of collection (floor price * total item supply)", "type": "array", "items": { "$ref": "#/components/schemas/OlapCurrencyAmount" } }, "volume": { "description": "Total worth of all transactions were made with nfts in this collection", "type": "array", "items": { "$ref": "#/components/schemas/OlapCurrencyAmount" } }, "listed": { "type": "integer", "description": "Amount of currently listed items", "format": "int32" }, "items": { "type": "integer", "description": "Total item supply of all nfts in the collection", "format": "int32" }, "owners": { "type": "integer", "description": "Current amount of unique owners who hold nfts of this collection", "format": "int32" } } }, "OlapGlobalCollectionStatisticsResponse": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CollectionId" }, "listed": { "type": "integer", "format": "int64" }, "items": { "type": "integer", "format": "int64" }, "owners": { "type": "integer", "format": "int64" }, "floor": { "$ref": "#/components/schemas/OlapPriceWithUsd" }, "volume": { "description": "Total worth of all transactions with items in this collection", "$ref": "#/components/schemas/OlapPriceWithUsd" } }, "required": [ "listed", "items", "owners", "volume" ] }, "OlapPeriodCollectionsByIdsStatisticsRequest": { "type": "object", "properties": { "collectionIds": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string" } }, "period": { "$ref": "#/components/schemas/OlapPeriod" } }, "required": [ "collectionIds", "period" ] }, "OlapPeriodCollectionStatisticsResponse": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CollectionId" }, "period": { "$ref": "#/components/schemas/OlapPeriod" }, "volume": { "description": "Period (e.g., 1-day) worth of all transactions with items in this collection", "$ref": "#/components/schemas/OlapPriceWithUsd" }, "floorChangePercent": { "description": "Change in floor price in percent during the period.", "type": "number", "format": "bigdecimal" } }, "required": [ "period", "volume" ] }, "OlapPricesResponse": { "required": [ "avgPrices", "dates", "medianPrices", "minPrices", "sumPrices" ], "type": "object", "properties": { "dates": { "type": "array", "description": "Dates of historical statistics", "items": { "type": "string", "description": "Dates of historical statistics" } }, "avgPrices": { "type": "array", "description": "Average prices of nfts in this collection for every date", "items": { "type": "number", "description": "Average price of nfts in this collection for specific date", "format": "bigdecimal" } }, "medianPrices": { "type": "array", "description": "Median prices of nfts in this collection for every date", "items": { "type": "number", "description": "Median price of nfts in this collection for specific date", "format": "bigdecimal" } }, "minPrices": { "type": "array", "description": "Minimum prices of nfts in this collection for every date", "items": { "type": "number", "description": "Minimum price of nfts in this collection for specific date", "format": "bigdecimal" } }, "sumPrices": { "type": "array", "description": "Volumes for the collection for every date", "items": { "type": "number", "description": "Collection volume for specific date", "format": "bigdecimal" } } } }, "OlapOwnerStatistics": { "type": "object", "properties": { "owners": { "type": "array", "items": { "$ref": "#/components/schemas/OlapOwnerStatistic" } }, "continuation": { "type": "string", "description": "Continuation token to paginate result" } }, "required": [ "owners" ] }, "OlapOwnerStatistic": { "type": "object", "properties": { "owner": { "$ref": "#/components/schemas/UnionAddress" }, "ownedItems": { "type": "integer", "format": "int64" } }, "required": [ "owner", "ownedItems" ] }, "OlapBidsByPriceSort": { "type": "string", "default": "PRICE", "enum": [ "PRICE", "VOLUME_NATIVE" ] }, "OlapBidsByPriceStatistics": { "type": "object", "properties": { "maxVolumeNative": { "type": "number", "format": "bigdecimal" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/OlapBidsByPrice" } }, "continuation": { "type": "string", "description": "Continuation token to paginate result" } }, "required": [ "prices", "maxVolumeNative" ] }, "OlapBidsByPrice": { "type": "object", "properties": { "price": { "type": "number", "format": "bigdecimal" }, "bidsCount": { "type": "integer", "format": "int64" }, "volumeNative": { "type": "number", "format": "bigdecimal" }, "buyersCount": { "type": "integer", "format": "int64" }, "buyer": { "$ref": "#/components/schemas/UnionAddress" } }, "required": [ "price", "bidsCount", "volumeNative", "volumeRatio", "buyersCount" ] }, "OlapChartResponse": { "type": "object", "properties": { "dataPoints": { "$ref": "#/components/schemas/OlapHistoryValuesByTimestamps" } }, "required": [ "dataPoints" ] }, "OlapVolumeForPeriodData": { "type": "object", "required": [ "collectionId", "volumeNative", "volumeUsd", "updatedAt" ], "properties": { "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "period": { "$ref": "#/components/schemas/OlapLeaderboardPeriod" }, "volumeNative": { "type": "number", "format": "bigdecimal", "description": "volume in native currency for the given period, if period is null it is total volume" }, "volumeUsd": { "type": "number", "format": "bigdecimal", "description": "volume in usd for the given period, if period is null it is total volume" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated in the olap database" } } }, "OlapCollectionVolumeChangeEvent": { "type": "object", "required": [ "@type", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OlapVolumeForPeriodData" } }, "@type": { "type": "string", "enum": [ "VOLUME_CHANGE" ] } } }, "OlapCollectionFloorPriceByCurrencyChangeEvent": { "type": "object", "description": "Sent when there is a new cheapest order for the given currency", "required": [ "@type", "currencyId", "updatedAt" ], "properties": { "orderId": { "type": "string", "description": "ID of the floor order or null if there is no order" }, "price": { "type": "number", "format": "bigdecimal", "description": "price of the floor order or null if there is no order" }, "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated in the olap database" }, "@type": { "type": "string", "enum": [ "FLOOR_PRICE_BY_CURRENCY_CHANGE" ] } } }, "OlapCollectionTopPriceByCurrencyChangeEvent": { "type": "object", "description": "Sent when there is a new top order for the given currency", "required": [ "@type", "currencyId", "updatedAt" ], "properties": { "price": { "type": "number", "format": "bigdecimal", "description": "price of the floor order or null if there is no order" }, "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated in the olap database" }, "@type": { "type": "string", "enum": [ "TOP_PRICE_BY_CURRENCY_CHANGE" ] } } }, "OlapCollectionEvent": { "type": "object", "required": [ "collectionId", "eventId", "data" ], "properties": { "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "eventId": { "type": "string" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "oneOf": [ { "$ref": "#/components/schemas/OlapCollectionVolumeChangeEvent" }, { "$ref": "#/components/schemas/OlapCollectionFloorPriceByCurrencyChangeEvent" }, { "$ref": "#/components/schemas/OlapCollectionTopPriceByCurrencyChangeEvent" } ] }, "OlapCollectionStatsEvent": { "type": "object", "required": [ "collectionId", "eventId", "data" ], "properties": { "eventId": { "type": "string" }, "collectionId": { "$ref": "#/components/schemas/CollectionId" }, "eventTimeMarks": { "$ref": "#/components/schemas/EventTimeMarks" } }, "oneOf": [ { "$ref": "#/components/schemas/OlapCollectionStatsVolumeChangeEvent" }, { "$ref": "#/components/schemas/OlapCollectionStatsFloorChangeEvent" }, { "$ref": "#/components/schemas/OlapCollectionStatsTopOfferChangeEvent" } ] }, "OlapCollectionStatsVolumeChangeEvent": { "type": "object", "required": [ "@type", "data" ], "properties": { "data": { "$ref": "#/components/schemas/OlapCollectionStatsVolumeChangeData" }, "@type": { "type": "string", "enum": [ "VOLUME_CHANGE" ] } } }, "OlapCollectionStatsFloorChangeEvent": { "type": "object", "required": [ "@type", "data" ], "properties": { "data": { "$ref": "#/components/schemas/OlapCollectionStatsFloorChangeData" }, "@type": { "type": "string", "enum": [ "FLOOR_CHANGE" ] } } }, "OlapCollectionStatsTopOfferChangeEvent": { "type": "object", "required": [ "@type", "data" ], "properties": { "data": { "$ref": "#/components/schemas/OlapCollectionStatsTopOfferChangeData" }, "@type": { "type": "string", "enum": [ "TOP_OFFER_CHANGE" ] } } }, "OlapCollectionStatsVolumeChangeData": { "type": "object", "required": [ "period", "currencyId", "volumeNative", "volumeUsd", "updatedAt" ], "properties": { "period": { "$ref": "#/components/schemas/OlapPeriod" }, "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "volumeNative": { "type": "number", "format": "bigdecimal", "description": "volume in native currency for the given period, if period is null it is total volume" }, "volumeUsd": { "type": "number", "format": "bigdecimal", "description": "volume in usd for the given period, if period is null it is total volume" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated" } } }, "OlapCollectionStatsFloorChangeData": { "type": "object", "required": [ "period", "currencyId", "updatedAt" ], "properties": { "period": { "$ref": "#/components/schemas/OlapPeriod" }, "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "floorNative": { "type": "number", "format": "bigdecimal", "description": "floor price in native currency for the given period, if period is null it is global floor price" }, "floorUsd": { "type": "number", "format": "bigdecimal", "description": "floor price in usd for the given period, if period is null it is global floor price" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated" }, "floorHistory": { "description": "historical floor prices for the given period", "$ref": "#/components/schemas/OlapHistoryValuesByTimestamps" } } }, "OlapCollectionStatsTopOfferChangeData": { "type": "object", "required": [ "currencyId", "updatedAt" ], "properties": { "currencyId": { "$ref": "#/components/schemas/CurrencyId" }, "topOfferNative": { "type": "number", "format": "bigdecimal", "description": "top offer price in native currency for the given period, if period is null it is global top offer price" }, "topOfferUsd": { "type": "number", "format": "bigdecimal", "description": "top offer price in usd for the given period, if period is null it is global top offer price" }, "updatedAt": { "type": "string", "format": "date-time", "description": "when the value was updated" } } }, "ReconciliationEntities": { "type": "object", "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationEntity" } }, "continuation": { "type": "string" } }, "required": [ "entities" ] }, "ReconciliationEntity": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean", "default": false } }, "required": [ "id", "version", "lastUpdatedAt" ] } }, "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" } } } } } } }