🔗 Link to plugin page: https://zeroqode.com/version-live/plugin/advanced-rarible-nft-protocol-1681473289474x274018688003391900
Demo to preview the plugin:
Introduction
This plugin is much more lightweight and robust than the previous version of Rarible SDK.
Creating NFT Marketplace with Rarible SDK is super easy.
The plugin comes with 51 API calls to get various data and a Rarible SDK element with 9 different actions such as Create collection, Mint, Create Order, Cancel Order, Fill Order, Transfer, Burn, Connect Tezos Wallet and Disconnect Tezos Wallet.
Compatible with the Advanced Metamask and Pinata- NFT storage on IPFS plugins.
Prerequisites
To interact with the Rarible plugin, you will need an additional installation of the Pinata plugin and Metamask. You will also need the accounts.
Pinata - https://www.pinata.cloud/
Metamask - https://metamask.io/
Rarible SDK
How to setup
Example:
Place an element on the page. The element must be visible on the page.
Plugin Element Properties
The plugin contains a visual element that should be used on a page.
Field Name | Description |
Environment | The node you work with. |
Wallet Type | The wallet that was used to connect to your app.
Currently works only with Metamask wallet. |
Element Actions
1. Create a collection
You can Create NFT Collection with Rarible Multichain Protocol in different blockchains.
Field Name | Description |
assetType | NFT collection type: ERC721 or ERC1155 for ETHEREUM, NFT or MT for TEZOS |
name | name of the collection. |
symbol | symbol of the collection. Example: MYNFT |
isusertoken | Privat (true) or public (false) collection |
2. Mint
You can Mint NFTs with Rarible Multichain Protocol in different blockchains.
Field Name | Description |
Minting Type | “Lazy” “Regular” : With Lazy Minting you can defer the gas costs of minting the NFT to the first buyer. The token is minted on the blockchain once someone buys it. |
Token Contract | HexAddress . Exemple = 0xB0EA149212Eb707a1E5FC1D2d3fD318a8d94cf05 |
URI | address of JSON file with "image", "name" and other NFT attributes.
For example IPFS: https://ipfs.io/ipfs/QmWLsBu6nS4ovaHbGAXprD1qEssJu4r5taQfB74sCG51tp |
Supply | More than 1 is only for ERC1155 type |
Wallet:Amount | Each wallet should be followed by a colon and the amount right after it
Example: 0x9DF3B01aeE76D0eDcC48873667f6F05B4F94A288:0.01 |
Token ID | Optional. Used when the token ID is generated separately using the Generate ID action. |
3. Create a bid
You can place your bid for any given NFT, even if there isn't any sell offer associated with it. It's up to the owner if they accept it or not.
Field Name | Description |
Order Type | Sell or Bid |
NFT Contract Address | The contract address can be found on the home page of the NFT collection or next to a particular NFTs token ID and other metadata
Exemple : 0xFca59Cd816aB1eaD66534D82bc21E7515cE441CF |
Token ID | The NFT Id of the token on which we want to sell. |
Sell/Bid With | ETH By default. To use an ERC20 token, insert the ERC20 contract address in this field. Note that a bid can be placed only with an ERC20 token. Native token can be used only for sell orders. |
Price | In ETH or ERC20 |
Amount | More than 1 is acceptable only for ERC1155 tokens |
Wallet:Amount | Each wallet should be followed by a colon an the amount right after it. Example : 0x9DF3B01aeE76D0eDcC48873667f6F05B4F94A288:0.01 |
4. Cancel a bid
To cancel a bid
Field Nameф | Descrition |
Hash | Id of your order |
5. Buy an NFT
You can buy NFTs with Rarible Multichain Protocol on different blockchains.
Field Name | Description |
Type | “Accept BID” “Buy” |
Order Hash | Id of NFT sale order, has format ${blockchain}:${orderId} Example: ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143 |
Amount | Amount of asset to buy/bid, more than 1 is used only for ERC1155 assets |
6. Transfer
You can transfer NFTs with Rarible Multichain Protocol in different blockchains.
Field Name | Description |
NFT Contract | HexAddress . Exemple = 0xB0EA149212Eb707a1E5FC1D2d3fD318a8d94cf05 |
Token ID | Token id. |
Receiver Address | Receiver Address. Example: 0xFca59Cd816aB1eaD66534D82bc21E7515cE441CF |
Amount | An amount of NFT tokens |
7. Burn
You can burn NFTs with Rarible Multichain Protocol in different blockchains.
Burning tokens is equivalent to sending them to address 0x0 because nobody has a private key for that.
Field Name | Description |
NFT Contract | HexAddress . Exemple = 0xB0EA149212Eb707a1E5FC1D2d3fD318a8d94cf05 |
Token ID | Token id. |
Exposed states
Name | Description | Type |
Order Stage | Approve, Sign, Sell order placed, Bid order placed, Canceled | text |
Created Collection Address | HexAddress . Exemple = 0xB0EA149212Eb707a1E5FC1D2d3fD318a8d94cf05 | text |
Created Collection TX | Created collection transaction hash. | text |
Creating a collection error message | Error text for creating a collection when it was wrong | text |
minted_token_id | Minted token id | text |
minted_token_item_id | Minted token item | text |
minted tx hash | Transaction hash for minted | text |
Order hash | Hash order. | text |
Error create order | Error text for creating order when it was wrong | text |
NFT transfer hash id | Hash id for transfer NFT. | text |
Error transfer message | Error text for creating a transfer when it was wrong | text |
Error Token Burned | Error text for token burned if was wrong | text |
Error Minted | Error text for minted it was wrong | text |
ㅤ | ㅤ | ㅤ |
Element Events
Name | Description |
Creating Collection Success | Triggered when the collection is created. |
Creating Collection Error | Triggered when create collection returns an error |
Token minted | Triggered when the token was minted |
Error while placing bid | Triggered when bid placing was wrong |
Bid order placed | Triggered when bid order was placed |
Sell order placed | Triggered when sell order was placed |
Error while placing transferring | Triggered when placing transferring was wrong |
Token Transferred | Triggered when the token was transferred |
Token Burned | Triggered when the token was burned |
Error while token burned | Triggered when token burn while error |
Error while placing buy item | Triggered when placing buy item was wrong |
Error while placing minting | Triggered when placing minting was wrong |
Buy item order placed | Triggered when item order was placed |
Error while order cancelled | Triggered when order cancelled was placed |
Order cancelled success | Triggered when order cancelled success |
Rarible API
1. validate
Validation of the order signature
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- signer - Blockchain address in Union format ${blockchainGroup}:${token}.
- publicKey - The creator's public key .
- message - String.
- signature - Digital signature of the signer .
Return :
- 200 OK
- 400 Bad Request
- 500 Internal Server Error
2. getCurrencyUsdRateByCurrencyId
Get currency USD rate by currency id
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- currencyId - Blockchain address in Union format ${blockchainGroup}:${token}. Currency Id, has format ETHEREUM:${token} or ETHEREUM:${token}:${tokenId}
Example: ETHEREUM:0x0000000000000000000000000000000000000000
- at - Date and time for getting currency USD rate. Example: at=2022-01-01T12:00:00Z
Return :
- symbol - Currency Symbol (string)
- rate - string (BigDecimal)
- date - Date and time of currency USD rate (string)
3. getAllCurrencies
Get all registered currencies
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
Return :
- currencies :
- currencyId - Currency Id, has format
ETHEREUM:${token}orETHEREUM:${token}:${tokenId}(string) - symbol - string.
- alias - Alias to real coin, 'usd' means 1:1 to USD (string)
4. getItemById
Returns Item by Id
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- itemId - tem Id, has format ETHEREUM:${token}:${tokenId} Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
Return :
- id - Item Id, has format
ETHEREUM:${token}:${tokenId}(string).
- blockchain - Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX” (string).
- collection - Collection Id, has format
ETHEREUM:${nativeICollectionId}(string).
- contract - Blockchain contract address in Union format
ETHEREUM:${token}(string).
- tokenId - string.
- creators - Array of objects (Creator) : Default: [] , Creators of the target item
- account - Blockchain address in Union format
${blockchainGroup}:${token}(string). - value - integer.
- lazySupply - string.
- pending : Array of objects (ItemTransfer) - Pending information about the item.
- @type - Value: "TRANSFER” (string).
- from - Blockchain address in Union format
${blockchainGroup}:${token}(string).
- mintedAt - Date and time of the item minting (string).
- lastUpdatedAt - Filter condition to return only items that have been updated at this date (string).
- supply - (string).
- meta - Object (meta).
- deleted - Item was deleted or not (boolean).
- bestSellOrder - Object (order).
- bestBidOrder - Object(order).
- originOrder - Array of objects (OriginOrders)
- ammOrders - Object (AmmOrders).
- ids - List of the automated market maker order id. (Array of string).
- auctions - Array of objects (Auction).
- totalStock - string (BigInteger).
- sellers - Total count of users selling this item ATM (integer).
- LastSale - object (ItemLastSale).
- self - boolean.
- suspicious - boolean.
5. getItemByIds
Returns Items by Ids
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- ids - List of the item id. Array of strings (ItemId)
Return :
- continuation - Continuation token to paginate items search result (string).
- items - List of found items . Array of objects (Item).
- id - Item Id, has format
ETHEREUM:${token}:${tokenId}. (string) - blockchain - Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX” (string) - collection - Collection Id, has format
ETHEREUM:${nativeICollectionId}(string). - contract - Blockchain contract address in Union format
ETHEREUM:${token}. (string). - tokenId - string (BigInteger) .
- creators - Creators of the target item . Array of objects (Creator).
- account - Blockchain address in Union format
${blockchainGroup}:${token}(string). - value - integer.
- lazySupply - string (BigInteger).
- pending - Pending information about the item , Array of objects (ItemTransfer).
- @type - Value: "
TRANSFER” . (string). - from - Blockchain address in Union format
${blockchainGroup}:${token}(string). - mintedAt - Date and time of the item minting (string).
- lastUpdatedAt - Filter condition to return only items that have been updated at this date (string).
- supply - string.
- meta - object (Meta).
- deleted - Item was deleted or not (boolean).
- bestSellOrder - Object(order).
- bestBitOrder - Object(order).
- originOrder - Object(order).
- ammOrders - object (AmmOrders)
- ids - List of the automated market maker order id “Array of strings (OrderId)”.
- auctions - Array of objects (Auction).
- totalStock - string (BigInteger).
- sellers - Total count of users selling this item ATM. (integer).
- lastSale - object (ItemLastSale).
- self - boolean.
- suspicious - boolean.
6. getItemRoyaltiesById
Returns item royalty by identifier
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId}(string). - Example:
ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
Return :
- royalties - Array of objects (Royalty) :
- account - Blockchain address in Union format
${blockchainGroup}:${token}(string). - value - integer.
7. resetItemMeta
Deletes the NFT item meta by Id
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId}(string). - Example:
ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
- sync - Request meta for Item if true (bolean)
Return :
- 200 OK
8. checkItemRestriction
Check restrictions for specified user and action with item.
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId}(string). - Example:
ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
- user - Blockchain address in Union format
${blockchainGroup}:${token}(string)
Return :
- success - Boolean.
- message - string.
9. getItemsByOwner
Returns Item by owner
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- blockchains - Array of strings (Blockchain)
- Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=
ETHEREUM
- owner - Address of the item owner. Example:owner=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response (string).
- size - The number of items to return (integer).
Return :
- continuation - Continuation token to paginate items search result (string)
- items - Array of objects (items).
10. getItemsByCreator
Returns Item by creator
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- blockchains - Array of strings (Blockchain)
- Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=
ETHEREUM
- creator - Address of the item creator. Example:creator=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response (string).
- size - The number of items to return (integer).
Return :
- continuation - Continuation token to paginate items search result (string)
- items - Array of objects (items).
11. getItemsByCollection
Returns items by collection
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- collection - Address of the collection
- Exemple : collection=
ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
- continuation - Continuation token from the previous response (string).
- size - The number of items to return (integer).
Return :
- continuation - Continuation token to paginate items search result (string)
- items - Array of objects (items).
12. getItemsByOwnerWithOwnership
Returns items by owner with ownership
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- owner - Address of the owner
- Exemple : owner=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response (string).
- size - The number of items to return (integer).
Return :
- continuation - Continuation token to paginate items search result (string)
- items - Array of objects (items).
13. queryTraits
Returns possible trait values by key
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- keys - Trait keys . Example: keys=
Hat
- collectionIds - Collections identifiers to which traits belong
- Example: collectionIds=
ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6
Return :
- continuation - Continuation token to paginate items search result (string)
- traits - Array of objects (Trait)
- key - Combination of Item attribute key/value with it's count (object (TraitEntry))
- value - string.
- count - string.
- value - Array (non-empty)
- value - string.
- count - integer <int64>.
14. searchTraits
Returns combination of Item attribute key with list of values.
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- filter - filter . Example: filter=
Hat
- collectionIds - Collections identifiers to which traits belong
- Example: collectionIds=
ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6
Return :
- continuation - Continuation token to paginate items search result (string)
- traits - List of found traits (Array of objects)
- key - Combination of Item attribute key/value with it's count (object (TraitEntry))
- value - string.
- count - string.
- value - Array (non-empty)
- value - string.
- count - integer <int64>.
15. queryTraitsWithRarity
Returns the rarity of the trait
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- collectionId - string
- properties - [{
- key - string
- value - string
}]
Return :
- continuation - Continuation token to paginate items search result (string)
- traits - List of ExtendedTraitProperty (Array of objects)
- key - string.
- value - string.
- rarity - Rarity percent (number)
16. searchItems
Complex search for items
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- size -
integer <int32> [ 1 .. 1000 ]Default: 50 , Number of entities returned.
- continuation - Continuation token to paginate items search result (string)
- blockchains - Items Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- collections - Array of strings (CollectionId)
- deleted - boolean Default:
false
- names - Array of strings
- descriptions - Array of strings
- traits - Array of objects (TraitProperty)
- key - (string)
- value - (string)
- creators - Array of strings (UnionAddress)
- mintedAtFrom - string <date-time>
- mintedAtTo - string <date-time>
- lastUpdatedAtFrom - string <date-time>
- lastUpdatedAtTo - string <date-time>
- sellPriceFrom - number <double>
- sellPriceTo - number <double>
- sellCurrency - string
- sellPlatforms - Items Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH”
- bidPriceFrom - number <double>
- bidPriceTo - number <double>
- bidCurrency - string
- bidPlatforms - tems Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH”
- sort - Enum: "
LATEST" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL" "HIGHEST_BID" "LOWEST_BID”
Return :
- continuation - Continuation token to paginate items search result (string)
- items - List of found items (Array of objects)
17. getOwnershipById
Returns ownership by Id
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- ownershipId - Ownership Id in format:
'ETHEREUM:${token}:${tokenId}:${owner}’
Return :
- id - string (OwnershipId)
- blockchain - Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId}
- contractv - Collection Id, has format
ETHEREUM:${nativeICollectionId}
- tokenId - string (BigInteger)
- owner - Blockchain address in Union format
${blockchainGroup}:${token}
- value - string (BigInteger)
- source - Enum: "
MINT" "PURCHASE" "TRANSFER”
- lastUpdatedAt - string <date-time>
- creators - Creators of the target item Array of objects (Creator)
- account - Blockchain address in Union format
${blockchainGroup}:${token} - value - integer
- lazyValue - string (BigInteger)
- auction - object (Auction)
- bestSellOrder - object (Order)
- originOrder - Array of objects (OriginOrders)
18. getOwnershipsByIds
Returns Ownerships by Ids
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- ids - List of the Ownerships ids . Array of strings (OwnershipId)
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- ownership - List of found ownerships [Array of objects (Ownership)]
19. getOwnershipsByItem
Returns ownerships by item
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId}. string (ItemId)
- continuation - Continuation token from the previous response (string)
- size - The number of items to return (integer)
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- ownership - List of found ownerships [Array of objects (Ownership)]
20. searchOwnerships
Complex ownerships search
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- size - The number of items to return (integer)
- continuation - Continuation token from the previous response (string)
- Blockchain - Items Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- owners - Array of strings (UnionAddress)
- collections - Array of strings (CollectionId)
- items - Array of strings (ItemId)
- auctions - Array of strings (AuctionId)
- auctionsOwners - Array of strings (UnionAddress)
- beforeDate - string <date-time>
- afterDate - string <date-time>
- sellPriceFrom - number <double>
- sellPriceTo - number <double>
- sellCurrency - string
- sellPlatforms - Items Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH”
- sort - Enum: "
LATEST" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL”
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- ownership - List of found ownerships [Array of objects (Ownership)]
21. getOrderById
Returns order by Id
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- id - Order Id, has format 'ETHEREUM:${id}’
- Example:
ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143
Return :
- id - string (OrderId)
- fill - string (BigDecimal)
- platform - string (Platform) Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- status - string (OrderStatus) Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
- startedAt - string <date-time>
- endedAt - string (BigDecimal)
- cancelled - boolean
- optionalRoyalties - boolean Default:
false
- createdAt - string <date-time>
- lastUpdatedAt - string <date-time>
- dbUpdatedAt - string <date-time>
- makePrice - string (BigDecimal)
- takePrice - string (BigDecimal)
- makePriceUsd - string (BigDecimal)
- takePriceUsd - string (BigDecimal)
- maker - Blockchain address in Union format
${blockchainGroup}:${token}
- taker - lockchain address in Union format
${blockchainGroup}:${token}
- make - object (Asset)
- take - object (Asset)
- salt - (string)
- signature - (string)
- pending - Pending information about the order (Default: [object])
- data - object
22. getOrdersByIds
Returns the orders that have been put on sale
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- ids - Array of the orders Ids in format 'ETHEREUM:${id}’. Array of strings
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
23. getOrdersAll
Returns all orders
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- blockchains - Type of the blockchain network Items Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" - Example: blockchains=
ETHEREUM
- continuation - Continuation token from the previous response (string)
- size - The number of items to return (string)
- sort - Order sort Enum: "
LAST_UPDATE_ASC" "LAST_UPDATE_DESC"
- status - Order status Items Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
24. getAllSync
Returns all orders sorting by data base update.
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- blockchain - Type of the blockchain network Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" - Example: blockchain=
ETHEREUM
- continuation - Continuation token from the previous response
- size - The number of items to return
- sort - Order sort. Enum: "
DB_UPDATE_ASC" "DB_UPDATE_DESC"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
25. getSellOrdersByMaker
Returns sell orders by maker
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- blockchain - Type of the blockchain network Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" - Example: blockchain=
ETHEREUM
- platform - The platform where the order was created. Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- maker - The maker of the order .
- Example: maker=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- origin - Address of the consumer to receive the commission for the order .
- Example: origin=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response
- size - The number of items to return.
integer >= 1
- status - Order status Items. Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
26. getSellOrdersByItem
Returns sell orders by item
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- platform - The platform where the order was created. Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId} - Example:
itemId=ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
- maker - The maker of the order .
- Example: maker=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- origin - Address of the consumer to receive the commission for the order .
- Example: origin=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response
- size - The number of items to return.
integer >= 1
- status - Order status Items. Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
27. getSellOrders
Returns all sell orders
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- blockchain - Type of the blockchain network Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" - Example: blockchain=
ETHEREUM
- platform - The platform where the order was created. Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- origin - Address of the consumer to receive the commission for the order .
- Example: origin=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response
- size - The number of items to return.
integer >= 1
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
28. getOrderBidsByMaker
Returns order bids by maker
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- maker - The maker of the bid
- Example: maker=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- blockchain - Type of the blockchain network Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" - Example: blockchain=
ETHEREUM
- platform - The platform where the order was created. Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- origin - Address of the consumer to receive the commission for the order .
- Example: origin=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- status - Order status Items. Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
- start - Lower time border of data (timestamp) integer <int64>
- end - Upper time border of data (timestamp) integer <int64>
- continuation - Continuation token from the previous response
- size - The number of items to return.
integer >= 1
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
29. getOrderBidsByItem
Returns order bids by item
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org”
- mainet - “https://api.rarible.org”
- platform - The platform where the order was created. Enum: "
RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId} - Example: itemId=
ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
- maker - The maker of the bid
- Example: maker=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- origin - Address of the consumer to receive the commission for the order .
- Example: origin=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- status - Order status Items. Enum: "
ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
- start - Lower time border of data (timestamp) integer <int64>
- end - Upper time border of data (timestamp) integer <int64>
- continuation - Continuation token from the previous response
- size - The number of items to return.
integer >= 1
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- orders - List of found orders . Array of objects (Order).
30. getActivitiesByItem
Returns activities by item
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- type - Activity type. Items Enum: "
TRANSFER" "MINT" "BURN" "BID" "LIST" "SELL" "CANCEL_LIST" "CANCEL_BID" "AUCTION_BID" "AUCTION_CREATED" "AUCTION_CANCEL" "AUCTION_FINISHED" "AUCTION_STARTED" "AUCTION_ENDED”
- itemId - Item Id, has format
ETHEREUM:${token}:${tokenId} - Example:
itemId=ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
- continuation - Continuation token from the previous response
- cursor - Combined continuation token from the previous response.
- size - The number of items to return.
integer >= 1
- sort - Sorting by data update time. Enum: "
LATEST_FIRST" "EARLIEST_FIRST"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- cursor - Combined continuation token to paginate activities search result
- activities - List of found activities (object)
31. getActivitiesByCollection
Returns activities by collection
Fields :
- Base URL :
- testnet - “https://testnet-api.rarible.org/”
- mainet - “https://api.rarible.org/”
- type - Activity type. Items Enum: "
TRANSFER" "MINT" "BURN" "BID" "LIST" "SELL" "CANCEL_LIST" "CANCEL_BID" "AUCTION_BID" "AUCTION_CREATED" "AUCTION_CANCEL" "AUCTION_FINISHED" "AUCTION_STARTED" "AUCTION_ENDED”
- collection - Address of the collection.
- Example:
collection=ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
- continuation - Continuation token from the previous response
- cursor - Combined continuation token from the previous response.
- size - The number of items to return.
integer >= 1
- sort - Sorting by data update time. Enum: "
LATEST_FIRST" "EARLIEST_FIRST"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- cursor - Combined continuation token to paginate activities search result
- activities - List of found activities (object)
32. getAllActivitiesSync
Returns all activities sorting by data base update
Fields :
- blockchain - Type of the blockchain network . Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- continuation - Continuation token from the previous response
- cursor - Combined continuation token from the previous response.
- size - The number of items to return.
integer >= 1
- sort - Sorting by data update time. Enum: "
DB_UPDATE_ASC" "DB_UPDATE_DESC"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- cursor - Combined continuation token to paginate activities search result
- activities - List of found activities (object)
33. getAllActivities
Returns all activities
Fields :
- blockchain - Type of the blockchain network . Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- type - Activity type. Items Enum: "
TRANSFER" "MINT" "BURN" "BID" "LIST" "SELL""CANCEL_LIST" "CANCEL_BID" "AUCTION_BID" "AUCTION_CREATED" "AUCTION_CANCEL" "AUCTION_FINISHED" "AUCTION_STARTED" "AUCTION_ENDED”
- continuation - Continuation token from the previous response
- cursor - Combined continuation token from the previous response.
- size - The number of items to return.
integer >= 1
- sort - Sorting by data update time. Enum: "
LATEST_FIRST" "EARLIEST_FIRST"
Return :
- continuation - Continuation token to paginate Ownerships search result (string)
- cursor - Combined continuation token to paginate activities search result
- activities - List of found activities (object)
34. getCollectionById
Returns collection by address
Fields :
- collection - Address of the collection. Example:
ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
Return :
- id - Collection Id, has format
ETHEREUM:${nativeICollectionId}
- parent - Collection Id, has format
ETHEREUM:${nativeICollectionId}
- blockchain - Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- type - Enum: "
CRYPTO_PUNKS" "ERC721" "ERC1155" "FLOW" "TEZOS_NFT" "TEZOS_MT" "SOLANA" "IMMUTABLEX”
- status - Enum: "
PENDING" "ERROR" "CONFIRMED”
- name - (string)
- symbol - (string)
- owner - Blockchain address in Union format
${blockchainGroup}:${token}
- features - Items Enum: "
APPROVE_FOR_ALL" "SET_URI_PREFIX" "BURN" "MINT_WITH_ADDRESS" "SECONDARY_SALE_FEES" "MINT_AND_TRANSFER"
- minters - List of addresses that can mint items in this collection
- meta - Object(collectionMeta)
- bestBidOrder - object(order)
- bestSellOrder - object(order)
- originOrders - Array of objects (OriginOrders)
- self - boolean
- statistics - object (CollectionStatistics)
35. refreshCollectionMeta
Refreshes metadata for all items in the NFT collection
Fields :
- collection - Address of the collection. Example:
ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
Return :
If OK return status 200 (empty)
35. getCollectionsByOwner
Returns collection by owner
Fields :
- blockchains - Items Enum: "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- owner - Owner of searching collections.
- Example: owner=
ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
- continuation - Continuation token from the previous response
- size - The number of items to return
Return :
- continuation - Continuation token to paginate collections search result.
- collections - Array of objects (Collection)
36. getAllCollections
Returns all collections
Fields :
- blockchains - Names of the blockchain networks. If no one specified, data from all blockchains will be returned : "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- continuation - Continuation token from the previous response
- size - The number of items to return
Return :
- continuation - Continuation token to paginate collections search result.
- collections - Array of objects (Collection)
37. getTrendingCollection
Trending collection list. Sorted by special score, calculated in the following way: gmv * ( - 1) / 10000
Fields :
- blockchains - Blockchain : "
ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX”
- period - Time period of trending statistics. Default: D7 Enum: "
D1" "D7" "D30"
- limit - Default: 10. Limit of records in trending statistics
Return :
- id - Identifier of collection
- numberOfSales - object (OlapIntegerNumberWithChange)
- value - Value of integer number
- changePercent - Change in percent. Calculated as / - 1
- volumeUsd - object (OlapCurrencyAmountWithChange)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- changePercent - Change in percent. Calculated as / - 1
- volumeNative - object (OlapCurrencyAmount)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- floorPrice - object (OlapCurrencyAmount)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
38. getRaribleStats
Rarible-related statistics. Amount of items listed and sold on rarible platform and amount of minted items over all blockchains and all supported marketplaces
Fields :
Return :
- minted - Amount of minted items (all supported blockchains, all marketplaces)
- sold - Amount of items sold on rarible
- listed - Amount of items listed on rarible
39. getUserLeaderboard
Users (top buyers/sellers) leaderboard. Calculated as traded worth for the period.
Fields :
- entity - Type of users in leaderboard. Enum: "
sellers" "buyers"
- blockchain - Blockchain. Enum: "
ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
- source - Source. Enum: "
RARIBLE" "OPEN_SEA"
- period - Time period of leaderboard. Default: D7. Enum: "
D1" "D7" "D30"
- limit - Default: 10 . Limit of records in leaderboard
Return :
- id - Identifier of user
- volumeUsd - object (OlapCurrencyAmountWithChange)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- volumeNative - object (OlapCurrencyAmount)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- items - (non-unique) amount of traded items.
- transactions - Amount of transactions were made.
40. getCollectionMintsLeaderboard
Collections leaderboard based on mint activity
Fields :
- blockchain - Blockchain. Enum: "
ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
- period - Time period of leaderboard. Enum: "
D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
- sort - Default: "
MINTED_DESC". Leaderboard sorting. Enum: "MINTED_ASC" "MINTED_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
- limit - Default: 10. Limit of records in leaderboard
- offset - Default: 0. Offset of records in leaderboard
Return :
- id - Identifier of collection
- minted - Amount of unique minted nfts for selected period (ERC-1155 and ERC-721 counted once)
- maxSupply - Total supply of all nfts in collection (ERC-1155 sums all quantities and ERC-721 nfts counted once)
- lastMint - Date and time of last mint
- mintPrice - object (OlapCurrencyAmount)
- currency - Default: "
USD". Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- floorPrice - object (OlapCurrencyAmount)
- currency - Default: "
USD". Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
41. getCollectionRankingByVolume
Collections leaderboard by trade activity
Fields :
- blockchain - Blockchain. Enum: "
ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
- ids - Collection ids
- period - Time period of leaderboard. Enum: "
D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
- minFloorPriceNative - Show collections which floor price (native currency) more or equal than specified value
- maxFloorPriceNative - Show collections which floor price (native currency) less or equal than specified value
- sort - Default: "
MINTED_DESC". Leaderboard sorting. Enum: "MINTED_ASC" "MINTED_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
- limit - Default: 10. Limit of records in leaderboard
- continuation - Page reference. Taken from previous response
Return :
- id - Identifier of collection
- volumeUsd - object (OlapCurrencyAmountWithChange)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- changePercent - Change in percent. Calculated as / - 1
- volumeNative - object (OlapCurrencyAmount)
- currency - Default: "USD". Enum: "
USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- itemsBought - integer <int32>
- floorPrice - object (OlapCurrencyAmountWithChange)
- currency - Default: "
USD". Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL" - value - Amount of currency
- changePercent - Change in percent. Calculated as / - 1
- listed - integer <int32>
- totalItemSupply - integer <int32>
- ownersCount - integer <int32>
42. getTransactions
Get historical statistics about collection transactions
Fields :
- collection - Identifier of collection
^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...
- filters - Filters of statistics
Return :
- historicalDates - Dates of historical statistics
- historicalValues - Values of historical statistics
- currentValue - Current value
43. getCollectionStats
Get general statistics about collection
Fields :
- collection - Identifier of collection
^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...
- currency - Default: "
USD". Currency of statistics. Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
Return :
- highestSale - Highest worth transaction in collection
- floorPrice - Minimal price of nft in this collection available on rarible
- marketCap - Market cap of collection (floor price * total item supply)
- listed - Amount of currently listed items
- items - Total item supply of all nfts in the collection
- owners - Current amount of unique owners who hold nfts of this collection
- volume - Total worth of all transactions were made with nfts in this collection
44. getSellers
Get historical statistics about collection sellers
Fields :
- collection - Identifier of collection
^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...
- filters - Filters of statistics
Return :
- historicalDates - Dates of historical statistics
- historicalValues - Values of historical statistics
- currentValue - Current value
45. getPrices
Get historical statistics about collection items prices
Fields :
- collection - Identifier of collection
^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...
- currency - Default: "
USD". Currency of statistics. Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
- filters - Filters of statistics
Return :
- dates - Dates of historical statistics
- avgPrices - Average prices of nfts in this collection for every date
- medianPrices - Median prices of nfts in this collection for every date
- minPrices - Minimum prices of nfts in this collection for every date
- sumPrices - Volumes for the collection for every date