Sign in

v1

latestOpenAPI 3.0.3raw.githubusercontent.com2025-06-1883262329.3 KB
NFT Sales

Create or update Order

Create or update off-chain Order (supported only for some blockchains)

post/v0.1/orders

Request body

@type'RARIBLE_V2'

Example request

{
  "data": {
    "payouts": [
      {
        "account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
      }
    ],
    "originFees": [
      {
        "account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
      }
    ]
  }
}

Response

OK

idstring required
fillstring required
platform'RARIBLE' | 'OPEN_SEA' | 'CRYPTO_PUNKS' | 'IMMUTABLEX' | 'HEN' | 'OBJKT' | 'VERSUM' | 'TEIA' | 'OTHER' | 'FXHASH' required
status'ACTIVE' | 'FILLED' | 'INACTIVE' | 'CANCELLED' required
startedAtstring date-time
endedAtstring date-time
makeStockstring required
cancelledboolean required
optionalRoyaltiesboolean

True if the execution of this order does not guarantee that the royalties will be paid. In this case, it is up to the buyer to pay the royalties.

createdAtstring date-time required
lastUpdatedAtstring date-time required
dbUpdatedAtstring date-time
makePricestring
takePricestring
makePriceUsdstring
takePriceUsdstring
makerstring required

Blockchain address in Union format ${blockchainGroup}:${token}

takerstring

Blockchain address in Union format ${blockchainGroup}:${token}

saltstring required
signaturestring
feeTakersUnionAddress[]
versioninteger

Example response

{
  "id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
  "maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
  "taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
  "make": {
    "type": {
      "blockchain": "ETHEREUM",
      "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430"
    }
  },
  "take": {
    "type": {
      "blockchain": "ETHEREUM",
      "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430"
    }
  },
  "feeTakers": [
    "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
  ],
  "data": {
    "payouts": [
      {
        "account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
      }
    ],
    "originFees": [
      {
        "account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb"
      }
    ]
  }
}