Rarible NFT Sales API

openapi: 3.0.3
info:
  title: OpenAPI definition Charts NFT Sales API
  version: v0.1
  description: '# Exciting News


    Hey there, amazing developers! 👋


    We''ve got some fantastic news to share that will make your experience with our product even better. We''re thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let''s dive right into the details! ✨


    ## API-Keys for Enhanced Functionality 🔑


    Starting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter `X-API-KEY` in the Header of your request. Simple as that!


    ## Get Your API-Key in a Snap! ⚡️


    Securing your API-Key is a breeze. We''ve made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you''ve done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧


    [Get Your API-Key Here](https://api.rarible.org/registration)

    [Configure SDK with API-key](https://github.com/rarible/sdk#api-querying)


    ## Unlock the Power of the Rarible Protocol 🔓


    As passionate developers, we know you''re always hungry for knowledge and eager to explore new frontiers. That''s why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you''ll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀


    [Explore the Rarible Protocol](https://rarible.org)


    So, buckle up and get ready for an enhanced development journey with our API-Keys. We''re excited to see what you''ll create using our revamped system! 💪🚀


    Stay curious, keep innovating, and happy coding! ✨


    [P.S. Join our Discord Server to stay up to date and ask questions](https://discord.gg/rarifoundation)

    '
servers:
- url: https://{environment}.rarible.org
  description: Production (Mainnet)
  variables:
    environment:
      enum:
      - api
      - testnet-api
      default: api
security:
- ApiKeyAuth: []
tags:
- name: NFT Sales
  x-controller: OrderController
paths:
  /v0.1/orders/{id}:
    get:
      tags:
      - NFT Sales
      summary: Get Order
      description: Returns Order by Id
      operationId: getOrderById
      parameters:
      - name: id
        in: path
        required: true
        description: Order Id, has format 'ETHEREUM:${id}'
        schema:
          $ref: '#/components/schemas/OrderId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '404':
          $ref: '#/components/responses/EntityNotFound'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/{id}/prepareTx:
    post:
      tags:
      - NFT Sales
      summary: Prepare order transaction
      description: Prepare all required data to match given order on the blockchain
      operationId: prepareOrderTransaction
      parameters:
      - name: id
        in: path
        required: true
        description: Order Id, has format 'ETHEREUM:${id}'
        schema:
          $ref: '#/components/schemas/OrderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareOrderTxForm'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrepareOrderTxResponse'
        '404':
          $ref: '#/components/responses/EntityNotFound'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/{id}/prepareCancelTx:
    post:
      tags:
      - NFT Sales
      summary: Prepare order cancel transaction
      description: Prepare all required data to cancel given order on the blockchain
      operationId: prepareOrderCancelTransaction
      parameters:
      - name: id
        in: path
        required: true
        description: Order Id, has format 'ETHEREUM:${id}'
        schema:
          $ref: '#/components/schemas/OrderId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreparedOrderTx'
        '404':
          $ref: '#/components/responses/EntityNotFound'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/{id}/report:
    post:
      tags:
      - NFT Sales
      summary: Report Order
      description: Report Error Order
      operationId: reportOrderById
      parameters:
      - name: id
        in: path
        required: true
        description: Order Id, has format 'ETHEREUM:${id}'
        schema:
          $ref: '#/components/schemas/OrderId'
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/EntityNotFound'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders:
    post:
      tags:
      - NFT Sales
      summary: Create or update Order
      description: Create or update off-chain Order (supported only for some blockchains)
      operationId: upsertOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForm'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/{id}/validate:
    get:
      tags:
      - NFT Sales
      summary: Get validated Order by Id
      description: Validates and returns order by Id. IMPORTANT - validation is time-consuming operation!
      operationId: getValidatedOrderById
      parameters:
      - name: id
        in: path
        required: true
        description: Order Id, has format 'ETHEREUM:${id}'
        schema:
          $ref: '#/components/schemas/OrderId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '404':
          $ref: '#/components/responses/EntityNotFound'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/byIds:
    post:
      tags:
      - NFT Sales
      summary: Get Orders by Ids
      description: Returns Orders by specified list of Ids
      operationId: getOrdersByIds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderIds'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/all:
    get:
      tags:
      - NFT Sales
      summary: Get all Orders
      description: Returns all Orders in accordance with specified filters and sorted by `last updated` date
      operationId: getOrdersAll
      parameters:
      - name: blockchains
        in: query
        required: false
        description: Type of the blockchain network
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Blockchain'
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of orders to return
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        description: Order sort
        schema:
          $ref: '#/components/schemas/OrderSort'
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/sync:
    get:
      tags:
      - NFT Sales
      summary: Get all Orders (for sync)
      description: Returns all sales & transfers in accordance with specified filters and sorted by `db updated` date. During internal updates (like migrations) Orders can be updated for technical reasons. In such case, `last update` date won't be changed. If you want to store Orders in your own storage and keep it synced, use this method.
      operationId: getAllSync
      parameters:
      - name: blockchain
        in: query
        required: true
        description: Type of the blockchain network
        schema:
          $ref: '#/components/schemas/Blockchain'
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of orders to return
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        description: Order sort
        schema:
          $ref: '#/components/schemas/SyncSort'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/sell/byMaker:
    get:
      tags:
      - NFT Sales
      summary: Get user's sell Orders
      description: Returns sell NFT Sales created by specified user and sorted by `last update` date
      operationId: getSellOrdersByMaker
      parameters:
      - name: blockchains
        in: query
        required: false
        description: Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON),  you can use this filter to get Orders only for specific blockchains.  Or keep it empty to get Order from all blockchains
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Blockchain'
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: maker
        in: query
        required: true
        description: The maker of the order
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UnionAddress'
      - name: collection
        in: query
        required: false
        description: The nft collection of order
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CollectionId'
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          minimum: 1
          type: integer
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/sell/byItem:
    get:
      tags:
      - NFT Sales
      summary: Get sell Orders for NFT
      description: Returns sell sales & transfer created for specified NFT and sorted by price in USD (cheapest first)
      operationId: getSellOrdersByItem
      parameters:
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: itemId
        in: query
        required: true
        description: Item Id, has format `ETHEREUM:${token}:${tokenId}`
        schema:
          $ref: '#/components/schemas/ItemId'
      - name: maker
        in: query
        required: false
        description: The maker of the bid
        schema:
          $ref: '#/components/schemas/UnionAddress'
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          minimum: 1
          type: integer
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/sell:
    get:
      tags:
      - NFT Sales
      summary: Get sell Orders
      description: Returns sell Orders satisfying specified filters and sorted by `last update` date
      operationId: getSellOrders
      parameters:
      - name: blockchains
        in: query
        required: false
        description: Names of the blockchain networks. If no one specified, data from all blockchains will be returned
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Blockchain'
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/bids/byMaker:
    get:
      tags:
      - NFT Sales
      summary: Get user's bid Orders
      description: Returns bid Orders created by specified user and sorted by `last update` date
      operationId: getOrderBidsByMaker
      parameters:
      - name: maker
        in: query
        required: true
        description: Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON),  you can use this filter to get Orders only for specific blockchains.  Or keep it empty to get Order from all blockchains
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UnionAddress'
      - name: blockchains
        in: query
        required: false
        description: Names of the blockchain networks. If no one specified, data from all blockchains will be returned
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Blockchain'
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: collection
        in: query
        required: false
        description: The nft collection of order
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CollectionId'
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: currencies
        in: query
        required: false
        description: Currencies for bids
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyId'
      - name: start
        in: query
        required: false
        description: Lower time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: end
        in: query
        required: false
        description: Upper time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/bids/byItem:
    get:
      tags:
      - NFT Sales
      summary: Get bid Orders for NFT
      description: Returns bid Orders created for specified NFT and sorted by price in USD (expensive first)
      operationId: getOrderBidsByItem
      parameters:
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: itemId
        in: query
        required: true
        description: Item Id, has format `ETHEREUM:${token}:${tokenId}`
        schema:
          $ref: '#/components/schemas/ItemId'
      - name: maker
        in: query
        required: false
        description: The maker of the bid
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UnionAddress'
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: currencies
        in: query
        required: false
        description: Currencies for bids
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyId'
      - name: start
        in: query
        required: false
        description: Lower time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: end
        in: query
        required: false
        description: Upper time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          type: integer
      - name: searchEngine
        in: query
        required: false
        deprecated: true
        description: Search engine to use for search
        schema:
          $ref: '#/components/schemas/SearchEngine'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/floorBids/byCollection:
    get:
      tags:
      - NFT Sales
      summary: Get floor bids for Collection
      description: Returns floor bids created for specified NFT Collection and sorted by price in USD (expensive first)
      operationId: getOrderFloorBidsByCollection
      parameters:
      - name: platform
        in: query
        required: false
        description: The platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: collectionId
        in: query
        required: true
        description: Collection Id, has format `ETHEREUM:${token}`
        schema:
          $ref: '#/components/schemas/CollectionId'
      - name: status
        in: query
        required: false
        description: Order status
        schema:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatus'
      - name: currencies
        in: query
        required: false
        description: Currencies for bids
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyId'
      - name: start
        in: query
        required: false
        description: Lower time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: end
        in: query
        required: false
        description: Upper time border of data (timestamp)
        schema:
          type: integer
          format: int64
      - name: continuation
        in: query
        required: false
        description: Continuation token from the previous response
        schema:
          type: string
      - name: size
        in: query
        required: false
        description: The number of items to return
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/settings/fees:
    get:
      tags:
      - NFT Sales
      summary: Get fee settings
      description: Returns Protocol fee settings for Orders
      operationId: getOrderFees
      parameters:
      - name: blockchain
        in: query
        required: false
        description: Type of the blockchain network
        schema:
          $ref: '#/components/schemas/Blockchain'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderFees'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/history/bestActiveAtTime:
    get:
      tags:
      - NFT Sales
      summary: Get historical best active orders in a collection
      description: Return K best active orders in a collection as they were at the specified point in time.  For Sell orders, the best are the cheapest ones; and for Buy orders, the best are the most expensive ones.  The orders are sorted in the order of goodness, with best order always the first.
      operationId: getBestActiveOrdersAtTime
      parameters:
      - name: type
        in: query
        required: true
        description: Type of orders. Only the orders of this type will be searched
        schema:
          $ref: '#/components/schemas/OrderType'
      - name: platform
        in: query
        required: false
        description: Platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: collectionId
        in: query
        required: true
        description: Collection in which to look for best orders
        schema:
          $ref: '#/components/schemas/CollectionId'
      - name: time
        in: query
        required: true
        description: Point in time at which to return best orders
        schema:
          type: string
          format: date-time
      - name: topK
        in: query
        required: false
        description: How many best orders to return. If not specified, some default amount is returned
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestAtTimeOrdersResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/history/closestActiveAtTime/byOrder:
    get:
      tags:
      - NFT Sales
      summary: Get historical active orders in a collection closest in price to the specified order at the time
      description: 'Return K orders in a collection that were active at the specified point in time, which are the closest in price to the specified order.  Ties are broken first by price: for Sell orders, the best are the cheapest ones; and for Buy orders, the best are the most expensive ones.  Then ties are broken by creation date, the earlier, the better.  The specified order is not included in the returned K results.'
      operationId: getClosestActiveOrdersAtTimeByOrder
      parameters:
      - name: orderId
        in: query
        required: true
        description: The reference order used to find orders with prices closest to its price. Must belong to the specified collection
        schema:
          $ref: '#/components/schemas/OrderId'
      - name: time
        in: query
        required: true
        description: Point in time at which to return closest orders
        schema:
          type: string
          format: date-time
      - name: topK
        in: query
        required: false
        description: How many closest orders to return. If not specified, some default amount is returned
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestAtTimeOrdersResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
  /v0.1/orders/history/closestActiveAtTime/byPrice:
    get:
      tags:
      - NFT Sales
      summary: Get historical active orders in a collection closest to the specified price
      description: 'Return K closest orders in a collection that were active at the specified point in time.  Ties are broken first by price: for Sell orders, the best are the cheapest ones; and for Buy orders, the best are the most expensive ones.  Then ties are broken by creation date, the earlier, the better.'
      operationId: getClosestActiveOrdersAtTimeByPrice
      parameters:
      - name: type
        in: query
        required: true
        description: Type of orders. Only the orders of this type will be searched
        schema:
          $ref: '#/components/schemas/OrderType'
      - name: platform
        in: query
        required: false
        description: Platform where the order was created
        schema:
          $ref: '#/components/schemas/Platform'
      - name: collectionId
        in: query
        required: true
        description: Collection in which to look for closest orders
        schema:
          $ref: '#/components/schemas/CollectionId'
      - name: time
        in: query
        required: true
        description: Point in time at which to return closest orders
        schema:
          type: string
          format: date-time
      - name: topK
        in: query
        required: false
        description: How many closest orders to return. If not specified, some default amount is returned
        schema:
          type: integer
          format: int32
      - name: priceUsd
        in: query
        required: true
        description: The reference price used to find closest orders, in USD
        schema:
          type: number
          format: bigdecimal
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BestAtTimeOrdersResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    EthRaribleV2OrderForm:
      type: object
      required:
      - type
      - data
      properties:
        '@type':
          type: string
          enum:
          - RARIBLE_V2
        data:
          $ref: '#/components/schemas/EthRaribleV2OrderData'
    EthOrderFormAsset:
      type: object
      required:
      - assetType
      - value
      properties:
        assetType:
          $ref: '#/components/schemas/AssetType'
        value:
          $ref: '#/components/schemas/BigInteger'
    TokenCurrencyAssetType:
      type: object
      properties:
        '@type':
          type: string
          enum:
          - CURRENCY_TOKEN
        contract:
          $ref: '#/components/schemas/ContractAddress'
      required:
      - '@type'
      - contract
    OrderType:
      type: string
      enum:
      - BID
      - SELL
    EthEthereumAssetType:
      type: object
      properties:
        '@type':
          type: string
          enum:
          - ETH
        blockchain:
          $ref: '#/components/schemas/Blockchain'
      required:
      - '@type'
    Royalty:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/UnionAddress'
        value:
          type: integer
      required:
      - account
      - value
    Asset:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AssetType'
        value:
          $ref: '#/components/schemas/BigDecimal'
      required:
      - type
      - value
    SyncSort:
      type: string
      enum:
      - DB_UPDATE_ASC
      - DB_UPDATE_DESC
    PrepareOrderTxResponse:
      type: object
      required:
      - asset
      - tran

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rarible/refs/heads/main/openapi/rarible-nft-sales-api-openapi.yml