POST /open/v1/{network_id}/orders/add

List a single ERC-721 NFT for sale on the Dew marketplace. When generating the salt required for signature using Seaport.js generateRandomSalt(), the domain parameter has to be set to dew. Otherwise the signature will be rejected.

Path parameters

  • network_id integer Required

    Chain ID.

    Value is 137.

application/json

Body

  • parameters object Required
    Hide parameters attributes Show parameters attributes object
    • offerer string Required

      hex address which supplies all the items in the offer.

    • offer array[object] Required

      Array of items that may be transferred from the offerer's account.

      At least 1 but not more than 1 element.

      Hide offer attributes Show offer attributes object
      • itemType integer Required

        Must be 2

        Value is 2.

      • token string Required

        The item's token contract (with the null address used for native tokens) Token address

      • identifierOrCriteria integer Required

        The ERC721 or ERC1155 token identifier or, in the case of a criteria-based item type, a merkle root composed of the valid set of token identifiers for the item. This value will be ignored for Ether and ERC20 item types, and can optionally be zero for criteria-based item types to allow for any identifier.

      • startAmount integer Required

        The amount of the token in question that will be required should the order be fulfilled.

      • endAmount integer Required

        When endAmount differs from startAmount, the realized amount is calculated linearly based on the time elapsed since the order became active.

    • consideration array[object] Required

      Array of items which must be received by a recipient to fulfill the order. One of the consideration items must be the OpenSea marketplace fee.

      At least 1 element.

      Hide consideration attributes Show consideration attributes object
      • itemType integer Required

        0 - Native - Ether (or other native token for the given chain) 1 - ERC20

        Values are 0 or 1.

      • token string Required

        The item's token contract (with the null address used for native tokens)

      • identifierOrCriteria integer Required

        The ERC721 or ERC1155 token identifier or, in the case of a criteria-based item type, a merkle root composed of the valid set of token identifiers for the item. This value will be ignored for Ether and ERC20 item types, and can optionally be zero for criteria-based item types to allow for any identifier.

      • startAmount integer Required

        The amount of the token in question that will be required should the order be fulfilled.

      • endAmount integer Required

        When endAmount differs from startAmount, the realized amount is calculated linearly based on the time elapsed since the order became active.

      • recipient string Required

        The address which will receive the consideration item when the order is executed.

    • startTime integer Required

      The block timestamp at which the order becomes active.

    • endTime integer Required

      The block timestamp at which the order expires.

    • orderType integer Required

      The type of order, which determines how it can be executed. 0 = Full Open - No partial fills, anyone can execute Must be 0

      Value is 0.

    • zone string Required

      Use 0x0000000000000000000000000000000000000000.

      Value is 0x0000000000000000000000000000000000000000.

    • zoneHash string Required

      A value that will be supplied to the zone when fulfilling restricted orders that the zone can utilize when making a determination on whether to authorize the order. Most often this value will be the zero hash 0x0000000000000000000000000000000000000000000000000000000000000000.

    • salt string Required

      An arbitrary source of entropy for the order. When generating using Seaport.js generateRandomSalt(), the domain parameter has to be set to dew.

    • conduitKey string Required

      Use 0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000 for most collections, use 0xbf93ac7f6ed28340151d3f99a295e3728a7aeda3000000000000000000000000 for listing Dew Names.

    • totalOriginalConsiderationItems integer

      Size of the consideration array.

    • counter string Required

      Must match the current counter for the given offerer. If you are unsure of the current counter, it can be read from the contract on etherscan.

  • signature string Required

    Signature of the signed type data represented by the parameters field.

  • protocol_address string Required

    Exchange contract address. Must be one of ['0x00000000000000adc04c56bf30ac9d3c0aaf14dc']

Responses

  • 200 application/json

    Successful

    Hide response attributes Show response attributes object
    • code integer Required

      0: success, others: error

    • data array[object] Required
      Hide data attributes Show data attributes object
      • source integer Required

        Market source. -2: Dew, 0: OpenSea, 4: Tofu, 5: Element, 6: MagicEden, 7: OnePlanet, 8: Mooar

        Values are -2, 1, 4, 5, 6, 7, or 8.

      • price string
      • currency string
      • price_usd number
      • id integer Required

        Unique id of each order

      • network_id integer Required

        Chain ID.

      • nft object | null
        Hide nft attributes Show nft attributes object | null
        • owner string | null
        • contract string
        • token_id string
        • name string | null
        • rank integer | null
        • status integer | null
      • contract object | null
        Hide contract attributes Show contract attributes object | null
        • contract string Required
        • name string Required
        • symbol string Required
        • icon_url string Required
        • slug string | null
        • verified boolean Required
        • show_rarity boolean
      • order_hash string Required

        Unique hash of each order

      • maker string

        Address of orders' maker, aka seller.

      • taker string
      • status integer Required

        -1: invalid, 0: list, 1: sold, 2: cancelled, 3: expired

      • created_at integer

        Timestamp of order creation

      • listed_at integer

        Timestamp of order listing

      • expired_at integer

        Timestamp of order expiration

      • is_offer boolean

        Whether the order is an offer

      • updated_at integer

        Timestamp of order update

      • amount string

        Amount of NFTs, only available for ERC1155

      • remain string

        Amount of NFTs that are not sold, only available for ERC1155

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • code integer Required

      0: success, others: error

    • error string | null Required
    • errors array[object] | null
POST /open/v1/{network_id}/orders/add
curl \
 -X POST https://api.dewapi.com/open/v1/137/orders/add \
 -H "X-API-Key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"parameters":{"offerer":"string","offer":[{"itemType":2,"token":"string","identifierOrCriteria":42,"startAmount":42,"endAmount":42}],"consideration":[{"itemType":0,"token":"string","identifierOrCriteria":42,"startAmount":42,"endAmount":42,"recipient":"string"}],"startTime":42,"endTime":42,"orderType":0,"zone":"0x0000000000000000000000000000000000000000","zoneHash":"string","salt":"string","conduitKey":"string","totalOriginalConsiderationItems":42,"counter":"1"},"signature":"0x","protocol_address":"0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC"}'
Request example
{
  "parameters": {
    "offerer": "string",
    "offer": [
      {
        "itemType": 2,
        "token": "string",
        "identifierOrCriteria": 42,
        "startAmount": 42,
        "endAmount": 42
      }
    ],
    "consideration": [
      {
        "itemType": 0,
        "token": "string",
        "identifierOrCriteria": 42,
        "startAmount": 42,
        "endAmount": 42,
        "recipient": "string"
      }
    ],
    "startTime": 42,
    "endTime": 42,
    "orderType": 0,
    "zone": "0x0000000000000000000000000000000000000000",
    "zoneHash": "string",
    "salt": "string",
    "conduitKey": "string",
    "totalOriginalConsiderationItems": 42,
    "counter": "1"
  },
  "signature": "0x",
  "protocol_address": "0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC"
}
Response examples (200)
{
  "code": 0,
  "data": [
    {
      "source": 1,
      "price": "49000000000000000",
      "currency": "0x0000000000000000000000000000000000000000",
      "price_usd": "0.1",
      "id": 1,
      "network_id": 137,
      "nft": {
        "owner": "0x40415c1c0e7a8ff3e184b51a94a2fc5b92df9434",
        "contract": "0xa131b877B12B0Ae8BB7da7229b8a1095881497A6",
        "token_id": "1",
        "name": "BAYC #1",
        "rank": 1,
        "status": 0
      },
      "contract": {
        "contract": "0x8a90CAb2b38dba80c64b7734e58Ee1dB38B8992e",
        "name": "Doodle",
        "symbol": "DOODLE",
        "icon_url": "nfts/qt5xtfvkajlhva1.jpg",
        "slug": "doodles-official",
        "verified": true,
        "show_rarity": false
      },
      "order_hash": "0x41a2753400f805db148079f60355df470aece45941a45cb96a25ab5d24e4c243",
      "maker": "0x40415c1c0e7a8ff3e184b51a94a2fc5b92df9434",
      "taker": "string",
      "status": 0,
      "created_at": 1654983000,
      "listed_at": 1654983000,
      "expired_at": 1654999000,
      "is_offer": false,
      "updated_at": 1654983000,
      "amount": "1",
      "remain": "1"
    }
  ]
}
Response examples (400)
{
  "code": 3000,
  "error": "this is an error message",
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ]
}