Marketplace APIs
With this set of endpoints, developers can search and filter metadata, retrieve market listings and determine indicative prices so that players can seamlessly explore, value and trade assets.
Summary
The Marketplace APIs are an extension of Immutable’s Blockchain Data APIs, allowing players to easily discover assets they desire through metadata search, and in addition, see the approximate price of any asset without needing to view with the orderbook. With pre-approved transactions compatibility, players can seamlessly search for desired assets, value their inventory, submit orders and executes trades, all whilst remaining fully immersed in-game.
What are the Marketplace APIs?
The Marketplace APIs focus on metadata search and asset valuation, providing developers with multiple new and enhanced endpoints to supplement the back-end of their implementations:
Custom Marketplace: Anyone can easily build an in-game or custom marketplace without needing to worry about the back-end implementation. Game studios can therefore retain maker/taker fees and keep players in-game without compromising on their trading experience.
Asset Discovery: With advanced metadata search and filter functionality; platform liquidity gets a significant boost as players find desirable assets quickly.
Indicative Pricing: Indicative price feeds allow players to see an asset’s approximate value, without needing to study the orderbook. With support for custom ERC-20s, this feature can support each game’s unique economic model.
Inventory Management: With the ability to show players what assets they own and their indicative values at a glance, studios can now build immersive in-game trading experiences.
Why Marketplace APIs?
The Marketplace APIs address a critical challenge in web3 game development: enabling a seamless trading experience with ample liquidity, without disrupting player immersion, all whilst maximising studio revenues.
Player benefits:
- Find assets that players want quickly through metadata search
- See the value of their inventory at a glance
- Simplify asset listing process whilst remaining immersed in-game
Studio benefits:
- Focus engineering effort on the front-end experience whilst Immutable handles the back-end
- Retain maker/taker fees and minimise reliance of 3rd-party marketplaces
- Increased player engagement given these critical capabilities can now be executed in-game
Limitations
The Marketplace API supports results that are stacked by Metadata ID. Additionally, Marketplace API endpoints are subject to the standard platform rate limits described here.
How do I implement the Marketplace APIs?
Follow our tutorial to implement your own in-game or custom marketplace. Then explore our new endpoints below to enhance your marketplace with metadata search and indicative pricing.
The relevant endpoints for the Marketplace API can be found here:
| Endpoint | Domain | Description |
|---|---|---|
| ListStacks | Metadata | Given a particular metadata stack, get market listings, last trade prices and the number of assets in the stack. |
| ListFilters | Metadata Search | Get the number of assets with a specific trait value grouped by metadata category filters. |
| SearchNFTs | Metadata Search | Given a collection and wallet address (player inventory), get a list of metadata stacks with market listings, floor price and most recent trade details. |
| SearchStacks | Metadata Search | Similar to SearchNFTs but with the ability to search by metadata description, name and asset traits. |
| QuotesForStacks | Pricing | Given a particular metadata stack ID, get market listing and pricing details for said metadata stack as well as the whole collection. |
| QuotesForNFTs | Pricing | Given a specific token ID, get last trade details for the asset as well as market details for its related metadata stack and collection. |