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 Collections API

The NFT Collections API from Rarible — 6 operation(s) for nft collections.

Rarible NFT Collections 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 Collections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 67 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.

6 operations 6 paths 67 schemas 2 DELETE4 GET

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 Collections 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 6

Across 6 paths, the API surfaces 6 operations — 2 DELETE, 4 GET. Each is listed below with its method, path, parameters, and response codes.

NFT Collections 6
GET
/v0.1/collections/{collection}
Get NFT Collection by Id
getCollectionById 1 param → 200404400500
GET
/v0.1/collections/{collection}/generateTokenId
Generate TokenId
generateTokenId 2 params → 200400500
DELETE
/v0.1/collections/{collection}/refreshMeta
Reset NFT metadata
refreshCollectionItemsMeta 1 param → 200400500
DELETE
/v0.1/collections/{collection}/resetMeta
Reset Collection metadata
resetCollectionMeta 1 param → 200400500
GET
/v0.1/collections/byOwner
Get NFT Collections owned by user
getCollectionsByOwner 4 params → 200400500
GET
/v0.1/collections/all
Get all NFT Collections
getAllCollections 3 params → 200400500

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are Order (25 properties), Collection (23 properties), EthOrderOpenSeaV1DataV1 (16 properties), CollectionMeta (14 properties). Each schema is shown below with its type and property counts.

TokenCurrencyAssetType
object
2 properties 2 required
Collection
object
23 properties 5 required
EthEthereumAssetType
object
2 properties 1 required
SolanaFtAssetType
object
2 properties 2 required
CollectionTokenId
object
1 property 1 required
Asset
object
2 properties 2 required
Royalty
object
2 properties 2 required
ImageContent
object
3 properties
DefaultCollectionTokenId
object
1 property 1 required
EthErc1155LazyAssetType
object
9 properties 8 required
EthSeaportConsideration
object
6 properties 6 required
EthOrderDataRaribleV2DataV1
object
3 properties 3 required
BigInteger
string
OrderId
string
CollectionId
string
Collection id
EthOrderBasicSeaportDataV1
object
1 property 1 required
EthOrderOpenSeaV1DataV1
object
16 properties 17 required
UnionApiErrorServerError
object
2 properties 2 required
ItemId
string
Item Id, has format ETHEREUM:${token}:${tokenId}
EthErc721LazyAssetType
object
8 properties 7 required
MetaContent
object
6 properties 2 required
EthErc721AssetType
object
4 properties 3 required
AudioContent
object
1 property
EthErc1155AssetType
object
4 properties 3 required
UnionApiErrorBadRequest
object
2 properties 2 required
RawJson
object
EthCollectionTokenIdSignature
object
3 properties 3 required
Order
object
25 properties 14 required
Blockchain
string
EthOrderCryptoPunksData
object
2 properties 1 required
EthCollectionTokenId
object
2 properties 2 required
UnionApiErrorEntityNotFound
object
2 properties 2 required
EthOrderSeaportDataV1
object
9 properties 7 required
EthSeaportOrderType
string
SolanaSolAssetType
object
1 property 1 required
EthCollectionAssetType
object
3 properties 2 required
EthOrderDataLegacy
object
2 properties 2 required
Creator
object
2 properties 2 required
Collections
object
3 properties 1 required
AssetType
object
Payout
object
2 properties 2 required
EthRaribleV2OrderData
OrderStatus
string
EthCryptoPunksAssetType
object
4 properties 3 required
HtmlContent
object
1 property
BigDecimal
string
OrderData
object
EthErc20AssetType
object
2 properties 2 required
EthOrderDataRaribleV2DataV3Sell
object
6 properties 2 required
EthOrderDataRaribleV2DataV3Buy
object
5 properties 1 required
EthSeaportItemType
string
CollectionMeta
object
14 properties 2 required
EthGenerativeArtAssetType
object
3 properties 2 required
VideoContent
object
3 properties
ContractAddress
string
Blockchain contract address in Union format ETHEREUM:${token}
SolanaAuctionHouseDataV1
object
4 properties 1 required
Platform
string
Model3dContent
object
1 property
EthOrderDataRaribleV2DataV3
object
4 properties 4 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
RawOrderData
object
2 properties 1 required
SolanaNftAssetType
object
4 properties 2 required
EthOrderDataRaribleV2DataV2
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rarible-nft-collections-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 Data and Historical Statistics API
Rarible NFT Items API
Rarible NFT Ownerships API
Rarible NFT Sales API