Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rarible NFT Sales API

The NFT Sales API from Rarible — 19 operation(s) for nft sales.

Rarible NFT Sales API is one of 18 APIs that Rarible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NFT Sales. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 19 operations across 19 paths, and defines 70 schemas. It is described by OpenAPI 3.0.3, at version v0.1.

Requests are made against a single base URL, https://{environment}.rarible.org.

19 operations 19 paths 70 schemas 14 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v0.1
Base URL
https://api.rarible.org/v0.1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rarible NFT Sales API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 14 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

NFT Sales 19
GET
/v0.1/orders/{id}
Get Order
getOrderById 1 param → 200404400500
POST
/v0.1/orders/{id}/prepareTx
Prepare order transaction
prepareOrderTransaction 1 param body → 200404400500
POST
/v0.1/orders/{id}/prepareCancelTx
Prepare order cancel transaction
prepareOrderCancelTransaction 1 param → 200404400500
POST
/v0.1/orders/{id}/report
Report Order
reportOrderById 1 param → 200404400500
POST
/v0.1/orders
Create or update Order
upsertOrder body → 200400500
GET
/v0.1/orders/{id}/validate
Get validated Order by Id
getValidatedOrderById 1 param → 200404400500
POST
/v0.1/orders/byIds
Get Orders by Ids
getOrdersByIds body → 200400500
GET
/v0.1/orders/all
Get all Orders
getOrdersAll 6 params → 200400500
GET
/v0.1/orders/sync
Get all Orders (for sync)
getAllSync 4 params → 200400500
GET
/v0.1/orders/sell/byMaker
Get user's sell Orders
getSellOrdersByMaker 8 params → 200400500
GET
/v0.1/orders/sell/byItem
Get sell Orders for NFT
getSellOrdersByItem 7 params → 200400500
GET
/v0.1/orders/sell
Get sell Orders
getSellOrders 5 params → 200400500
GET
/v0.1/orders/bids/byMaker
Get user's bid Orders
getOrderBidsByMaker 11 params → 200400500
GET
/v0.1/orders/bids/byItem
Get bid Orders for NFT
getOrderBidsByItem 10 params → 200400500
GET
/v0.1/orders/floorBids/byCollection
Get floor bids for Collection
getOrderFloorBidsByCollection 8 params → 200400500
GET
/v0.1/orders/settings/fees
Get fee settings
getOrderFees 1 param → 200400500
GET
/v0.1/orders/history/bestActiveAtTime
Get historical best active orders in a collection
getBestActiveOrdersAtTime 5 params → 200400500
GET
/v0.1/orders/history/closestActiveAtTime/byOrder
Get historical active orders in a collection closest in price to the specified order at the time
getClosestActiveOrdersAtTimeByOrder 3 params → 200400500
GET
/v0.1/orders/history/closestActiveAtTime/byPrice
Get historical active orders in a collection closest to the specified price
getClosestActiveOrdersAtTimeByPrice 6 params → 200400500

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are Order (25 properties), EthOrderOpenSeaV1DataV1 (16 properties), EthErc1155LazyAssetType (9 properties), EthOrderSeaportDataV1 (9 properties). Each schema is shown below with its type and property counts.

EthRaribleV2OrderForm
object
2 properties 2 required
EthOrderFormAsset
object
2 properties 2 required
TokenCurrencyAssetType
object
2 properties 2 required
OrderType
string
EthEthereumAssetType
object
2 properties 1 required
Royalty
object
2 properties 2 required
Asset
object
2 properties 2 required
SyncSort
string
PrepareOrderTxResponse
object
4 properties 3 required
EthErc1155LazyAssetType
object
9 properties 8 required
RawOrderData
object
2 properties 1 required
EthOrderDataRaribleV2DataV1
object
3 properties 3 required
EthSeaportConsideration
object
6 properties 6 required
PrepareOrderTxForm
object
5 properties 4 required
BigInteger
string
OrderId
string
CollectionId
string
Collection id
EthOrderBasicSeaportDataV1
object
1 property 1 required
EthRaribleOrderForm
object
8 properties 6 required
EthOrderOpenSeaV1DataV1
object
16 properties 17 required
ItemId
string
Item Id, has format ETHEREUM:${token}:${tokenId}
UnionApiErrorServerError
object
2 properties 2 required
EthErc721LazyAssetType
object
8 properties 7 required
PreparedOrderTx
object
2 properties 2 required
EthErc721AssetType
object
4 properties 3 required
CurrencyId
string
Currency Id, has format ETHEREUM:${token} or ETHEREUM:${token}:${tokenId}
EthErc1155AssetType
object
4 properties 3 required
UnionApiErrorBadRequest
object
2 properties 2 required
RawJson
object
Order
object
25 properties 14 required
Orders
object
2 properties 1 required
SolanaSolAssetType
object
1 property 1 required
Blockchain
string
EthOrderCryptoPunksData
object
2 properties 1 required
EthOrderSeaportDataV1
object
9 properties 7 required
EthSeaportOrderType
string
SearchEngine
string
UnionApiErrorEntityNotFound
object
2 properties 2 required
EthCollectionAssetType
object
3 properties 2 required
Creator
object
2 properties 2 required
EthOrderDataLegacy
object
2 properties 2 required
AssetType
object
BestAtTimeOrdersResponse
object
K best orders at time
1 property 1 required
EthCryptoPunksAssetType
object
4 properties 3 required
EthRaribleV2OrderData
Payout
object
2 properties 2 required
OrderStatus
string
BigDecimal
string
OrderData
object
EthErc20AssetType
object
2 properties 2 required
EthOrderDataRaribleV2DataV3Sell
object
6 properties 2 required
EthOrderDataRaribleV2DataV3Buy
object
5 properties 1 required
EthSeaportItemType
string
OrderFees
object
Base fees
1 property 1 required
EthGenerativeArtAssetType
object
3 properties 2 required
ContractAddress
string
Blockchain contract address in Union format ETHEREUM:${token}
Platform
string
SolanaAuctionHouseDataV1
object
4 properties 1 required
EthOrderDataRaribleV2DataV3
object
4 properties 4 required
OrderForm
object
1 property 1 required
NativeCurrencyAssetType
object
3 properties 2 required
UnionAddress
string
Blockchain address in Union format ${blockchainGroup}:${token}
EthSeaportOffer
object
5 properties 5 required
NftOfCollectionAssetType
object
2 properties 2 required
NftAssetType
object
4 properties 3 required
OrderSort
string
SolanaFtAssetType
object
2 properties 2 required
SolanaNftAssetType
object
4 properties 2 required
EthOrderDataRaribleV2DataV2
object
4 properties 4 required
OrderIds
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rarible-nft-sales-api-openapi.yml Raw ↑

Other APIs Rarible publishes across the network.

Rarible Charts API
Rarible Collection Leader Board API
Rarible Collection Statistics API
Rarible Currencies and rates API
Rarible Domain lookup API
Rarible Encode operations API
Rarible Indexer blocks API
Rarible NFT Activities API
Rarible NFT Collections API
Rarible NFT Data and Historical Statistics API
Rarible NFT Items API
Rarible NFT Ownerships API