Order Data Model

Order represents an intent to Sell or Buy NFT.

Here is Order data model used by Rarible API. You can check data model in API Reference

Field Type Description

id

string

identifier of the Order, format is ${blockchain}:${orderId}

platform

enum

"RARIBLE" "OPEN_SEA" "X2Y2". See full list of values in API Reference

status

enum

"ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"

startedAt

string
(date-time)

Date and time when order became active (it can't be executed before this time)

endedAt

string
(date-time)

Date and time when order will become cancelled (it can't be executed after this time)

createdAt

string
(date-time)

Date and time when order was created

lastUpdatedAt

string
(date-time)

Date and time when order was last updated

maker

string
(Address)

Wallet which created the order

taker

string
(Address)

Wallet which can take the order (for private orders)

make

object (Asset)

Asset which has maker of this order

take

object (Asset)

Asset which owner of this order wants to get from the taker

data

object
(different types for different platforms)

Extended data needed for order execution (it's different for each platform. You can get more information in API Reference)

* Fields marked with bold are required

Asset data model

FieldTypeDescription
typeobject (AssetType)Type of the asset
valuestring (BigDecimal)Amount of the asset

* Fields marked with bold are required

Asset type data model

See full specification in API reference

FieldTypeDescription
@typeenumFLOW_NFT, FLOW_FT, ERC721, ERC20 etc
set of fields differ
example for ERC20
contractstring (Address)Address of ERC-20 contract

* Fields marked with bold are required