跳到主要内容

REST API 命令列表[旧版]

本文档描述了交易系统支持的所有REST API命令及其请求/响应格式。

API接口概览​

  • Sync: 同步命令
  • Async: 异步命令
信息

异步命令的返回值仅表示命令已成功发送，实际执行结果将通过对应的回调函数返回。例如：异步下单结果在 on_order_submitted 中返回，修改订单、批量下单、批量撤单等操作均遵循此机制。

自定义请求​

接口SyncAsync
Request√

公共行情​

接口SyncAsync
Ticker√
Bbo√
Depth√
Instrument√
FundingRate√

订单操作​

接口SyncAsync
GetOrders√
GetOrderById√
GetOpenOrders√
GetAllOpenOrders√
PlaceOrder√√
BatchPlaceOrder√√
AmendOrder√√
CancelOrder√√
BatchCancelOrder√√
BatchCancelOrderById√√

账户操作​

接口SyncAsync
UsdtBalance√
Balance√
MaxPosition√
MaxLeverage√
MarginMode√
SetMarginMode√
Position√
FeeRate√
SetLeverage√
SetDualSidePosition√
IsDualSidePosition√
Transfer√
GetAccountInfo√
Borrow√
GetBorrowed√
Repay√
GetBorrowRate√
GetBorrowLimit√
GetAccountMode√
SetAccountMode√
FundingFee√

API 接口详情​

完整的请求体

请求参数

参数类型是否必须描述
exchangeString是交易所详情
account_idNumber是账户ID
contextObject是上下文信息
cmdObject是命令详情

请求示例:

{
    "exchange": "BinanceSwap",
    "account_id": 0,
    "context": {
        "latency": {
            "timer": 1731049492802925100,
            "times": {
                "strategy_begin": null,
                "strategy_end": null,
                "ex_command_begin": null,
                "place_order_end": null,
                "amend_end": null
            },
            "label_times": {
                "start": 0.0
            },
            "label_duration_metas": []
        },
        "request_id": null
    },
    {
      ...
    }
}

自定义请求​

Request​

自定义请求

请求参数:

参数类型是否必须描述
methodString是HTTP方法: GET/POST/PUT/DELETE
pathString是API路径
authBoolean是是否需要认证
paramsObject否请求参数
urlString否完整URL(设置后path无效)
headersObject否自定义请求头

请求示例:

{
  "Sync": {
    "Request": {
      "method": "GET",
      "path": "/api/v1/ticker",
      "auth": false,
      "params": {
          "symbol": "BTC_USDT"
      }
    }
  }
}

响应:

返回交易所原始响应数据

响应示例:

"Ok": {
  // 交易所返回的原始数据
}

公共行情​

Ticker​

获取给定/所有交易对24h交易信息

请求参数:

参数类型是否必须描述
TickerString/null是交易对名称,null表示查询所有

示例:

// 查询给定交易对行情
{
  "Sync": {
    "Ticker": "BTC_USDT"
  }
}
// 查询所有交易对行情
{
  "Sync": {
    "Ticker": null
  }
}

响应字段

字段类型描述
symbolString交易对名称
timestampNumber时间戳
highNumber最高价
lowNumber最低价
openNumber开盘价
closeNumber收盘价
volumeNumber成交量，基础货币
quote_volumeNumber成交额, 报价货币
changeNumber涨跌幅
change_percentNumber涨跌幅百分比

响应示例:

"Ok": [
  {
    "symbol": "BTC_USDT",
    "timestamp": 1678234567000,
    "high": 50000.0,
    "low": 49000.0,
    "open": 49500.0,
    "close": 50000.0,
    "volume": 1000.0,
    "quote_volume": 5000000.0,
    "change": 500.0,
    "change_percent": 0.01
  }
]

Bbo​

获取给定交易对的最佳报价

请求参数:

参数类型是否必须描述
BboString/null是交易对名称,null表示查询所有

示例:

// 查询给定交易对最佳报价
{
  "Sync": {
    "Bbo": "BTC_USDT"
  }
}
// 查询所有交易对最佳报价
{
  "Sync": {
    "Bbo": null
  }
}

响应字段:

字段类型描述
symbolString交易对名称
bid_priceNumber最佳买单价格
bid_qtyNumber最佳买单数量
ask_priceNumber最佳卖单价格
ask_qtyNumber最佳卖单数量
timestampNumber时间戳

响应示例:

"Ok": [
  {
    "symbol": "BTC_USDT",
    "bid_price": 50000.0,
    "bid_qty": 1000.0,
    "ask_price": 51000.0,
    "ask_qty": 1000.0,
    "timestamp": 1678234567000
  }
]

Depth​

获取给定交易对的深度信息

请求参数:

参数类型是否必须描述
DepthString是交易对名称
limitNumber/null否深度条数,默认5

示例:

// 查询给定交易对深度
{
  "Sync": {
    "Depth": ["BTC_USDT",10]
  }
}

响应字段:

字段类型描述
symbolString交易对名称
timestampNumber时间戳
bidsArray(DepthEntry)买单深度
asksArray(DepthEntry)卖单深度

DepthEntry 数据结构:

字段类型描述
priceNumber价格
amountNumber数量

响应示例:

"Ok": {
  "symbol": "BTC_USDT",
  "timestamp": 1678234567000,
  "bids": [
    [50000.0, 1000.0],
    [49990.0, 1000.0]
  ],
  "asks": [
    [51000.0, 1000.0],
    [51010.0, 1000.0]
  ]
}

Instrument​

获取给定/所有交易对的合约信息

请求参数:

参数类型是否必须描述
InstrumentString/null是交易对名称,null表示查询所有

示例:

// 查询BTC_USDT合约信息
{
  "Sync": {
    "Instrument": "BTC_USDT"
  }
}
// 查询所有合约信息
{
  "Sync": {
    "Instrument": null
  }
}

响应字段:

字段类型描述
symbolString交易对名称
stateString交易状态
price_tickNumber价格步长
amount_tickNumber数量步长
price_precisionNumber交易所的价格小数位
amount_precisionNumber交易所的数量小数位
min_qtyNumber数量下限, 最小下单数量
min_notionalNumber最小名义价值，仅币安/bitget有该规则
price_multiplierNumber价格乘数
amount_multiplierNumber数量乘数

交易状态:

  • Normal: 正常
  • Maintenance: 交易所维护
  • LimitOpen: 限制开仓
  • CloseOnly: 关闭交易

响应示例:

"Ok": {
  "symbol": "BTC_USDT",
  "state": "Normal",
  "price_tick": 0.1,
  "amount_tick": 0.001,
  "price_precision": 1,
  "amount_precision": 3,
  "min_qty": 0.001,
  "min_notional": 5.0,
  "price_multiplier": 1.0,
  "amount_multiplier": 1.0
}

FundingRate​

获取交易对的资金费率

请求参数:

参数类型是否必须描述
FundingRateString/null是交易对名称,null表示查询所有

示例:

// 查询BTC_USDT资金费率
{
  "Sync": {
    "FundingRate": "BTC_USDT"
  }
}

响应字段:

字段类型描述必填
symbolString交易对名称是
funding_rateNumber当前资金费率是
next_funding_atNumber下次资金费时间戳是
funding_intervalNumber资金费结算周期，以小时为单位否

响应示例:

"Ok": [
  {
    "symbol": "BTC_USDT",
    "funding_rate": 0.0001,
    "next_funding_at": 1678234567000,
    "funding_interval": 8
  }
]

订单操作​

GetOrders​

获取给定交易对的历史订单

请求参数:

参数类型是否必须描述
GetOrdersString是交易对名称,例如 "BTC_USDT"
start_timeNumber是开始时间戳。毫秒
end_timeNumber是结束时间戳, 毫秒

请求示例:

{
  "Sync": {
    "GetOrders": [
        "BTC_USDT",
        0,
        1678234567000
    ]
  }
}

响应字段:

字段类型描述
idString订单ID
symbolString交易对名称
statusSting订单状态
order_typeString订单类型: Limit/Market
sideString交易方向: Buy/Sell
pos_sideString持仓方向: Long/Short
priceNumber委托价格
amountNumber委托数量
filledNumber已成交数量
filled_avg_priceNumber成交均价

响应示例:

"Ok": [
  {
    "id": "order123",
    "symbol": "BTC_USDT",
    "status": "Open",
    "order_type": "Limit",
    "side": "Buy",
    "pos_side": "Long",
    "price": 50000.0,
    "amount": 0.1,
    "filled": 0.0,
    "filled_avg_price": 0.0
  }
]

GetOrderById​

获取订单详情

请求参数:

参数类型是否必须描述
symbolSymbol是交易对名称,例如 "BTC_USDT"
IdOrderId是订单Id或者客户端自定义Id

OrderId

参数类型是否必须描述
IdString是订单Id
ClientOrderIdString是客户端自定义Id

请求示例: 根据订单Id查询

{
    "Sync": {
      "GetOrderById": [
        "BTC_USDT",
        {
          "Id": "test1"
        }
      ]
    }
}

请求示例: 根据客户自定义订单Id查询

{
    "Sync": {
      "GetOrderById": [
        "BTC_USDT",
        {
          "ClientOrderId": "test2"
        }
      ]
    }
}

响应字段:

字段类型描述
idString订单ID
symbolString交易对名称
statusSting订单状态
order_typeString订单类型: Limit/Market
sideString交易方向: Buy/Sell
pos_sideString持仓方向: Long/Short
priceNumber委托价格
amountNumber委托数量
filledNumber已成交数量
filled_avg_priceNumber成交均价

响应示例:

"Ok": [
  {
    "id": "order123",
    "symbol": "BTC_USDT",
    "status": "Open",
    "order_type": "Limit",
    "side": "Buy",
    "pos_side": "Long",
    "price": 50000.0,
    "amount": 0.1,
    "filled": 0.0,
    "filled_avg_price": 0.0
  }
]

GetOpenOrders​

获取当前交易对挂单

请求参数:

参数类型是否必须描述
GetOpenOrdersString是交易对名称

请求示例:

{
  "Sync": {
    "GetOpenOrders": "BTC_USDT"
  }
}

响应字段:

同GetOrders

响应示例:

"Ok": [
  {
    "id": "order123",
    "symbol": "BTC_USDT",
    "status": "Open",
    "order_type": "Limit",
    "side": "Buy",
    "pos_side": "Long",
    "price": 50000.0,
    "amount": 0.1,
    "filled": 0.0,
    "filled_avg_price": 0.0
  }
]

GetAllOpenOrders​

获取当前所有挂单

请求示例:

{
  "Sync": "GetAllOpenOrders"
}

响应字段:

同GetOrders

响应示例:

"Ok": [
  {
    "id": "order123",
    "symbol": "BTC_USDT",
    "status": "Open",
    "order_type": "Limit",
    "side": "Buy",
    "pos_side": "Long",
    "price": 50000.0,
    "amount": 0.1,
    "filled": 0.0,
    "filled_avg_price": 0.0
  },
]

PlaceOrder​

下单

请求参数:

参数类型是否必须描述
cidString否客户端自定义订单ID
symbolString是交易对名称
order_typeString是订单类型: Limit/Market
sideString是交易方向: Buy/Sell
pos_sideString是持仓方向: Long/Short
priceNumber限价单必须委托价格
amountNumber是委托数量
time_in_forceString否有效期类型: GTC/IOC/FOK/PostOnly
-以下需要另起一个对象-------
is_dual_sideBoolean是是否开启双向持仓
leverageNumber否杠杆倍数，仅huobi需要
margin_modeString否保证金模式: Cross/Isolated，仅okx需要
take_profitNumber否止盈价格
stop_lossNumber否止损价格
leverage_order_modeString否杠杆订单模式, Normal: 普通下单; AutoLoan: 自动借款下单, AutoRepay: 自动还款下单; AutoLoanAndRepay: 自动借款还款下单
market_order_modeString否市价单模式, Safe:安全市价单，订单必须传价格，会变成ioc加滑点下单，默认滑点为0.2%，可以传入滑点参数; Normal: 普通市价单，订单可以不传价格

请求示例:

{
  "Sync": {
    "PlaceOrder": [
      {
        "cid": "test1234567",
        "symbol": "BTC_USDT",
        "order_type": "Limit",
        "side": "Buy",
        "pos_side": "Long",
        "price": 50000.0,
        "amount": 0.1,
        "time_in_force": "GTC"
      },
      {
        "is_dual_side": false,
        "leverage": 10,
        "margin_mode": "Cross",
        "take_profit": null,
        "stop_loss": null,
        "leverage_order_mode": null,
        "market_order_mode":{
          "Safe":{
            "slippage":0.002
            },
        }
      }
    ]
  }
}

market_order_mode可传入值如下所示： {"market_order_mode":{"Safe":{"slippage":0.002}}} 安全市价单, 可以传入滑点参数 {"market_order_mode":{"Safe":null}} 安全市价单，默认滑点为0.2% {"market_order_mode":"Normal"} 普通市价单

响应字段:

字段类型描述
OkString订单ID

响应示例:

"Ok": "order_12345"

BatchPlaceOrder​

批量下单

请求参数:

参数类型是否必须描述
BatchPlaceOrderArray/Object是订单数组,每个订单的参数同PlaceOrder
BatchPlaceOrder.paramsObject是订单共同参数，同PlaceOrder

请求示例:

{
  "Sync": {
    "BatchPlaceOrder": [
      [
        {
          "symbol": "BTC_USDT",
          "order_type": "Limit",
          "side": "Buy",
          "pos_side": "Long",
          "price": 50000.0,
          "amount": 0.1
        },
        {
          "symbol": "BTC_USDT", 
          "order_type": "Limit",
          "side": "Sell",
          "pos_side": "Short",
          "price": 51000.0,
          "amount": 0.1
        }
      ],
      {
        "is_dual_side": false,
        "leverage": 10
      }
    ]
  }
}

响应字段:

字段类型描述
BatchOrderRspBatchOrderRsp订单列表

响应示例:

"Ok": {
  "success_list": [
    {
      "id": "order id",
      "cid": null
    },
    {
      "id": null,
      "cid": "orde client id"
    }
  ],
  "failure_list": [
    {
      "id": "order id",
      "cid": null,
      "error_code": 0,
      "error": "error"
    },
    {
      "id": null,
      "cid": "order client id",
      "error_code": 0,
      "error": "error"
    }
  ]
}

AmendOrder​

修改订单

请求参数:

参数类型是否必须描述
idString否订单ID, id和cid必须有一个
cidString否客户端自定义订单ID
symbolString是交易对名称
order_typeString是订单类型: Limit/Market
sideString是交易方向: Buy/Sell
pos_sideString是持仓方向: Long/Short
priceNumber限价单必须委托价格
amountNumber是委托数量
time_in_forceString否有效期类型: GTC/IOC/FOK

请求示例:

{
  "Sync": {
    "AmendOrder":{
      "id": "order_12345",
      "symbol": "BTC_USDT",
      "order_type": "Limit",
      "side": "Buy",
      "pos_side": "Long",
      "price": 50000.0,
      "amount": 0.1
    }
  }
}

响应字段:

字段类型描述
OkString订单ID

响应示例:

"Ok": "order_12345"

CancelOrder​

撤单

请求参数:

参数类型是否必须描述
IdString否订单ID,Id和ClientOrderId必须有一个
ClientOrderIdString否客户自定义的订单ID
SymbolString是交易对名称

请求示例:

{
  "Async": {
    "CancelOrder": [
      {
        "Id": "test"
        // 或者
        // "ClientOrderId": "test"
      },
      "BTC_USDT"
    ]
  }
}

响应字段:

成功返回 Ok:null

响应示例:

"Ok": null

BatchCancelOrder​

批量撤单

请求参数:

参数类型是否必须描述
BatchCancelOrderString是交易对名称

请求示例:

{
  "Async": {
    "BatchCancelOrder": "BTC_USDT"
  }
}

响应字段:

字段类型描述
BatchOrderRspBatchOrderRsp订单列表

响应示例:

"Ok": {
  "success_list": [
    {
      "id": "order id",
      "cid": null
    },
    {
      "id": null,
      "cid": "orde client id"
    }
  ],
  "failure_list": [
    {
      "id": "order id",
      "cid": null,
      "error_code": 0,
      "error": "error"
    },
    {
      "id": null,
      "cid": "order client id",
      "error_code": 0,
      "error": "error"
    }
  ]
}

BatchCancelOrderById​

根据订单id或者客户端id批量撤单

请求参数:

参数类型是否必须描述
SymbolString否表示要取消的订单的交易对。部分交易所不需要传: KrakenSpot、KucoinSwap(通过order_id撤单时)、BitgetSwap(通过order_id撤单时)
IdsArray[String]否订单Id数组
CidsArray[String]否客户自定义订单Id数组

Ids和Cids至少一个不为空

请求示例:

{
    "Sync": {
      "BatchCancelOrderById": [
        "BTC_USDT",
        [
          "order-id-1"
        ],
        [
          "order-client-id-2"
        ]
      ]
    }
}

响应字段:

字段类型描述
BatchOrderRspBatchOrderRsp订单列表

响应示例:

"Ok": {
  "success_list": [
    {
      "id": "order id",
      "cid": null
    },
    {
      "id": null,
      "cid": "orde client id"
    }
  ],
  "failure_list": [
    {
      "id": "order id",
      "cid": null,
      "error_code": 0,
      "error": "error"
    },
    {
      "id": null,
      "cid": "order client id",
      "error_code": 0,
      "error": "error"
    }
  ]
}

账户操作​

UsdtBalance​

查询USDT余额

请求示例:

{
  "Sync": "UsdtBalance"
}

响应字段:

字段类型描述
assetString资产名称
balanceNumber总余额
available_balanceNumber可用余额
unrealized_pnlNumber未实现盈亏

响应示例:

"Ok": {
  "asset": "USDT",
  "balance": 1000.0,
  "available_balance": 900.0,
  "unrealized_pnl": 100.0
}

Balance​

查询多币种余额

请求示例:

{
    "Sync": "Balance"
}

响应字段:

字段类型描述
assetString资产名称
balanceNumber总余额
available_balanceNumber可用余额
unrealized_pnlNumber未实现盈亏

响应示例:

"Ok": [
  {
    "asset": "BTC",
    "balance": 1.0,
    "available_balance": 0.8,
    "unrealized_pnl": 0.0
  },
  {
    "asset": "USDT",
    "balance": 10000.0,
    "available_balance": 8000.0,
    "unrealized_pnl": 100.0
  }
]

BalanceByCoin​

查询指定币种余额

请求参数:

参数类型是否必须描述
symbolString是交易对名称

请求示例:

{
    "Sync": {
      "BalanceByCoin": "USDT"
    }
}

响应字段:

字段类型描述
assetString资产名称
balanceNumber总余额
available_balanceNumber可用余额
unrealized_pnlNumber未实现盈亏

响应示例:

"Ok": {
  "asset": "USDT",
  "balance": 1000.0,
  "available_balance": 900.0,
  "unrealized_pnl": 100.0
}

Position​

查询账户下给定交易对/所有持仓

请求参数:

参数类型是否必须描述
PositionString/null否交易对名称,null表示查询所有

请求示例:

// 查询给定交易对持仓
{
  "Sync": {
    "Position": "BTC_USDT"
  }
}
// 查询所有持仓
{
  "Sync": {
    "Position": null
  }
}

响应字段:

字段类型描述
symbolString交易对名称
timestampNumber时间戳
margin_modeString保证金模式: Cross/Isolated
sideString持仓方向: Long/Short
leverageNumber杠杆倍数
amountNumber持仓数量
entry_priceNumber开仓均价
unrealized_pnlNumber未实现盈亏

响应示例:

"Ok": [
  {
    "symbol": "BTC_USDT",
    "timestamp": 1678234567000,
    "margin_mode": "Cross",
    "side": "Long",
    "leverage": 10,
    "amount": 0.1,
    "entry_price": 50000.0,
    "unrealized_pnl": 100.0
  }
]

MaxPosition​

最大持仓

请求参数:

参数类型是否必须描述
symbolString是交易对名称
leverageNumber是杠杆

请求示例:

{
    "Sync": {
      "MaxPosition": [
        "BTC_USDT",
        10
      ]
    }
}

响应字段:

字段类型描述
longPositionValue多仓最大持仓
shortPositionValue空仓最大持仓

PositionValue： Notional： 最大持仓价值 Quantity： 最大持仓数量

响应示例:

"Ok": {
  "long": {
    "Notional": 10000000.0
  },
  "short": {
    "Quantity": 100.0
  }
}

MaxLeverage​

最大杠杆

请求参数:

参数类型是否必须描述
symbolString是交易对名称

请求示例:

{
    "Sync": {
      "MaxLeverage": "BTC_USDT"
    }
}

响应字段:

字段类型描述
leverageNumber最大杠杆

响应示例:

"Ok": {
  "long": {
    "Notional": 10000000.0
  },
  "short": {
    "Quantity": 100.0
  }
}

MarginMode​

查询保证金模式 全仓/逐仓

请求参数:

参数类型是否必须描述
symbolString是交易对名称
coinString是保证金币种

请求示例:

{
    "Sync": {
      "MarginMode": [
        "BTC_USDT",
        "USDT"
      ]
    }
}

响应字段:

字段类型描述
margin_modeMarginMode保证金模式: Cross/Isolated

响应示例:

"Ok": "Cross"

SetMarginMode​

设置保证金模式 全仓/逐仓

请求参数:

参数类型是否必须描述
symbolString是交易对名称
coinString是保证金币种
margin_modeMarginMode是保证金模式: Cross/Isolated

请求示例:

{
    "Sync": {
      "SetMarginMode": [
        "BTC_USDT",
        "USDT",
        "Cross"
      ]
    }
}

响应字段:

字段类型描述
resultResult结果 Ok/Err

响应示例:

"Ok": null

FeeRate​

查询手续费率

请求参数:

参数类型是否必须描述
FeerateString是交易对名称

请求示例:

{
  "Sync": {
    "FeeRate": "BTC_USDT"
  }
}

响应字段:

字段类型描述
takerNumberTaker手续费率
makerNumberMaker手续费率

响应示例:

"Ok": {
  "taker": 0.0004,
  "maker": 0.0002
}

SetLeverage​

设置杠杆

请求参数:

参数类型是否必须描述
symbolString是交易对名称
leverageNumber是杠杆倍数

请求示例:

{
    "Sync": {
      "SetLeverage": [
        "BTC_USDT",
        1
      ]
  }
}

响应:

响应示例:

"Ok": null

SetDualSidePosition​

设置双向持仓

请求参数:

参数类型是否必须描述
SetDualSidePositionBoolean是true:开启双向持仓, false:单向持仓

请求示例:

{
  "Sync": {
    "SetDualSidePosition": true
  }
}

响应:

响应示例:

"Ok": null

IsDualSidePosition​

查询是否双向持仓

请求示例:

{
  "Sync": "IsDualSidePosition"
}

响应示例:

"Ok": true

Transfer​

万向划转

请求参数:

参数类型是否必须描述
assetString是币种
amountNumber是划转数量
fromWalletType是转出账户类型，本质是String
toWalletType是转入账户类型

WalletType:

  • Spot: 现货钱包
  • UsdtFuture: U本位合约钱包
  • CoinFuture: 币本位合约钱包
  • Margin: 杠杆全仓钱包
  • IsolatedMargin: 杠杆逐仓钱包

请求示例:

{
  "Sync": {
    "Transfer": {
      "asset": "USDT",
      "amount": 1.0,
      "from": "Spot",
      "to": "CoinFuture"
    }
  }
}

GetAccountInfo​

获取账户信息

请求示例:

{
  "Sync": "GetAccountInfo"
}

响应字段:

字段类型描述
total_mmrNumber总保证金率
total_equityNumber总权益
total_availableNumber总可用

响应示例:

"Ok": {
  "total_mmr": 0.0,
  "total_equity": 1234.56,
  "total_available": 1234.56
}

Borrow​

借币

请求参数:

参数类型是否必须描述
coinString是币种
amountNumber是数量

请求示例:

{
    "Sync": {
      "Borrow": [
        "USDT",
        100.0
      ]
    }
}

响应:

响应示例:

"Ok": null

GetBorrowed​

获取借币数量

请求参数:

参数类型是否必须描述
coinString是币种

请求示例:

{
    "Sync": {
      "GetBorrowed": "USDT"
    }
}

响应字段:

字段类型描述
borrowArray[Borrow]当前借币详情

Borrow

字段类型描述
coinString是
amountNumber是

响应示例:

"Ok": [
  {
    "coin": "USDT",
    "amount": 100.0
  }
]

Repay​

还币

请求参数:

参数类型是否必须描述
coinString是币种
amountNumber是数量

请求示例:

{
    "Sync": {
      "Repay": [
        "USDT",
        100.0
      ]
    }
}

响应:

响应示例:

"Ok": null

GetBorrowRate​

获取借贷利率

请求参数:

参数类型是否必须描述
coinString否币种

请求示例:

{
    "Sync": {
      "GetBorrowRate": "USDT"
    }
}

响应示例:

"Ok": [
  {
    "ccy": "USDT",
    "rate": 0.0001
  }
]

GetBorrowLimit​

获取借贷利率

请求参数:

参数类型是否必须描述
is_vipbool否是否是vip
coinString是币种

请求示例:

{
    "Sync": {
      "GetBorrowLimit": [
        null,
        "USDT"
      ]
    }
}

响应字段:

字段类型描述
debtNumber当前负债
interestNumber当前计息
coinString借贷币种
rateString日利率
borrow_limitString可借贷限额
vip_detailObject尊享用户详情（okx）

VipDetail 尊享用户详情

字段类型描述
pos_loanNumber当前账户负债占用
available_loanNumber当前账户剩余可用
used_loanNumber当前账户已借额度

响应示例:

"Ok": {
  "debt": 0.0,
  "interest": 0.0,
  "coin": "USDT",
  "rate": 0.0001,
  "borrow_limit": 1000.0,
  "vip_detail": {
    "pos_loan": 0.0,
    "available_loan": 0.0,
    "used_loan": 0.0
  }
}

GetAccountMode​

获取账户模式

请求示例:

{
    "Sync": "GetAccountMode"
}

响应字段:

字段类型描述
account_modeAccountMode账户模式

AccountMode枚举

枚举名描述
Classic初始经典账户模型
SpotAndSwap现货和合约模式
MultiCurrency跨币种保证金模式
Portfolio组合保证金模式

响应示例:

"Ok": "MultiCurrency"

SetAccountMode​

设置账户模式

请求参数:

参数类型是否必须描述
account_modeAccountMode是账户模式

请求示例:

{
    "Sync": {
      "SetAccountMode": "MultiCurrency"
    }
}

响应:

响应示例:

"Ok": null

FundingFee​

获取历史资金结算费用

请求参数:

参数类型是否必须描述
symbolString交易对名称是
start_timeNumber开始时间戳否
end_timeNumber结束时间戳否

示例:

{
  "Sync": {
    "FundingFee": 
      [
        "BTC_USDT",
        1678234567000,
        1678234667000
      ]
  }
}

响应字段:

字段类型描述
symbolString交易对名称
timestampNumber时间戳
funding_feeNumber资金费率

响应示例:

"Ok": [
  {
    "symbol": "BTC_USDT",
    "timestamp": 1678234567000,
    "funding_fee": 0.0001
  },
  {
    "symbol": "BTC_USDT",
    "timestamp": 1678234567000,
    "funding_fee": 0.0001
  }
]

错误处理​

所有API在发生错误时会返回以下格式:

错误响应示例:

{
  "命令名": {
    "Err": {
      "code": 10001, // 错误码
      "error": "错误描述",
      "location": "错误位置"
    }
  }
}

通用枚举值​

订单状态(status)

  • Open - 未成交
  • PartiallyFilled - 部分成交
  • Filled - 全部成交
  • Canceled - 已取消

订单类型 (order_type):

  • Limit: 限价单
  • Market: 市价单

订单方向 (side):

  • Buy: 买入
  • Sell: 卖出

持仓方向 (pos_side):

  • Long: 多仓
  • Short: 空仓

订单有效期 (time_in_force):

  • GTC: Good Till Cancel, 一直有效直到取消
  • IOC: Immediate or Cancel, 立即成交或取消
  • FOK: Fill or Kill, 完全成交或取消

保证金模式 (margin_mode):

  • Cross: 全仓模式
  • Isolated: 逐仓模式

交易对状态 (state):

  • Normal: 正常交易
  • Suspended: 暂停交易