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 Encode operations API

The Encode operations API from Rarible — 1 operation(s) for encode operations.

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

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

This API exposes 1 operation across 1 path, and defines 40 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.

1 operations 1 paths 40 schemas 1 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 Encode operations 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Encode operations 1
POST
/v0.1/encode/order
Generate order encode data for sign operations
encode body → 200400500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are EthErc1155LazyAssetType (9 properties), EthRaribleOrderForm (8 properties), EthErc721LazyAssetType (8 properties), EthOrderDataRaribleV2DataV3Sell (6 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
EthEthereumAssetType
object
2 properties 1 required
Royalty
object
2 properties 2 required
EthErc1155LazyAssetType
object
9 properties 8 required
EthOrderDataRaribleV2DataV1
object
3 properties 3 required
BigInteger
string
CollectionId
string
Collection id
EthRaribleOrderForm
object
8 properties 6 required
UnionApiErrorServerError
object
2 properties 2 required
ItemId
string
Item Id, has format ETHEREUM:${token}:${tokenId}
EthErc721LazyAssetType
object
8 properties 7 required
EthErc721AssetType
object
4 properties 3 required
EthErc1155AssetType
object
4 properties 3 required
UnionApiErrorBadRequest
object
2 properties 2 required
EncodedOrder
object
1 property 1 required
SolanaSolAssetType
object
1 property 1 required
Blockchain
string
EthCollectionAssetType
object
3 properties 2 required
Creator
object
2 properties 2 required
AssetType
object
EthCryptoPunksAssetType
object
4 properties 3 required
EthRaribleV2OrderData
Payout
object
2 properties 2 required
EncodedEthOrder
object
4 properties 2 required
EthErc20AssetType
object
2 properties 2 required
EthOrderDataRaribleV2DataV3Sell
object
6 properties 2 required
EthOrderDataRaribleV2DataV3Buy
object
5 properties 1 required
EthGenerativeArtAssetType
object
3 properties 2 required
ContractAddress
string
Blockchain contract address in Union format ETHEREUM:${token}
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}
NftOfCollectionAssetType
object
2 properties 2 required
NftAssetType
object
4 properties 3 required
SolanaFtAssetType
object
2 properties 2 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-encode-operations-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 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
Rarible NFT Sales API