Share via

Rarible (Independent Publisher) (Preview)

Rarible Multichain Protocol is a blockchain-agnostic and decentralized tool to query, issue, and trade NFTs.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Roy Paar
Email roypaar@microsoft.com
Connector Metadata
Publisher Roy Paar
Website https://rarible.com/
Privacy policy https://static.rarible.com/privacy.pdf
Categories Finance

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Aggregate NFT purchase by collection

Aggregate NFT purchase by collection
Aggregate NFT purchase by taker

Aggregate NFT purchase by taker
Aggregate NFT sell order by maker

Aggregate NFT sell order by maker
Return all NFTs by Owner

Return all NFTs by Owner
Return an ERC20 token balance

Return an ERC20 token balance
Return NFTs by Item

Return NFTs by Item
Return NFTs by Ownership ID

Return NFTs by Ownership ID
Returns all NFT collections

Returns all NFT collections
Returns all NFT items

Returns all NFT items
Returns all order bids by item and order status

Returns all order bids by item and order status
Returns all order bids by maker and order status

Returns all order bids by maker and order status
Returns all orders for sale by collection and order status

Returns all orders for sale by collection and order status
Returns all orders for sale by item and order status

Returns all orders for sale by item and order status
Returns all orders for sale by maker and order status

Returns all orders for sale by maker and order status
Returns all orders for sale by order status

Returns all orders for sale by order status
Returns all orders with status sorting

Returns all orders with status sorting
Returns collection by address

Returns collection by address
Returns collection by owner

Returns collection by owner
Returns currencies made as payment in all bid orders of the item

Returns currencies made as payment in all bid orders of the item
Returns currencies taken as payment in all sell orders of the item

Returns currencies taken as payment in all sell orders of the item
Returns item royalty by identifier

Returns item royalty by identifier
Returns next available tokenId for minter

Returns next available tokenId for minter
Returns the NFT item by creator

Returns the NFT item by creator
Returns the NFT item by identifier

Returns the NFT item by identifier
Returns the NFT item by owner

Returns the NFT item by owner
Returns the NFT item meta by identifier

Returns the NFT item meta by identifier
Returns the NFT items by collection

Returns the NFT items by collection
Returns the NFT lazy item by identifier

Returns the NFT lazy item by identifier
Returns the order by order hash

Returns the order by order hash
Update stock of the order by order hash

Update stock of the order by order hash

Aggregate NFT purchase by collection

Operation ID:
aggregateNftPurchaseByCollection

Aggregate NFT purchase by collection

Parameters

Name Key Required Type Description
Lower time border of data (unix format)
 startDate True integer

Lower time border of data (unix format)
Upper time border of data (unix format)
 endDate True integer

Upper time border of data (unix format)
The number of items to return
 size integer

The number of items to return
The platform where the order was created
 source string

The platform where the order was created

Returns

response
array of AggregationData

Aggregate NFT purchase by taker

Operation ID:
aggregateNftPurchaseByTaker

Aggregate NFT purchase by taker

Parameters

Name Key Required Type Description
Lower time border of data (unix format)
 startDate True integer

Lower time border of data (unix format)
Upper time border of data (unix format)
 endDate True integer

Upper time border of data (unix format)
The number of items to return
 size integer

The number of items to return
The platform where the order was created
 source string

The platform where the order was created

Returns

response
array of AggregationData

Aggregate NFT sell order by maker

Operation ID:
aggregateNftSellByMaker

Aggregate NFT sell order by maker

Parameters

Name Key Required Type Description
Lower time border of data (unix format)
 startDate True integer

Lower time border of data (unix format)
Upper time border of data (unix format)
 endDate True integer

Upper time border of data (unix format)
The number of items to return
 size integer

The number of items to return
The platform where the order was created
 source string

The platform where the order was created

Returns

response
array of AggregationData

Return all NFTs by Owner

Operation ID:
getNftAllOwnerships

Return all NFTs by Owner

Parameters

Name Key Required Type Description
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
Include deleted ownerships
 showDeleted boolean

Include deleted ownerships

Returns

NftOwnerships
NftOwnerships

Return an ERC20 token balance

Operation ID:
getErc20Balance

Return an ERC20 token balance

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Address of the ERC20 token owner
 owner True string

Address of the ERC20 token owner

Returns

Erc20DecimalBalance
Erc20DecimalBalance

Return NFTs by Item

Operation ID:
getNftOwnershipsByItem

Return NFTs by Item

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Token identifier
 tokenId True string

Token identifier
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return

Returns

NftOwnerships
NftOwnerships

Return NFTs by Ownership ID

Operation ID:
getNftOwnershipById

Return NFTs by Ownership ID

Parameters

Name Key Required Type Description
ID of the ownership in format: '$contractAddress:$tokenId:$ownerAddress'
 ownershipId True string

ID of the ownership in format: '$contractAddress:$tokenId:$ownerAddress'
Return ownership if it is deleted
 showDeleted boolean

Return ownership if it is deleted

Returns

NftOwnership
NftOwnership

Returns all NFT collections

Operation ID:
searchNftAllCollections

Returns all NFT collections

Parameters

Name Key Required Type Description
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of collections to return
 size integer

The number of collections to return

Returns

NftCollections
NftCollections

Returns all NFT items

Operation ID:
getNftAllItems

Returns all NFT items

Parameters

Name Key Required Type Description
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
Include deleted items
 showDeleted boolean

Include deleted items
Filter condition to return only items that were updated after this date
 lastUpdatedFrom integer

Filter condition to return only items that were updated after this date (unix format)
Filter condition to return only items that were updated before this date
 lastUpdatedTo integer

Filter condition to return only items that were updated before this date (unix format)

Returns

NftItems
NftItems

Returns all order bids by item and order status

Operation ID:
getOrderBidsByItemAndByStatus

Returns all order bids by item and order status

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Token identifier
 tokenId True string

Token identifier
The maker of the order
 maker string

The maker of the order
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of orders to return
 size integer

The number of orders to return
The order status
 status True string

The order status
The currency ID
 currencyId string

The currency ID
Lower time border of data (unix format)
 startDate integer

Lower time border of data (unix format)
Upper time border of data (unix format)
 endDate integer

Upper time border of data (unix format)

Returns

OrdersPagination
OrdersPagination

Returns all order bids by maker and order status

Operation ID:
getOrderBidsByMakerAndByStatus

Returns all order bids by maker and order status

Parameters

Name Key Required Type Description
The maker of the order
 maker True string

The maker of the order
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of orders to return
 size integer

The number of orders to return
The order status
 status True string

The order status
Lower time border of data (unix format)
 startDate integer

Lower time border of data (unix format)
Upper time border of data (unix format)
 endDate integer

Upper time border of data (unix format)

Returns

OrdersPagination
OrdersPagination

Returns all orders for sale by collection and order status

Operation ID:
getSellOrdersByCollectionAndByStatus

Returns all orders for sale by collection and order status

Parameters

Name Key Required Type Description
Address of the NFT collection
 collection True string

Address of the NFT collection
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
The order status
 status string

The order status

Returns

OrdersPagination
OrdersPagination

Returns all orders for sale by item and order status

Operation ID:
getSellOrdersByItemAndByStatus

Returns all orders for sale by item and order status

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Token identifier
 tokenId True string

Token identifier
The maker of the order
 maker string

The maker of the order
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
The order status
 status string

The order status
The currency ID
 currencyId string

The currency ID

Returns

OrdersPagination
OrdersPagination

Returns all orders for sale by maker and order status

Operation ID:
getSellOrdersByMakerAndByStatus

Returns all orders for sale by maker and order status

Parameters

Name Key Required Type Description
The maker of the order
 maker True string

The maker of the order
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
The order status
 status string

The order status

Returns

OrdersPagination
OrdersPagination

Returns all orders for sale by order status

Operation ID:
getSellOrdersByStatus

Returns all orders for sale by order status

Parameters

Name Key Required Type Description
Address of the consumer to receive the commission for order
 origin string

Address of the consumer to receive the commission for order
The platform where the order was created
 platform string

The platform where the order was created
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return
The order status
 status string

The order status
Sorting by last update
 sort string

Sorting by last update

Returns

OrdersPagination
OrdersPagination

Returns all orders with status sorting

Operation ID:
getOrdersAllByStatus

Returns all orders with status sorting

Parameters

Name Key Required Type Description
Sorting by last update
 sort string

Sorting by last update
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of orders to return
 size integer

The number of orders to return
Status of the order
 status string

Status of the order

Returns

OrdersPagination
OrdersPagination

Returns collection by address

Operation ID:
getNftCollectionById

Returns collection by address

Parameters

Name Key Required Type Description
Address of the NFT collection
 collection True string

Address of the NFT collection

Returns

NftCollection
NftCollection

Returns collection by owner

Operation ID:
searchNftCollectionsByOwner

Returns collection by owner

Parameters

Name Key Required Type Description
Address of the collection owner
 owner True string

Address of the collection owner
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of collections to return
 size integer

The number of collections to return

Returns

NftCollections
NftCollections

Returns currencies made as payment in all bid orders of the item

Operation ID:
getCurrenciesByBidOrdersOfItem

Returns currencies made as payment in all bid orders of the item

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Token identifier
 tokenId True string

Token identifier

Returns

List of distinct currencies in which payments for sell or bid orders were suggested

OrderCurrencies
OrderCurrencies

Returns currencies taken as payment in all sell orders of the item

Operation ID:
getCurrenciesBySellOrdersOfItem

Returns currencies taken as payment in all sell orders of the item

Parameters

Name Key Required Type Description
Address of the contract
 contract True string

Address of the contract
Token identifier
 tokenId True string

Token identifier

Returns

List of distinct currencies in which payments for sell or bid orders were suggested

OrderCurrencies
OrderCurrencies

Returns item royalty by identifier

Operation ID:
getNftItemRoyaltyById

Returns item royalty by identifier

Parameters

Name Key Required Type Description
Item identifier, has format `contract:tokenId`
 itemId True string

Item identifier, has format contract:tokenId

Returns

NftItemRoyaltyList
NftItemRoyaltyList

Returns next available tokenId for minter

Operation ID:
generateNftTokenId

Returns next available tokenId for minter

Parameters

Name Key Required Type Description
Address of the NFT collection
 collection True string

Address of the NFT collection
Minter address
 minter True string

Minter address

Returns

NftTokenId
NftTokenId

Returns the NFT item by creator

Operation ID:
getNftItemsByCreator

Returns the NFT item by creator

Parameters

Name Key Required Type Description
Address of the item creator
 creator True string

Address of the item creator
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return

Returns

NftItems
NftItems

Returns the NFT item by identifier

Operation ID:
getNftItemById

Returns the NFT item by identifier

Parameters

Name Key Required Type Description
Item identifier, has format `${contract}:${tokenId}`
 itemId True string

Item identifier, has format ${contract}:${tokenId}

Returns

NftItem
NftItem

Returns the NFT item by owner

Operation ID:
getNftItemsByOwner

Returns the NFT item by owner

Parameters

Name Key Required Type Description
Address of the item owner
 owner True string

Address of the item owner
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return

Returns

NftItems
NftItems

Returns the NFT item meta by identifier

Operation ID:
getNftItemMetaById

Returns the NFT item meta by identifier

Parameters

Name Key Required Type Description
Item identifier, has format `${contract}:${tokenId}`
 itemId True string

Item identifier, has format ${contract}:${tokenId}

Returns

NftItemMeta
NftItemMeta

Returns the NFT items by collection

Operation ID:
getNftItemsByCollection

Returns the NFT items by collection

Parameters

Name Key Required Type Description
ID of the NFT collection
 collection True string

ID of the NFT collection
Address of NFT item owner
 owner string

Address of NFT item owner
Continuation token from the previous response
 continuation string

Continuation token from the previous response
The number of items to return
 size integer

The number of items to return

Returns

NftItems
NftItems

Returns the NFT lazy item by identifier

Operation ID:
getNftLazyItemById

Returns the NFT lazy item by identifier

Parameters

Name Key Required Type Description
Item identifier, has format `${contract}:${tokenId}`
 itemId True string

Item identifier, has format ${contract}:${tokenId}

Returns

Type of an Asset

LazyNft
LazyNft

Returns the order by order hash

Operation ID:
getOrderByHash

Returns the order by order hash

Parameters

Name Key Required Type Description
Hash of the order
 hash True string

Hash of the order

Returns

Order
Order

Update stock of the order by order hash

Operation ID:
updateOrderMakeStock

Update stock of the order by order hash

Parameters

Name Key Required Type Description
Hash of the order
 hash True string

Hash of the order

Returns

Order
Order

Definitions

Erc20DecimalBalance

Name Path Type Description
contract
 contract string
owner
 owner string
balance
 balance string
decimalBalance
 decimalBalance integer
createdAt
 createdAt date-time
lastUpdatedAt
 lastUpdatedAt date-time

NftCollection

Name Path Type Description
id
 id string
Type1
 type Type1

Collection type
owner
 owner string
name
 name string

Collection name
symbol
 symbol string

Collection symbol
features
 features array of Feature

Set of supported features for this collection
supportsLazyMint
 supportsLazyMint boolean

Does the collection support lazy mint or not
minters
 minters array of string

List of addresses that can mint items in this collection
NftCollectionMeta
 meta NftCollectionMeta

NftCollections

Name Path Type Description
total
 total integer

Number of collections were found by request
continuation
 continuation string

Continuation token to paginate items search result
collections
 collections array of NftCollection

List of found collections

NftSignature

Name Path Type Description
v
 v integer
r
 r string
s
 s string

NftTokenId

Name Path Type Description
tokenId
 tokenId string
NftSignature
 signature NftSignature

NftItem

Name Path Type Description
id
 id string

Item identifier, has format '${contract}:${tokenId}'
contract
 contract string
tokenId
 tokenId string
creators
 creators array of Part

Creators of the target item
supply
 supply string
lazySupply
 lazySupply string
owners
 owners array of string

Owners of the target items
royalties
 royalties array of Part

List of royalties
lastUpdatedAt
 lastUpdatedAt date-time

Datetime when the item was created
mintedAt
 mintedAt date-time

Datetime when the item was minted
pending
 pending array of ItemTransfer

Pending information about the item
deleted
 deleted boolean

Item was deleted or not
NftItemMeta
 meta NftItemMeta

NftItemAttribute

Name Path Type Description
key
 key string
value
 value string
type
 type string
format
 format string

NftItemRoyalty

Name Path Type Description
account
 account string
value
 value integer

NftItems

Name Path Type Description
total
 total integer

The total number of items satisfy the query
continuation
 continuation string

Continuation token from the previous response
items
 items array of NftItem

List of found items

NftItemMeta

Name Path Type Description
name
 name string

Name of the NFT item
description
 description string

Description of the NFT item
attributes
 attributes array of NftItemAttribute

Attributes of the NFT item
NftMedia
 image NftMedia
NftMedia
 animation NftMedia

NftCollectionMeta

Name Path Type Description
name
 name string

Name of the NFT collection
description
 description string

Description of the NFT collection
NftMedia
 image NftMedia
external_link
 external_link string

External link to the original website for the collection
seller_fee_basis_points
 seller_fee_basis_points integer

Indicates a 1% seller fee
fee_recipient
 fee_recipient string

NftItemRoyaltyList

Name Path Type Description
royalty
 royalty array of NftItemRoyalty

NftMedia

Name Path Type Description
url
 url object

URL address of the NFT media
meta
 meta object

Meta of the NFT media

LazyNft

Type of an Asset

Name Path Type Description
contract
 contract string
tokenId
 tokenId string
uri
 uri string

Uniform Resource Identifier of the token
creators
 creators array of Part

Addresses of the NFT item creators
royalties
 royalties array of Part

List of royalties
signatures
 signatures array of string

Digital signatures

NftOwnership

Name Path Type Description
id
 id string

Ownership identifier, has format '${token}:${tokenId}:${owner}'
contract
 contract string
tokenId
 tokenId string
owner
 owner string
creators
 creators array of Part

Creators of the target item
value
 value string
lazyValue
 lazyValue string
date
 date date-time

Start date of ownership
pending
 pending array of ItemHistory

History of ownership

NftOwnerships

Name Path Type Description
total
 total integer

Number of ownerships were found by request
continuation
 continuation string

Continuation token to paginate Ownerships search result
ownerships
 ownerships array of NftOwnership

List of found ownerships

ItemHistory

History of item

Name Path Type Description
owner
 owner string
contract
 contract string
tokenId
 tokenId string
value
 value string
date
 date date-time

ItemTransfer

Name Path Type Description
type
 type string
from
 from string

Asset

Name Path Type Description
assetType
 assetType object
value
 value string
valueDecimal
 valueDecimal number

Part

Name Path Type Description
account
 account string
value
 value integer

AggregationData

Name Path Type Description
address
 address string
sum
 sum number
count
 count integer

OrderStatus

OrderStatus
string

OrderExchangeHistory

Name Path Type Description
hash
 hash string
Asset
 make Asset
Asset
 take Asset
date
 date date-time
maker
 maker string

Order

Name Path Type Description
maker
 maker string
taker
 taker string
Asset
 make Asset
Asset
 take Asset
fill
 fill string
fillValue
 fillValue number
start
 start integer
end
 end integer
makeStock
 makeStock string
makeStockValue
 makeStockValue number
cancelled
 cancelled boolean
salt
 salt string
signature
 signature string
createdAt
 createdAt date-time
lastUpdateAt
 lastUpdateAt date-time
pending
 pending array of OrderExchangeHistory
hash
 hash string
makeBalance
 makeBalance string
makePrice
 makePrice number
takePrice
 takePrice number
makePriceUsd
 makePriceUsd number
takePriceUsd
 takePriceUsd number
priceHistory
 priceHistory array of OrderPriceHistoryRecord
OrderStatus
 status OrderStatus

OrderPriceHistoryRecord

Name Path Type Description
date
 date date-time
makeValue
 makeValue number
takeValue
 takeValue number

OrdersPagination

Name Path Type Description
orders
 orders array of Order

Orders list
continuation
 continuation string

Continuation token from the previous response

OrderCurrencies

List of distinct currencies in which payments for sell or bid orders were suggested

Name Path Type Description
OrderType
 orderType OrderType
currencies
 currencies array of object
items
 currencies object

Feature

Feature
string

OrderType

OrderType
string

Type1

Collection type

Collection type

Type1
string