Data points for primary market
| Data point | Description | Search/Filter/Sort Usage |
|---|---|---|
| collectionId | Collection/Drop UUID | |
| collectionItemId | Collection/Listing item UUID | search |
| saleType | Type of sale (Buy/Auction/Claim) | search/filter |
| slug | Listing item slug | search |
| name | Listing name | search |
| createdAt | Listing created date | sort |
| asset | Asset object for listing thumbnail | |
| asset.currentVersion | Asset obj has a sub object for current version | |
| asset.currentVersion.cdnUrl | Listing thumbnail url | |
| collectionItemDetails | Listing details object | |
| collectionItemDetails.endDate | Sale end date | sort |
| collectionItemDetails.startDate | Sale start date | sort |
| collectionItemDetails.lotId | Sale lot id | |
| collectionItemDetails.totalAvailableUnits | Buy now available units | |
| collectionItemDetails.unitPrice | Buy now price | |
| collectionItemDetails.totalUnits | But now total units | |
| collectionItemDetails.maxEndDate | Auction max end date | |
| collectionItemDetails.reservePrice | Auction reserve price | |
| collectionItemDetails.startingBid | Auction starting bid | |
| collectionItemDetails.status | Auction status(Active/Hidden) | |
| collectionItemDetails.subSaleType | Sub sales type | search/filters |
| collectionItemDetails.currentBid | Auction current bid object | |
| collectionItemDetails.currentBid.amount | Latest bid amount | |
| collectionItemDetails.currentBid.isCurrent | Latest bid flag | |
| collectionItemDetails.currentBid.currentBid | Latest bid amount | |
| collectionItemDetails.currentBid.nextBidIncrement | Next bid value | |
| bidDetails | Array of all bids | |
| bidDetails.currentBid | Bid value | |
| bidDetails.maximumBid | Bid max value | |
| bidDetails.id | Bid id | |
| bidDetails.createdAt | Bid created date | |
| nfts | NFTs array for sale object | |
| nfts.name | Nft name | search |
| nfts.nftTokenId | Nft token UUID | |
| nfts.owner | Nft owner address | |
| nfts.tokenId | Nft onchain id | |
| nfts.tokenType | Nft token type (ERC721/ERC1155) | search/filter |
| nfts.contractAddress | Nft contract address | search |
| nfts.networkId | NFT network id | |
| nfts.image | NFT image URL | |
| nfts.animationURL | NFT animation URL | |
| nfts.attributes | NFT attributes array object | search/filters |
| nfts.attributes.traitType | Trait type | |
| nfts.attributes.traitValue | Trait value |
Sample search query
{
"size": 10,
"from": 0,
"sort": [
{
"createdAt": "desc" // Replace "createdAt" with the field you want to sort by
}
],
"_source": [],
"query": {
"bool": {
"must": [
{
"query_string": {
"query": "*apple*" // Replace with your desired search term
}
}
]
}
}
}Data points for secondary market
| Data point | Description | Search/Filter/Sort Usage |
|---|---|---|
| artist | Artist object | |
| artist.id | Artist UUID | |
| artist.name | Artist name | search/filter |
| search/filter | Artist slug | search/filter |
| category | Category object | |
| category.id | Category UUID | |
| category.name | Category name | search/filter |
| category.slug | Category slug | search/filter |
| createdAt | Registry created date | sort |
| isBuyNowEnabled | Is this buy enabled token | |
| isMakeOfferEnabled | Is this accepting offers | |
| listingStatus | NFT listing status | |
| media_backup_extension | Backup media file extension | |
| media_backup_type | Backup media type | |
| media_backup_url | Backup media url | |
| media_source_extension | Source media file extension | |
| media_source_type | Source media type | |
| media_source_url | Source media url | |
| metadataJSON | NFT metadata | search/filter |
| mintedAt | Mint date | |
| networkID | NFT network UUID | |
| networkName | NFT network name | |
| nftContractName | NFT contract name | |
| nftTokenId | NFT UUID | |
| owners | NFT owner address | search |
| status | NFT status (OPEN_FOR_SALE/NEW) | search/filter |
| tokenID | NFT token id | |
| tokenName | NFT token name | |
| tokenOwnerAddress | NFT owner address | |
| tokenType | NFT token type | |
| tokenURI | NFT token URI | |
| price | Price object | Sorting can be done using the below objects as part of prices |
| price.LastPurchasedPrice | Last price object | |
| price.MakeOfferHighestPrice | Highest offer object | |
| price.MakeOfferLatestPrice | Latest offer object | |
| price.buynowPrice | Listed price | |
| price.xxx.unit | USD/ETH/MATIC | |
| price.xxx.type | FIAT/CRYPTO | |
| price.xxx.value | Price value | |
| orderHistories | Order history object (Can be used for provenance. If required this object can also be used for search) | |
| orderHistories.orderType | Order type (List/Offer) | |
| orderHistories.quantity | Order qty for sale | |
| orderHistories.tokenId | Onchain token id | |
| orderHistories.tokenContract | Contract address | |
| orderHistories.orderStatus | Order status | |
| orderHistories.signerAddress | Order signer address | |
| orderHistories.fixedPrice | Order price | |
| orderHistories.platformFee | Order fee value | |
| orderHistories.nftOwnerAddress | Nft owner address | |
| orderHistories.id | Order UUID | |
| orderHistories.nftTokenId | NFT UUID | |
| orderHistories.price | Price object |
Sample postman request/response
Please use the below postman sample request/response for better understandings
Updated 4 months ago