Skip to content

限价单交易历史接口文档

重要调整:此接口不分页,只传入用户地址(wallet_address)即可,不需要传入其他参数。接口会返回该用户的所有限价单数据,包括当前开仓的订单和订单历史,字段结构与原接口保持一致。

接口信息

  • 接口路径: /api/v3/sui/limit_order
  • 请求方法: GET
  • 接口描述: 获取指定钱包地址的限价单交易历史记录列表

请求参数

Query 参数

参数名类型必填说明
wallet_addressstring钱包地址,如 "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38"

请求示例

bash
GET /api/v3/sui/limit_order?wallet_address=0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38

响应数据结构

响应格式

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "type": "completed",
        "tx": "76pa6dVNLi8b99aZsF43MnHoGvVA4aspLLoEdBQCnqZg",
        "package_id": "0x37d6284f2c6cdeb5663124be7e44016399b1b657bc51564d67ec480bdff15491",
        "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::OrderPlacedEvent",
        "sender": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
        "block_time": 1762830640159,
        "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
        "owner": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
        "rate_orders_indexer_id": "0x53d0e17402dab19aef84853ebf317d2928d00f475d638cfb6fbf2b7666be050e",
        "pay_coin": "dba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
        "target_coin": "0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
        "total_pay_amount": 6000000,
        "rate": "2200000000000000",
        "expire_ts": 1763435429000,
        "remaining_amount": 0,
        "cancel_reason": 0,
        "events": [
          {
            "tx": "76pa6dVNLi8b99aZsF43MnHoGvVA4aspLLoEdBQCnqZg",
            "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::OrderPlacedEvent",
            "sender": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
            "block_time": 1762830636245,
            "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
            "amount": 6000000,
            "cancel_reason": 0
          },
          {
            "tx": "GTztvWbGPRCau1cbfyATvmPKBSu7gAW2UwuQ4oQ8VHYf",
            "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::FlashLoanEvent",
            "sender": "0x02e39bddb06f617112595378fef741f523fbf22ea188cca99ecb61a9904dda2a",
            "block_time": 1762830640159,
            "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
            "amount": 2727272728,
            "cancel_reason": 0
          }
        ]
      }
    ]
  }
}

响应字段说明

data 对象字段

字段名类型必填说明
listarray限价单列表数据

list 数组项字段

字段名类型必填说明
typestring订单状态,"pending"(进行中)、"cancelled"(已取消)、"completed"(已完成)
txstring交易哈希
package_idstring合约包 ID
event_typestring事件类型
senderstring交易发起者地址
block_timenumber区块时间戳(毫秒)
order_idstring订单 ID
ownerstring订单所有者地址
rate_orders_indexer_idstring限价单索引器 ID
pay_coinstring支付代币的 Coin Type
target_coinstring目标代币的 Coin Type
total_pay_amountnumber总支付金额(原始精度)
ratestring限价单价格,字符串格式的数字
expire_tsnumber过期时间戳(毫秒)
remaining_amountnumber剩余数量(原始精度),0 表示已完成
cancel_reasonnumber取消原因,0 表示未取消
eventsarray订单相关事件列表

events 数组项字段

字段名类型必填说明
txstring交易哈希
event_typestring事件类型,如 "OrderPlacedEvent"、"FlashLoanEvent" 等
senderstring事件发起者地址
block_timenumber区块时间戳(毫秒)
order_idstring订单 ID
amountnumber事件涉及的金额(原始精度)
cancel_reasonnumber取消原因,0 表示未取消

订单状态判断规则

type 字段根据以下规则确定:

  • "pending"(进行中)remaining_amount > 0cancel_reason == 0 且当前时间小于 expire_ts
  • "completed"(已完成)remaining_amount == 0cancel_reason == 0
  • "cancelled"(已取消)cancel_reason != 0 或当前时间大于等于 expire_ts

响应示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "type": "completed",
        "tx": "76pa6dVNLi8b99aZsF43MnHoGvVA4aspLLoEdBQCnqZg",
        "package_id": "0x37d6284f2c6cdeb5663124be7e44016399b1b657bc51564d67ec480bdff15491",
        "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::OrderPlacedEvent",
        "sender": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
        "block_time": 1762830640159,
        "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
        "owner": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
        "rate_orders_indexer_id": "0x53d0e17402dab19aef84853ebf317d2928d00f475d638cfb6fbf2b7666be050e",
        "pay_coin": "dba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
        "target_coin": "0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
        "total_pay_amount": 6000000,
        "rate": "2200000000000000",
        "expire_ts": 1763435429000,
        "remaining_amount": 0,
        "cancel_reason": 0,
        "events": [
          {
            "tx": "76pa6dVNLi8b99aZsF43MnHoGvVA4aspLLoEdBQCnqZg",
            "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::OrderPlacedEvent",
            "sender": "0x35487e65c8aef497fa8f29cbe9cb097c88753eb8172c0f640285921169730d38",
            "block_time": 1762830636245,
            "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
            "amount": 6000000,
            "cancel_reason": 0
          },
          {
            "tx": "GTztvWbGPRCau1cbfyATvmPKBSu7gAW2UwuQ4oQ8VHYf",
            "event_type": "0x533fab9a116080e2cb1c87f1832c1bf4231ab4c32318ced041e75cc28604bba9::limit_order::FlashLoanEvent",
            "sender": "0x02e39bddb06f617112595378fef741f523fbf22ea188cca99ecb61a9904dda2a",
            "block_time": 1762830640159,
            "order_id": "0xf99caf64eb2d24106dad37e6a79519a61c27766ea420fe31266d28061ac9ead1",
            "amount": 2727272728,
            "cancel_reason": 0
          }
        ]
      }
    ]
  }
}

注意事项

  1. wallet_address 参数为必填项,需要传入完整的钱包地址
  2. type 字段由后端根据 remaining_amountcancel_reasonexpire_ts 自动计算,前端可直接使用
  3. block_timeexpire_ts 为时间戳(毫秒),前端需要转换为可读的时间格式
  4. total_pay_amountremaining_amountamount 为原始精度的代币数量,前端需要根据代币的 decimals 进行格式化显示
  5. rate 为字符串格式的数字,表示限价单的价格,前端需要根据需要进行格式化显示
  6. pay_cointarget_coin 为代币的 Coin Type,前端需要根据代币列表获取对应的符号、图标等信息
  7. cancel_reason 为 0 表示未取消,非 0 值表示已取消,具体取消原因代码需要参考合约文档
  8. events 数组包含该订单相关的所有事件,如订单创建事件、成交事件等
  9. event_type 字段包含完整的事件类型路径,前端可以根据事件类型进行不同的展示
  10. 当订单已过期(当前时间 >= expire_ts)时,type 应设置为 "cancelled"
  11. 响应格式遵循 Cetus API 标准:code 为 0 表示成功,msg 为状态消息