市场 API

订单相关模型#

订单状态枚举#

枚举描述
active表示该订单当前有效,可以被成交
inactive表示该订单当前暂时失效,在后续可能重新变为 active 状态
cancelled表示该订单已经被取消,无法被交易
sold表示该订单已经被成交,无法再次被交易

欧易订单模型#

订单返回数据模型模型

参数类型描述
orderIdString订单 ID
createTimeLong订单创建日期
updateTimeLong订单更新日期
listingTimeLong订单挂单时间
expirationTimeLong订单有效期,结束时间
statusString订单状态,包括 (active、cancelled、sold、inactive)
orderHashString订单 hash
protocolDataString订单参数 (json)
protocolAddressString订单交易合约地址
chainString链名称,详情见已支持的网络
makerString订单发起人的地址
orderTypeString订单类型,Offer 代表出价单,BuyNow 代表挂单
priceString订单对应的每个 NFT 单价
currencyAddressString订单对应的代币地址
collectionAddressStringNFT 合约地址
tokenIdStringNFT Token ID
amountString订单对应的 NFT 数量
availableAmountString订单当前可成交的 NFT 数量

订单参数模型#

订单请求参数详情

参数类型描述
offererString订单发起人的地址
offerArray订单发起方提供的所有商品列表,一个挂单项目模型数组
considerationArray订单接收方所提供的所有商品列表,一个订单项目模型数组
startTimetimestamp订单有效期,起始时间
endTimetimestamp订单有效期,结束时间
orderTypeNumberorderType 根据两个不同的首选项为订单指定四种类型之一:OrderType
zoneString
zoneHashString固定值:0x0000000000000000000000000000000000000000000000000000000000000000
saltString随机数
conduitKeyString固定值:0x066003C1493A346357Af15158cD985b4A6e29D3F888888888888888888888888
totalOriginalConsiderationItemsNumber订单列表数量
counterNumber订单发起次数的计数器

挂单项目模型#

订单发起方提供的所有商品列表。如果是 listing 单,应该是一个 ERC721 或者 ERC1155 的 NFT 列表,如果是 offer 单,应该是一个只有代币信息的列表。

参数类型描述
itemTypenumberitem 类型:itemType
tokenStringitem 资产对应的合约地址
identifierOrCriteriaStringitem 如果是 NFT,那么代表的是 NFT 的 tokenId,如果是代币,可以忽略这个值
startAmountnumber订单成交时,item 提供的数量
endAmountnumber订单最终成交的 item 数量

订单项目模型#

订单接收方所提供的所有商品列表。这个列表包含三部分内容 (按照排序):

  1. 资产信息( offer 单时为 NFT,listing 单时为 offer 费用)
  2. OKX 平台手续费 (可选)
  3. 合集版税(可选)
参数名类型描述
itemTypenumberitem 类型:itemType
tokenStringitem 资产对应的合约地址
identifierOrCriteriaStringitem 如果是 NFT,那么代表的是 NFT 的 tokenId,如果是代币,可以忽略这个值
startAmountnumber订单成交时,item 提供的数量
endAmountnumber订单最终成交的 item 数量
recipientString每一个 item 对应的接收地址

枚举类#

订单类型#

enum OrderType {
  FULL_OPEN,
  PARTIAL_OPEN,
  FULL_RESTRICTED,
  PARTIAL_RESTRICTED
}

项目类型#

enum ItemType {
    NATIVE,
    ERC20,
    ERC721,
    ERC1155,
    ERC721_WITH_CRITERIA,
    ERC1155_WITH_CRITERIA
}

购买订单模型#

订单请求参数详情

参数名类型描述
orderIdString要购买的订单 ID
takeCountArray购买数量