English
NAV
console

Welcome

欢迎来到CoinCatch API文档，点击这里直接开始

更新日志

2023年05月26日

2023年05月26日

简介

API 简介

欢迎使用CoinCatch开发者文档！

此文档是CoinCatch API的唯一官方文档，CoinCatch API提供的能力会在此持续更新，请大家及时关注。

你可以通过点击上方菜单来切换获取不同业务的API，还可通过点击右上方的语言按钮来切换文档语言。

文档右侧是针对请求参数以及响应结果的示例。

更新关注

关于API新增、更新、下线等信息CoinCatch会提前发布公告进行通知，建议您关注和订阅我们的公告，及时获取相关信息。

联系我们

使用过程中如有问题或者建议，您可选择以下方式联系我们：

常见问题

A : 下单接口所有的 symbol 参数都是传 合约信息接口接口的 symbol 返回的值

快速入门

接入准备

如需使用API ，请先登录网页端，完成API key的申请和权限配置，再据此文档详情进行开发和交易。

您可以点击 这里 创建 API Key。

每个用户可创建10组Api Key，每个Api Key可对应设置读取、交易两种权限。

权限说明如下：

创建成功后请务必记住以下信息：

接口类型

本章节主要为接口类型分以下两个方面：

公共接口

公共接口可用于获取配置信息和行情数据。公共请求无需认证即可调用。

私有接口

私有接口可用于订单管理和账户管理。每个私有请求必须使用规范的验证形式进行签名。

私有接口需要使用您的APIKey进行验证。

访问限制

本章节主要为访问限制：

Rest API

如果传入有效的APIKey 用APIKey限速；如果没有则拿公网IP限速。

限速规则：各个接口上有单独的说明，如果没有一般接口限速为 10次/秒。

特殊说明：批量下单时，若下4个币对，每个币对10个订单时，计为一次请求。

API域名

您可以自行使用Rest API接入方式进行操作。

域名 REST API 建议使用
域名 https://api.coincatch.com 主域名

API验证

发起请求

所有REST请求的header都必须包含以下key：

//Java
System.currentTimeMillis();

//python
import time
time.time_ns() / 1000000

//Golang
import (
  "time"
)
int64(time.Now().UnixNano()/1000000)

//Javascript
Math.round(new Date())

//PHP
microtime(true) * 1000;

签名

ACCESS-SIGN的请求头是对 timestamp + method.toUpperCase() + requestPath + "?" + queryString + body 字符串(+表示字符串连接)使用 HMAC SHA256 方法加密，通过BASE64 编码输出而得到的。

签名各字段说明

queryString为空时，签名格式

timestamp + method.toUpperCase() + requestPath + body

queryString不为空时，签名格式

timestamp + method.toUpperCase() + requestPath + "?" + queryString + body

举例说明

获取合约深度信息，以 BTCUSDT_UMCBL 为例:

生成待签名的字符串:

'16273667805456GET/api/mix/v1/market/depth?symbol=BTCUSDT_UMCBL&limit=20'

合约下单，以 BTCUSDT_UMCBL 为例:

生成待签名的字符串:

'16273667805456POST/api/mix/v1/order/placeOrder{"symbol":"BTCUSDT_UMCBL","size":"8","side":"open_long","order_type":"limit","client_oid":"CoinCatch#123456"}'

生成最终签名的步骤

第1步，将待签名字符串使用私钥secretkey进行hmac sha256加密

Signature = hmac_sha256(secretkey, Message)

第2步，对于Signature进行base64编码

Signature = base64.encode(Signature)

签名示例

Java

public static String generate(String timestamp, String method, String requestPath,
                                  String queryString, String body, String secretKey)
            throws CloneNotSupportedException, InvalidKeyException, UnsupportedEncodingException {

        method = method.toUpperCase();
        body = StringUtils.defaultIfBlank(body, StringUtils.EMPTY);
        queryString = StringUtils.isBlank(queryString) ? StringUtils.EMPTY : "?" + queryString;

        String preHash = timestamp + method + requestPath + queryString + body;
        System.out.println(preHash);
        byte[] secretKeyBytes = secretKey.getBytes(SignatureUtils.CHARSET);
        SecretKeySpec secretKeySpec = new SecretKeySpec(secretKeyBytes, SignatureUtils.HMAC_SHA256);
        Mac mac = (Mac) SignatureUtils.MAC.clone();
        mac.init(secretKeySpec);
        return Base64.getEncoder().encodeToString(mac.doFinal(preHash.getBytes(SignatureUtils.CHARSET)));
    }


public static void main(String[] args) throws Exception {
      String msg=generate("1659927638003","POST","/api/mix/v1/order/placeOrder" ,null,"{"symbol":"TRXUSDT_UMCBL","side":"open_long","orderType":"limit","force":"normal","price":"0.046317","quantity":"1212"}","");
      System.out.println(msg);
    }

Python

def sign(message, secret_key):
    mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
    d = mac.digest()
    return base64.b64encode(d)


def pre_hash(timestamp, method, request_path, body):
    return str(timestamp) + str.upper(method) + request_path + body



if __name__ == '__main__':
    signStr = sign(pre_hash('1659927638003', 'POST', '/api/mix/v1/order/placeOrder', str('{"symbol":"TRXUSDT_SPBL","side":"open_long","orderType":"limit","force":"normal","price":"0.046317","quantity":"1212"}')), '')
    print(signStr)

请求交互

所有请求基于Https协议，POST 请求头信息中Content-Type 需要统一设置为: 'application/json'。

请求交互说明

成功

HTTP状态码200表示成功响应，并可能包含内容。如果响应含有内容，则将显示在相应的返回内容里面。

常见错误码

标准规范

时间戳

请求签名中的ACCESS-TIMESTAMP的单位是毫秒。请求的时间戳必须在API服务时间的30秒内，否则请求将被视为过期并被拒绝。 如果本地服务器时间和API服务器时间之间存在较大的偏差，那么我们建议您使用通过查询API服务器时间来更新http header。

限频规则

如果请求过于频繁系统将自动限制请求，并在http header中返回429 too many requests状态码。

请求格式

目前只有两种格式的请求方法：GET和POST

API 公共参数

side(交易指令)

字段 说明
open_long 开多
open_short 开空
close_long 平多
close_short 平空
buy_single 单向持仓买
sell_single 单向持仓卖

business(记录类型)

字段 说明
open_long 开多
open_short 开空
close_long 平多
close_short 平空
trans_from_exchange 由现货账户转入
trans_to_exchange 转出至现货账户
contract_settle_fee 资金费率
contract_main_settle_fee 全仓资金费率。废弃，请勿在查询中使用
contract_margin_settle_fee 逐仓资金费率。废弃，请勿在查询中使用
tracking_trader_income 带单分润
burst_long_loss_query 爆仓平多
burst_short_loss_query 爆仓平空

tradeSide(交易方向)

double_hold 的交易方向

字段 说明
open_long 开多
open_short 开空
close_long 平多
close_short 平空
reduce_close_long 强制减多
reduce_close_short 强制减空
offset_close_long 轧差强制减多
offset_close_short 轧差强制减空
burst_close_long 爆仓平多
burst_close_short 爆仓平空
delivery_close_long 多头交割
delivery_close_short 空头交割

single_hold 的交易方向

字段 说明
buy_single 单边持仓时买
sell_single 单边持仓时卖
reduce_buy_single 单边持仓时减仓买
reduce_sell_single 单边持仓时减仓卖
burst_buy_single 爆仓买
burst_sell_single 爆仓卖
delivery_buy_single 单边持仓时多头交割
delivery_sell_single 单边持仓时空头交割

orderType(交易类型)

字段 说明
limit 限价
market 市价

timeInForceValue(订单有效期)

字段 说明
normal 普通订单, 订单会一直有效，直到被成交或者取消
post_only 只做 maker 订单
ioc 无法立即成交的部分就撤销
fok 无法全部立即成交就撤销

triggerType(触发类型)

字段 说明
fill_price 成交价触发
market_price 标记价 mark price 触发

planType(计划委托类型)

planType 的交易方向

字段 说明
normal_plan 普通计划
profit_plan 止盈计划
loss_plan 止损计划
pos_profit 仓位止盈
pos_loss 仓位止损
moving_plan 移动止盈止损
track_plan 追踪委托

holdSide(持仓方向)

字段 说明
long 多仓
short 空仓

marginMode(仓位模式)

字段 说明
fixed 逐仓
crossed 全仓

holdMode(持仓模式)

字段 说明
single_hold 单向持仓
double_hold 双向持仓

planStatus(计划委托状态)

字段 说明
no_trigger 未触发
triggered 已触发
fail_trigger 触发失败
cancel 已撤销

productType(产品线类型)

字段 说明
umcbl USDT专业合约
dmcbl 混合合约

state(订单状态)

字段 说明
init 初始订单，插入DB成功
new 新建订单，orderbook中等待撮合
partially_filled 部分成交
filled 全部成交
canceled 已撤销

isPlan(获取计划委托类型)

字段 说明
plan 计划委托
profit_loss 止盈止损

granularity(K线类别)

老分类，不建议再使用

Websocket planType

symbolStatus

enterPointSource

Words Description
WEB 自Web端创建的订单
API 自API端创建的订单
SYS 系统托管订单, 通常由强制平仓逻辑生成
ANDROID 自Android系统端创建的订单
IOS 自IOS系统端创建的订单

RestAPI

行情接口

合约信息接口

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/contracts?productType=umcbl"

返回数据

{
  "code": "00000",
  "data": [
    {
      "baseCoin": "BTC",
      "buyLimitPriceRatio": "0.01",
      "feeRateUpRatio": "0.005",
      "makerFeeRate": "0.0002",
      "minTradeNum": "0.001",
      "openCostUpRatio": "0.01",
      "priceEndStep": "5",
      "pricePlace": "1",
      "quoteCoin": "USDT",
      "sellLimitPriceRatio": "0.01",
      "sizeMultiplier": "0.001",
      "supportMarginCoins": [
        "USDT"
      ],
      "symbol": "BTCUSDT_UMCBL",
      "takerFeeRate": "0.0006",
      "volumePlace": "3",
      "symbolType":"delivery",
      "symbolStatus": "normal",
      "offTime": "-1",
      "limitOpenTime": "-1"
    }
  ],
  "msg": "success",
  "requestTime": 1627114525850
}

返回值说明

返回字段 字段说明
symbol 产品id
symbolName 产品名称，可能为空
baseCoin 左币
quoteCoin 右币
buyLimitPriceRatio 买价限价比例
sellLimitPriceRatio 卖价限价比例
feeRateUpRatio 手续费上浮比例
makerFeeRate market手续费率
takerFeeRate taker手续费率
openCostUpRatio 开仓成本上浮比例
supportMarginCoins 支持保证金币种
minTradeNum 最小开单数量(左币)
priceEndStep 价格步长
volumePlace 数量小数位
pricePlace 价格小数位
sizeMultiplier 数量乘数 下单数量要大于 minTradeNum 并且满足 sizeMultiplier 的倍数
symbolType 合约类型 perpetual 永续 delivery交割
symbolStatus Symbol Status
offTime 下架时间, '-1' 表示正常
limitOpenTime 限制开仓时间, '-1' 表示正常; 其它值表示symbol正在/计划维护，指定时间后禁止交易

深度行情接口

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
limit String 否 深度档位 100，5 15 50 100

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/depth?symbol=BTCUSDT_UMCBL&limit=100"

返回数据

{
    "code":"00000",
    "data":{
        "asks":[
            [
                "30002",
                "0.2300000000000000"
            ],
            [
                "30002.5",
                "0.91"
            ],
            [
                "30003",
                "0.18"
            ]
        ],
        "bids":[
            [
                "29987",
                "0.28"
            ],
            [
                "300",
                "0.3333000000000000"
            ]
        ],
        "timestamp":"1627115809358"
    },
    "msg":"success",
    "requestTime":1627115809358
}

返回的量价数值可能用科学计数法表示

["1.937E+4","156.814"]

["0.000010934","1.2224E+8"]

请调整您的代码以处理用科学计数法表示的返回值

获取合并深度数据

限速规则：20次/1s

HTTP请求 获取合并深度数据

请求参数

参数名 参数类型 是否必须 描述
symbol String 是 交易对名称，例：BTCUSDT_UMCBL
precision String 否 价格精度，根据选择的精度作为步长返回累计深度，枚举值：scale0/scale1/scale2/scale3,scale0 不合并，默认值,一般情况下，scale1为交易对报价精度*10的合并深度,一般情况下，scale2为报价精度*100，scale3为报价精度*1000,0/1/2/3对应的精度以实际返回参数“scale”为准,每个交易对的报价精度都不一样，部分币对并没有scale2，请求该币对不存在的scale将会按照最大scale处理。例：某个交易对只有scale 0/1，当请求scale2时自动降为scale1。
limit String 否 固定档位枚举值：1/5/15/50/max，默认档位100，当实际深度不满足limit时，按实际档位返回，传入max返回该交易对的最大档位

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/merge-depth?symbol=ETHUSDT_UMCBL&precision=scale0&limit=5"

返回数据

{
  "code": "00000",
  "msg": "success",
  "requestTime": 1692761045039,
  "data": {
    "asks": [
      [
        1842.2,
        0.100
      ],
      [
        1842.3,
        3.176
      ],
      [
        1842.8,
        7.428
      ],
      [
        1843.3,
        6.128
      ],
      [
        1843.8,
        2.747
      ]
    ],
    "bids": [
      [
        1841.8,
        0.519
      ],
      [
        1841.3,
        2.931
      ],
      [
        1840.8,
        8.622
      ],
      [
        1840.3,
        1.018
      ],
      [
        1839.8,
        4.112
      ]
    ],
    "ts": "1692761045063",
    "scale": "0.1",
    "precision": "scale0",
    "isMaxPrecision": "NO"
  }
}

返回值说明

参数名 参数类型 字段说明
asks Array 当前价位的所有买单,如["38084.5","0.5"] 中，"38084.5"代表深度价格，"0.5"代表基础币数量
bids Array 当前价位的所有卖单
precision String 当前档位,例：scale 1
scale String 实际的精度值，例：0.1
isMaxPrecision String YES 表示当前已经是最大精度，NO 非最大精度
ts String 当前深度对应的时间

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

单个Ticker行情获取

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/ticker?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code": "00000",
    "msg": "success",
    "data": {
        "symbol": "BTCUSDT_UMCBL",
        "last": "23990.5",
        "bestAsk": "23991",
        "bestBid": "23989.5",
        "bidSz": "2.154",
        "askSz": "176.623",
        "high24h": "24131.5",
        "low24h": "23660.5",
        "timestamp": "1660705778888",
        "priceChangePercent": "0.00442",
        "baseVolume": "156243.358",
        "quoteVolume": "3735854069.908",
        "usdtVolume": "3735854069.908",
        "openUtc": "23841.5",
        "chgUtc": "0.00625",
        "indexPrice": "22381.253737",
        "fundingRate": "0.000072",
        "holdingAmount": "85862.241"
    }
}

返回值说明

返回字段 字段说明
symbol 币对名称
last 最新价
bestAsk 卖一价
bestBid 买一价
bidSz 买一量
askSz 卖一量
high24h 24小时最高价
low24h 24小时最低价
timestamp 时间戳(毫秒)
priceChangePercent 价格涨跌幅(24小时)
baseVolume 交易币交易量
quoteVolume 计价币交易量
usdtVolume usdt成交量
openUtc UTC0 开盘价
chgUtc UTC0 24小时涨跌幅
indexPrice 指数价格
fundingRate 资金费率
holdingAmount 当前持仓, 单位是base coin

全部Ticker行情获取

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/tickers?productType=umcbl"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": [{
        "symbol": "BTCUSDT_UMCBL",
        "last": "23990.5",
        "bestAsk": "23991",
        "bestBid": "23989.5",
        "bidSz": "2.154",
        "askSz": "176.623",
        "high24h": "24131.5",
        "low24h": "23660.5",
        "timestamp": "1660705778888",
        "priceChangePercent": "0.00442",
        "baseVolume": "156243.358",
        "quoteVolume": "3735854069.908",
        "usdtVolume": "3735854069.908",
        "openUtc": "23841.5",
        "chgUtc": "0.00625",
        "indexPrice": "22381.253737",
        "fundingRate": "0.000072",
        "holdingAmount": "85862.241"
    }]
}

返回值说明

返回字段 字段说明
symbol 币对名称 必须大写
last 最新价
bestAsk 卖一价
bestBid 买一价
bidSz 买一量
askSz 卖一量
high24h 24小时最高价
low24h 24小时最低价
timestamp 时间戳(毫秒)
priceChangePercent 价格涨跌幅(24小时)
baseVolume 交易币交易量
quoteVolume 计价币交易量
usdtVolume usdt成交量
openUtc UTC0 开盘价
chgUtc UTC0 24小时价格涨跌幅
indexPrice 指数价格
fundingRate 资金费率
holdingAmount 当前持仓, 单位是base coin

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

获取最近成交明细

获取最近100条成交记录

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
limit String 否 查询条数 默认100

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/fills?symbol=BTCUSDT_UMCBL&limit=100"

返回数据

{
    "code":"00000",
    "data":[
        {
            "tradeId":"802751431994691585",
            "price":"29990.5",
            "size":"0.0166",
            "side":"sell",
            "timestamp":"1627116776464",
            "symbol":"BTCUSDT_UMCBL"
        },
        {
            "tradeId":"802750695521046529",
            "price":"30007.0",
            "size":"0.0166",
            "side":"buy",
            "timestamp":"1627116600875",
            "symbol":"BTCUSDT_UMCBL"
        }
    ],
    "msg":"success",
    "requestTime":1627116936176
}

返回值说明

返回字段 字段说明
tradeId tradeId
price 价格
size 数量
side 交易方向
timestamp 时间,ms
symbol 币对名称

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

获取成交明细

限速规则: 10次/1s (IP)

HTTP请求

获取近30天成交数据，数据会按请求参数缓存10分钟，请修改endTime以获取最近的成交记录

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
limit String 否 查询条数 默认500, 最大1000
tradeId String 否 交易ID, 返回小于给定值的记录
startTime String 否 开始时间, ms
endTime String 否 结束时间, ms

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/fills-history?symbol=BTCUSDT_UMCBL&limit=12&tradeId=1020224189048217601&startTime&endTime"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": [
        {
            "tradeId": "1020224187601182723",
            "price": "21341",
            "size": "23.296",
            "side": "Buy",
            "timestamp": "1678966321000",
            "symbol": "BTCUSDT_UMCBL"
        },
        {
            "tradeId": "1020224187055923213",
            "price": "21341",
            "size": "0.804",
            "side": "Sell",
            "timestamp": "1678966321000",
            "symbol": "BTCUSDT_UMCBL"
        }
    ]
}

返回值说明

返回字段 字段说明
tradeId tradeId, 降序排列
price 价格
size 数量, base coin
side 交易方向, Sell/Buy
timestamp 时间,ms
symbol 币对名称

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

获取K线数据

限速规则: 20次/1s (IP)

HTTP请求

支持‘1m’查询30天内的数据，默认返回100条记录

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
granularity String 是 k线类别
startTime String 是 开始时间（时间戳毫秒，大于等于），根据granularity向下取整, 即granularity=1m时： 1672410799436(2022-12-30 22:33:19) 向下取整为 1672410780000 (2022-12-30 22:33:00)
endTime String 是 结束时间（时间戳毫秒，小于等于），根据granularity向下取整, 即granularity=1m时： 1672410799436(2022-12-30 22:33:19) 向下取整为 1672408800000 (2022-12-30 22:00:00)
kLineType String 否 k线类型：market mark index；默认 market
limit String 否 默认 100, 最大 1000

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/candles?symbol=BTCUSDT_UMCBL&granularity=300&startTime=1659406928000&endTime=1659410528000"

返回数据

[
    [
        "1627008780000",
        "24016",
        "24016",
        "24016",
        "24016",
        "0",
        "0"
    ],
    [
        "1627008840000",
        "24016",
        "24016",
        "24016",
        "24016",
        "0",
        "0"
    ]
]

返回值说明

返回字段 Index
时间戳 0
开盘价 1
最高价 2
最低价 3
收盘价，最新一个收盘价可能还在持续更新，请订阅websocket跟踪最新价 4
交易币成交量 5
计价币成交量 6

granularity(candles interval)

获取币种指数

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/index?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "index":"35000",
        "timestamp":"1627291836179"
    },
    "msg":"success",
    "requestTime":1627291836179
}

返回值说明

返回字段 字段说明
symbol 币对名称
index 指数价格
timestamp 时间戳

获取合约下一次结算时间

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/funding-time?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "fundingTime":"1627311600000"
    },
    "msg":"success",
    "requestTime":1627291915767
}

返回值说明

返回字段 字段说明
symbol 币对名称
fundingTime 下次结算时间

获取历史资金费率

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
pageSize int 否 查询条数 默认20
pageNo Int 否 页码
nextPage Boolean 否 是否查询下一页

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/history-fundRate?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":[
        {
            "symbol":"BTCUSDT",
            "fundingRate":"0",
            "settleTime":"1627369200000"
        }
    ],
    "msg":"success",
    "requestTime":1627389063463
}

返回值说明

返回字段 字段说明
symbol 币对名称
fundingRate 资金费率
settleTime 结算时间

获取当前资金费率

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/current-fundRate?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "fundingRate":"0.0002"
    },
    "msg":"success",
    "requestTime":1627291969594
}

返回值说明

返回字段 字段说明
symbol 币对名称
fundingRate 当前资金费率

获取平台总持仓量

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/open-interest?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "amount":"757.8338",
        "timestamp":"1627292005913"
    },
    "msg":"success",
    "requestTime":1627292005913
}

返回值说明

返回字段 字段说明
symbol 币对名称
amount 平台总持仓量
timsetamp 时间戳(毫秒)

获取合约标记价格

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/mark-price?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "markPrice":"35000",
        "timestamp":"1627292076687"
    },
    "msg":"success",
    "requestTime":1627292076687
}

返回值说明

返回字段 字段说明
symbol 币对名称
markPrice 标记价格
timsetamp 时间戳(毫秒)

获取交易对支持的杠杆

限速规则: 20次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/symbol-leverage?symbol=BTCUSDT_UMCBL"

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "minLeverage":"1",
        "maxLeverage":"125"
    },
    "msg":"success",
    "requestTime":1627292076687
}

返回值说明

返回字段 字段说明
symbol 币对名称
minLeverage 最小杠杆
maxLeverage 最大杠杆

获取仓位档位梯度配置

限速规则: 10次/1s (IP)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
symbol String 是 币对ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/market/queryPositionLever?symbol=BTCUSDT_UMCBL&productType=UMCBL"

返回数据

{
    "code":"00000",
    "data":[
        {
            "level": 1,
            "startUnit": 0,
            "endUnit": 150000,
            "leverage": 125,
            "keepMarginRate": "0.004"
        }
    ],
    "msg":"success",
    "requestTime":1627292076687
}

返回值说明

返回字段 字段说明
level 阶梯档位
startUnit 价值下限
endUnit 价值上限
leverage 杠杆倍数
keepMarginRate 维持保证金率，持仓档位对应的数值，当仓位的保证金率小于维持保证金率时，将会触发强制减仓或爆仓

账户接口

单个币种账户信息

限速规则: 10次/1s (uid)

HTTP请求

请求参数

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种

请求示例

curl "https://api.coincatch.com/api/mix/v1/account/account?symbol=BTCUSDT_UMCBL&marginCoin=USDT" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":{
        "marginCoin":"USDT",
        "locked":0,
        "available":13168.86110692,
        "crossMaxAvailable":13168.86110692,
        "fixedMaxAvailable":13168.86110692,
        "maxTransferOut":13168.86110692,
        "equity":13178.86110692,
        "usdtEquity":13178.861106922,
        "btcEquity":0.344746495477,
        "crossRiskRate":0,
        "crossMarginLeverage":20,
        "fixedLongLeverage":20,
        "fixedShortLeverage":20,
        "marginMode":"crossed",
        "holdMode":"double_hold",
        "unrealizedPL": null,
        "crossedUnrealizedPL": null,
        "isolatedUnrealizedPL": null,
        "bonus": "0"
    },
    "msg":"success",
    "requestTime":1627292199523
}

返回值说明

返回字段 字段说明
marginCoin 保证金币种
locked 锁定数量(保证金币种)，有平仓单时会lock
available 账户可用数量
crossMaxAvailable 全仓最大可用来开仓余额(保证金币种)
fixedMaxAvailable 逐仓最大可用来开仓余额(保证金币种)
maxTransferOut 最大可转出
equity 账户权益(保证金币种)，包含未实现盈亏（根据mark price计算）
usdtEquity 折算USDT账户权益
btcEquity 折算BTC账户权益
crossRiskRate 全仓时风险率
crossMarginLeverage 全仓时杠杆倍数
fixedLongLeverage 逐仓时多头杠杆
fixedShortLeverage 逐仓时空头杠杆
marginMode 保证金模式
holdMode 持仓模式
unrealizedPL 全仓未实现盈亏，USDT
crossedUnrealizedPL 当前币对下全仓未实现盈亏，USDT
isolatedUnrealizedPL 当前币对下逐仓未实现盈亏，USDT
bonus 体验金

获取账户信息列表

限速规则: 10次/1s (uid)

HTTP请求

请求参数

参数名 参数类型 是否必须 描述
productType String 是 产品类型

请求示例

curl "https://api.coincatch.com/api/mix/v1/account/accounts?productType=umcbl" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":[
        {
            "marginCoin":"USDT",
            "locked":"0.31876482",
            "available":"10575.26735771",
            "crossMaxAvailable":"10580.56434289",
            "fixedMaxAvailable":"10580.56434289",
            "maxTransferOut":"10572.92904289",
            "equity":"10582.90265771",
            "usdtEquity":"10582.902657719473",
            "btcEquity":"0.204885807029",
            "crossRiskRate": "0",
            "unrealizedPL": null,
            "bonus": "0"
        }
    ],
    "msg":"success",
    "requestTime":1630901215622
}

返回值说明

返回字段 字段说明
marginCoin 保证金币种
locked 锁定数量(保证金币种)
available 账户可用数量
crossMaxAvailable 全仓最大可用来开仓余额(保证金币种)
fixedMaxAvailable 逐仓最大可用来开仓余额(保证金币种)
maxTransferOut 最大可转出
equity 账户权益(保证金币种)，包含未实现盈亏（根据mark price计算）
usdtEquity 折算USDT账户权益
btcEquity 折算BTC账户权益
crossRiskRate 全仓时风险率
unrealizedPL 未实现盈亏
bonus 体验金

获取可开数量

限速规则: 20次/1s (IP)

此接口只是默认用户没有持仓时，来计算能开仓的最大可开数量，结果并不代表实际开仓数量

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种
openPrice BigDecimal 是 开仓价格
leverage BigDecimal 否 杠杆倍数默认20
openAmount BigDecimal 是 开仓金额

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/account/open-count" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","openPrice": "23189.5","leverage": "20","openAmount":"5000"}'

返回数据

{
    "code":"00000",
    "data":{
        "openCount":"2000"
    },
    "msg":"success",
    "requestTime":1627293049406
}

调整杠杆

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
leverage String 是 杠杆倍数
holdSide String 否 持仓方向（全仓不传）

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/account/setLeverage" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","leverage": "20"}'

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "marginCoin":"USDT",
        "longLeverage":25,
        "shortLeverage":20,
        "marginMode":"crossed"
    },
    "msg":"success",
    "requestTime":1627293049406
}

返回值说明

返回字段 字段说明
symbol 币对名称
marginCoin 保证金币种
longLeverage 多仓杠杆
shortLeveage 空仓杠杆
marginMode 保证金模式

调整保证金

限速规则: 5次/1s (uid)

全仓时, 保证金不能调整

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
holdSide String 否 持仓方向（全仓不传）
amount String 是 保证金金额 正增加 负减少

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/account/setMargin" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","amount": "-10"}'

返回数据

{
    "code":"00000",
    "data":{
        "result":true
    },
    "msg":"success",
    "requestTime":1627293357336
}

调节保证金模式

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Body)

有持仓或委托时不能调用本接口

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
marginMode String 是 保证金模式

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/account/setMarginMode" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","marginMode": "corssed"}'

返回数据

{
    "code":"00000",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "marginCoin":"USDT",
        "longLeverage":25,
        "shortLeverage":20,
        "marginMode":"corssed"
    },
    "msg":"success",
    "requestTime":1627293445916
}

返回值说明

返回字段 字段说明
symbol 币对名称
marginCoin 保证金币种
longLeverage 多仓杠杆
shortLeveage 空仓杠杆
marginMode 保证金模式

 

 

 

 

 

 

 

 

调节单双向持仓模式

注意：产品类型下有仓位/委托时不能调整持仓模式

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
holdMode String 是 单双向持仓模式："single_hold"或"double_hold"

指定productType任意币对任意side存在仓位/委托的情况下，请求会失败

{
    "code": "40920",
    "msg": "Currently holding a position, the position mode cannot be switched",
    "requestTime": 1675335833730,
    "data": null
}

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/account/setPositionMode" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"productType": "umcbl","holdMode": "double_hold"}'

返回数据

{
    "code":"00000",
    "msg":"success",
    "data":{
        "symbol":"BTCUSDT_UMCBL",
        "marginCoin":"USDT",
        "dualSidePosition":true
    },
    "requestTime":1627293445916
}

返回值说明

返回字段 字段说明
symbol 币对名称
marginCoin 保证金币种
dualSidePosition boolean, true: 双向持仓; false: 单向持仓

 

 

 

 

 

 

 

 

获取单个合约仓位信息

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/position/singlePosition-v2?symbol=BTCUSDT_UMCBL&marginCoin=USDT" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": [
        {
            "marginCoin": "USDT",
            "symbol": "BTCUSDT_UMCBL",
            "holdSide": "long",
            "openDelegateCount": "0",
            "margin": "0",
            "autoMargin":"off",
            "available": "0",
            "locked": "0",
            "total": "0",
            "leverage": 10,
            "achievedProfits": null,
            "averageOpenPrice": null,
            "marginMode": "crossed",
            "holdMode": "double_hold",
            "unrealizedPL": null,
            "liquidationPrice": null,
            "keepMarginRate": null,
            "marketPrice": null,
            "cTime": null
        },
        {
            "marginCoin": "USDT",
            "symbol": "BTCUSDT_UMCBL",
            "holdSide": "short",
            "openDelegateCount": "0",
            "margin": "0",
            "autoMargin":"off",
            "available": "0",
            "locked": "0",
            "total": "0",
            "leverage": 10,
            "achievedProfits": null,
            "averageOpenPrice": null,
            "marginMode": "crossed",
            "holdMode": "double_hold",
            "unrealizedPL": null,
            "liquidationPrice": null,
            "keepMarginRate": null,
            "marketPrice": null,
            "cTime": null
        }
    ]
}

返回值说明

返回字段 字段说明
symbol 币对名称
marginCoin 保证金币种
holdSide 持仓方向
openDelegateCount 当前委托待成交的数量(交易币)
margin 保证金数量 (保证金币种)
autoMargin 自动追加保证金: off on
available 仓位可用(计价币)
locked 仓位冻结(计价币)
total 仓位总数量(available + locked)
leverage 杠杆倍数
achievedProfits 已实现盈亏
averageOpenPrice 平均开仓价
marginMode 保证金模式
holdMode 持仓模式
unrealizedPL 未实现盈亏
liquidationPrice 预估平仓价
keepMarginRate 维持保证金率
marketPrice 标记价格
cTime 最近更新时间 时间戳 毫秒

 

 

 

 

获取全部合约仓位信息

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
marginCoin String 否 保证金币种 必须大写

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/position/allPosition-v2?productType=umcbl&marginCoin=USDT" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": [
        {
            "marginCoin": "USDT",
            "symbol": "BTCUSDT_UMCBL",
            "holdSide": "long",
            "openDelegateCount": "0",
            "margin": "0",
            "autoMargin":"off",
            "available": "0",
            "locked": "0",
            "total": "0",
            "leverage": 10,
            "achievedProfits": "0",
            "averageOpenPrice": "0",
            "marginMode": "crossed",
            "holdMode": "double_hold",
            "unrealizedPL": "0",
            "liquidationPrice": "0",
            "keepMarginRate": "0.004",
            "marketPrice": "28071.34",
            "cTime": "1669362331867"
            "uTime": "1676426611041"
        },
        {
            "marginCoin": "USDT",
            "symbol": "BTCUSDT_UMCBL",
            "holdSide": "short",
            "openDelegateCount": "0",
            "margin": "0",
            "autoMargin":"off",
            "available": "0",
            "locked": "0",
            "total": "0",
            "leverage": 10,
            "achievedProfits": "0",
            "averageOpenPrice": "0",
            "marginMode": "crossed",
            "holdMode": "double_hold",
            "unrealizedPL": "0",
            "liquidationPrice": "0",
            "keepMarginRate": "0.004",
            "marketPrice": "28071.34",
            "cTime": "1669362331868",
            "uTime": "1673426611041"
        }
    ]
}

返回值说明

返回字段 字段说明
symbol 币对名称
marginCoin 保证金币种
holdSide 持仓方向
openDelegateCount 当前委托待成交的数量(交易币)
margin 保证金数量 (保证金币种)
autoMargin 自动追加保证金: off on
available 仓位可用(计价币)
locked 仓位冻结(计价币)
total 仓位总数量(available + locked)
leverage 杠杆倍数
achievedProfits 已实现盈亏
averageOpenPrice 平均开仓价
marginMode 保证金模式
holdMode 持仓模式
unrealizedPL 未实现盈亏
liquidationPrice 预估强平价
keepMarginRate 维持保证金率
marketPrice 标记价格
cTime 最近仓位创建时间 时间戳 毫秒
uTime 最近更新时间 时间戳 毫秒

获取财务记录

获取90天内的数据

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 否 产品类型，与symbol二选一
symbol String 否 产品ID 必须大写，废弃，不建议使用
business String 否 账户流水类型
marginCoin String 是 保证金币种 必须大写
startTime String 是 开始时间 （时间戳毫秒）
endTime String 是 结束时间 （时间戳毫秒）
pageSize int 否 显示条数 默认20 最大 100
lastEndId String 否 上次查询的id

请求示例

curl "https://api.coincatch.com/api/mix/v1/account/accountBill?productType=UMCBL&marginCoin=USDT&startTime=1659403328000&endTime=1659406928000&pageSize=20" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
  "code": "00000",
  "msg": "success",
  "data": {
    "result": [
      {
        "id": "892962903462432768",
        "symbol": "BTCUSDT_UMCBL",
        "marginCoin": "USDT",
        "amount": "0",
        "fee": "-0.1765104",
        "feeByCoupon": "",
        "feeCoin": "USDT",
        "business": "open_long",
        "ctime": "1648624867354"
      }
    ],
    "endId": "885353495773458432",
    "nextFlag": false
  }
}

返回值说明

返回字段 字段说明
id 财务记录号
symbol 产品Id, 可能为null
marginCoin 保证金币种
amount 金额
fee 手续费
feeByCoupon 手续费抵扣
feeCoin 手续费币种
business 记录类型
cTime 创建时间
lastEndId 上次查询的Id

获取业务线财务记录

获取90天内的数据

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
business String 否 账户流水操作类型
startTime String 是 开始时间 （时间戳毫秒）
endTime String 是 结束时间 （时间戳毫秒）
pageSize int 否 显示条数 默认20 最大 100
lastEndId String 否 上次查询的id
next boolean 否 是否查询下一页 默认false

请求示例

curl "https://api.coincatch.com/api/mix/v1/account/accountBusinessBill?productType=umcbl&startTime=1659403328000&endTime=1659406928000&pageSize=20" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
  "code": "00000",
  "msg": "success",
  "data": {
    "result": [
      {
        "id": "892962903462432768",
        "symbol": "ETHUSDT_UMCBL",
        "marginCoin": "USDT",
        "amount": "0",
        "fee": "-0.1765104",
        "feeByCoupon": "",
        "feeCoin": "USDT",
        "business": "open_long",
        "ctime": "1648624867354"
      }
    ],
    "endId": "885353495773458432",
    "nextFlag": false,
    "preFlag": false
  }
}

返回值说明

返回字段 字段说明
id 财务记录号
symbol 产品Id
marginCoin 保证金币种
amount 金额
fee 手续费
feeByCoupon 手续费抵扣
feeCoin 手续费币种
business 记录类型
cTime 创建时间
lastEndId 上次查询的Id

交易接口

下单

限速规则: 10次/1s (uid)

交易员限速规则: 1次/1s (uid)

如果你是交易员只能使用此接口进行开仓， 平仓操作需要调用 跟单接口 -> 交易员平仓接口

下单的价格和数量需要满足 pricePlace 和 priceEndStep volumePlace sizeMultiplier minTradeNum ， 此字段从 行情接口 -> 合约信息接口

举例说明：

BTCUSDT_UMCBL的 pricePlace 为 1 , priceEndStep 为 5, 则下单时委托的价格需要满足 0.5的倍数, 比如价格应该是 23455.0, 23455.5, 23446.0

volumePlace 是数量小数位， minTradeNum 是最小下单数量， sizeMultiplier 是数量乘数，下单数量要满足 大于minTradeNum 并且满足 sizeMultiplier 的倍数

会有两种情况出现此错误，

平仓常见异常：

可能的原因有两个

特别地，当平仓时指定的size大于持仓size时，下单会成功，持仓仓位会全平，即：只减仓，不会反向开仓。

示例：

未知错误

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
size String 是 下单数量，base coin
price String 否 下单价格(市价时不传)
side String 是 开单方向
orderType String 是 订单类型 limit/market
timeInForceValue String 否 订单有效期
clientOid String 否 客户端标识 唯一
reduceOnly Boolean 否 默认false; 只减仓，单向持仓平仓时仓位价值小于5USDT则需要设置为true, 双向持仓时不生效
presetTakeProfitPrice String 否 预设止盈价格
presetStopLossPrice String 否 预设止损价格

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/placeOrder" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","size": "0.01","price": "23145.5","side":"open_long","orderType":"limit","timeInForceValue":"normal","clientOid":"test@483939290000"}'

返回数据

{
    "code":"00000",
    "data":{
        "orderId":"1627293504612",
        "clientOid":"CoinCatch#1627293504612"
    },
    "msg":"success",
    "requestTime":1627293504612
}

返回值说明

返回字段 字段说明
orderId 订单Id
clientOid 客户端自定义Id

如果客户端没有传递 clientOid 字段，需要提醒用户注意订单可能会重复。因为这个字段是客户端和服务器之间唯一的幂等承诺字段。

clientOid重复时响应示例

{
    "code":"40786",
    "msg":"Duplicate clientOid",
    "requestTime":1627293504612
}

一键反手

限速规则: 10次/1s (uid) - 与下单共同计算频率


单/双向持仓模式下的反手逻辑是不同的：
双向持仓模式：
）通常需要指定size(size值介于0和position size之间), 指定的size会市价平仓，并在反向市价开仓
2）side值：close_short 或 close_long

单向持仓模式：
1）size参数会被忽略，此时只能市价全平，然后按同样数量的size反向市价开仓,注意开仓可能会因保证金不足而失败
2）side值：原仓位是 sell_single 则反手时设置为 buy_single；原仓位是buy_single则反手时设置为sell_single

反手操作：已有仓位会市价平仓，然后在反向开同样数量的仓位。

如果平仓的结算金额+可用余额不足以开到指定的反向仓位，或者在开仓时仓位价值不足5U，则市价平仓成功，开仓失败；

反手操作可能因 保证金，市场波动或其它原因失败。

你必须在已持仓的情况下进行反手操作，否则服务器会返回："可用仓位不足"

Not enough position

{
    "code": "40757",
    "msg": "可用仓位不足",
    "requestTime": 1665454799692,
    "data": null
}

反手的size参数通常应设置为原持仓的1倍。例如：原仓位数量为100， 反手下单时应将size设置为100，服务器会平仓100，然后反向市价开仓100

反手的size可以设置为超过原持仓数量的1.5倍甚至3倍或更多，但反手行为和1倍size时一致：服务器会先行市价平仓，然后根据客户的保证金状况进行反向市价建仓，开仓仓位数量和原持仓数量一致（即反手的size超过原持仓1倍的，按1倍处理）

特别地：反手的size也可以设置为原持仓数量的0倍至1倍之间，假设反手指定0.5倍原持仓size，反手行为则有所不同：服务器会先行市价平多0.5倍的仓位，然后根据客户的保证金状况进行反向市价建仓0.5倍

orderType 必须指定为 market, 限价单limit在反手中会被当做市价处理

原开仓订单参数

{
    "size": "100",
    "side": "open_long",
    "orderType": "market",
    "timeInForceValue": "normal",
    "symbol": "TRXUSDT_UMCBL",
    "marginCoin": "USDT"
}

反手示例

{
   "size": "100",
   "side": "close_long",
    "orderType": "market",
    "timeInForceValue": "normal",
    "symbol": "TRXUSDT_UMCBL",
    "marginCoin": "USDT",   
    "reverse":true
}

如原持仓方向为open_long, 则反手操作中应设置参数side为 close_long; 如原持仓方向为open_short, 则反手操作中应设置参数side为 close_short; 如原持仓方向为buy_single, 则反手操作中应设置参数side为 sell_single; 如原持仓方向为sell_single, 则反手操作中应设置参数side为 buy_single;

右边的示例演示了一个反手操作。理想状态下，你最终应该持仓 100 TRXUSDT short

HTTP请求

一键反手与下单共享同一个接口

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String Yes 产品ID 必须大写
marginCoin String Yes 保证金币种 必须大写
size String No 下单数量=平仓size=反手开仓size, 单向持仓模式下size参数会补充忽略
side String Yes 开单方向 双向持仓：close_long 或 close_short；单向持仓：sell_single 或 buy_single
orderType String Yes 订单类型: market
clientOid String No 客户端标识 唯一
timeInForceValue String No 订单有效期
reverse Boolean No 是否反手订单： 不传时默认为false(正常下单操作)； true:表示这是反手操作

反手请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/placeOrder" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","size": "0.01","side":"open_long","orderType":"market","timeInForceValue":"normal","clientOid":"reverse@483939290002","reverse":true}'

反手返回数据

{
    "code":"00000",
    "data":{
        "orderId":"1627293504612",
        "clientOid":"CoinCatch#1627293504612"
    },
    "msg":"success",
    "requestTime":1627293504612
}

返回值说明

返回字段 字段说明
orderId 订单Id
clientOid Client custom Id

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

批量下单

限速规则: 10次/1s (uid)

交易员限速规则: 1次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
orderDataList List 是 下单集合，最大长度：50

orderDataList

最多50个订单

参数名 参数类型 是否必须 描述
size String 是 下单数量
price String 否 下单价格
side String 是 开单方向
orderType String 是 订单类型
timeInForceValue String 否 订单有效期
clientOid String 否 客户端标识 唯一
presetTakeProfitPrice String 否 预设止盈价格
presetStopLossPrice String 否 预设止损价格

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/batch-orders" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT",  "orderDataList":[{"size": "0.01","price": "23145.5","side":"open_long","orderType":"limit","timeInForceValue":"normal","clientOid":"test@483939290000"}] }'

返回数据

{
  "code": "00000",
  "data": {
    "orderInfo": [
      {
        "orderId": "1627293504612",
        "clientOid": "CoinCatch#1627293504612"
      }
    ],
      "failure":[
          {
              "orderId": "1627293504611",
              "clientOid": "CoinCatch#1627293504611",
              "errorMsg":"Duplicate clientOid"
          }
      ]
  },
  "msg": "success",
  "requestTime": 1627293504612
}

返回值说明

返回字段 字段说明
orderInfo 成功下单响应array
> orderId 订单Id
> clientOid 客户端自定义Id
failure 失败下单array
> orderId 订单Id
> clientOid 客户端自定义Id
> errorMsg 错误信息

撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
orderId String 否 订单号, int64类型字符串, 'orderId' or 'clientOid' 必需提供一个
clientOid String 否 用户自定义ID, 'orderId' or 'clientOid' 必需提供一个

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/cancel-order" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","orderId":"1627293504612"}'

返回数据

{
    "code":"00000",
    "data":{
        "orderId":"1627293504612",
        "clientOid":"CoinCatch#1627293504612"
    },
    "msg":"success",
    "requestTime":1627293504612
}

返回值说明

返回字段 字段说明
orderId 订单Id
clientOid 客户端自定义Id

批量撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
orderIds List 是 订单号集合
orderIds List 否 订单ID list, 字符串类型的int64, 'orderIds' 或 'clientOids' 必需提供一个
clientOids List 否 Client Order Id list, 'orderIds' 或 'clientOids' 必需提供一个

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/cancel-batch-orders" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","orderIds":["1627293504612"]}'

返回数据

{
  "code": "00000",
  "data": {
    "symbol": "BTCUSDT_UMCBL",
    "order_ids": [
      "1627293504612"
    ],
    "client_order_ids":[
      "xxx001"
    ],
    "fail_infos": [
      {
        "order_id": "",
        "err_code": "",
        "err_msg": ""
      }
    ]
  },
  "msg": "success",
  "requestTime": 1627293504612
}

返回值说明

返回字段 字段说明
symbol 产品ID
order_ids 订单号数组
client_order_ids ClientOid 数组
fail_infos 失败信息集合
> order_id 失败单号
> err_code 错误代码
> err_msg 错误消息

按symbol撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/cancel-symbol-orders" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT"}'

返回数据

{
  "code": "00000",
  "data": {
    "symbol": "BTCUSDT_UMCBL",
    "order_ids": [
      "1627293504612"
    ],
    "client_order_ids":[
      "xxx001"
    ],
    "fail_infos": [
      {
        "order_id": "",
        "err_code": "",
        "err_msg": ""
      }
    ]
  },
  "msg": "success",
  "requestTime": 1627293504612
}

返回值说明

返回字段 字段说明
symbol 产品ID
order_ids 订单号数组
client_order_ids ClientOid 数组
fail_infos 失败信息集合
> order_id 失败单号
> err_code 错误代码
> err_msg 错误消息

一键全撤

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
marginCoin String 是 保证金币种 必须大写

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/order/cancel-all-orders" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"productType": "umcbl","marginCoin": "USDT"}'

返回数据

{
  "code": "00000",
  "data": {
    "order_ids": [
      "1627293504612"
    ],
    "fail_infos": [
      {
        "order_id": "",
        "err_code": "",
        "err_msg": ""
      }
    ]
  },
  "msg": "success",
  "requestTime": 1627293504612
}

返回值说明

返回字段 字段说明
orderId 订单Id
clientOid 客户端自定义Id

获取当前委托

限速规则: 20次/1s (uid)

HTTP请求

获取一个symbol的当前委托

注意，历史委托请使用 获取历史委托 接口

止盈止损委托请使用 获取当前计划委托(止盈止损)列表 接口

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/current?symbol=BTCUSDT_UMCBL" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":{
        "nextFlag":false,
        "endId":"802355881591844864",
        "orderList":[
            {
                "symbol":"BTCUSDT_UMCBL",
                "size":1,
                "orderId":"802382049422487552",
                "clientOid":"RFIut#1627028708738",
                "filledQty":0,
                "fee":0,
                "price":23999.3,
            "priceAvg": 23999.00,
                "state":"filled",
                "side":"open_long",
                "timeInForce":"normal",
                "totalProfits":0,
                "posSide":"long",
                "marginCoin":"USDT",
            "filledAmount": 48.4520,
            "leverage": "6",
            "marginMode": "fixed",
            "reduceOnly": false,
            "enterPointSource": "WEB",
            "tradeSide": "buy_single",
            "holdMode": "single_hold",
                "orderType":"limit",
            "cTime": "1678779464831",
            "uTime": "1678779464891"
            }
        ]
    },
    "msg":"success",
    "requestTime":1627299486707
}

返回值说明

返回字段 字段说明
symbol 交易对名称
size 委托数量
orderId 订单号
clientOid 客户端自定义id
filledQty 成交数量，左币
fee 手续费
price 委托价格
priceAvg 平均成交价格
state 订单状态
side 开单方向
timeInForce 订单有效期
totalProfits 总盈亏
posSide 持仓方向
marginCoin 保证金币种
filledAmount 成交金额, 右币
leverage 杠杆倍数
marginMode Margin mode
reduceOnly 是否只减仓
enterPointSource enterPointSource
tradeSide Trade Side
holdMode Hold mode
orderType 订单类型
cTime 创建时间
uTime 最近更新时间

获取全部当前委托

限速规则: 20次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
marginCoin String 是 保证金币种

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/marginCoinCurrent?productType=umcbl&marginCoin=USDT" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
  "code":"00000",
  "data": [
    {
      "symbol": "BTCUSDT_UMCBL",
      "size": 0.050,
      "orderId": "1044911928892862465",
      "clientOid": "xx005",
      "filledQty": 0.000,
      "fee": 0E-8,
      "price": 25500.00,
      "state": "new",
      "side": "open_long",
      "timeInForce": "normal",
      "totalProfits": 0E-8,
      "posSide": "long",
      "marginCoin": "USDT",
      "presetTakeProfitPrice": 33800.00,
      "presetStopLossPrice": 11300.00,
      "filledAmount": 0.0000,
      "orderType": "limit",
      "leverage": "4",
      "marginMode": "crossed",
      "reduceOnly": false,
      "enterPointSource": "API",
      "tradeSide": "open_long",
      "holdMode": "double_hold",
      "orderSource": "normal",
      "cTime": "1684852338057",
      "uTime": "1684852338057"
    }
  ],
  "msg":"success",
  "requestTime":1627299486707
}

返回值说明

返回字段 字段说明
symbol 交易对名称
size 委托数量
orderId 订单号
clientOid 客户端自定义id
filledQty 成交数量
fee 手续费
price 委托价格
state 订单状态
side 开单方向
timeInForce 订单有效期
totalProfits 总盈亏
posSide 持仓方向 long,short,net
marginCoin 保证金币种
orderType Order type
presetTakeProfitPrice 止盈价
presetStopLossPrice 止损价
filledAmount 成交量
leverage 倍数
marginMode marginMode
reduceOnly 是否只减仓
enterPointSource enterPointSource
tradeSide tradeSide
holdMode holdMode
orderSource orderSource
cTime 创建时间
uTime 更新时间

获取历史委托

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
startTime String 是 开始时间(时间戳)
endTime String 是 结束时间(时间戳)
pageSize String 是 查询条数
lastEndId String 否 上一次的查询orderId
clientOid String 否 精确匹配
isPre Boolean 否 是否查询上一页(默认false)

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/history?symbol=BTCUSDT_UMCBL&startTime=1659403328000&endTime=1659410528000&pageSize=20" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
  "code":"00000",
  "data":{
    "nextFlag":false,
    "endId":"802355881591844864",
    "orderList":[
      {
        "symbol":"BTCUSDT_UMCBL",
        "size":1,
        "orderId":"802382049422487552",
        "clientOid":"RFIut#1627028708738",
        "filledQty":0,
        "fee":0,
        "price":23999.3,
        "priceAvg": 23999.3,
        "state":"filled",
        "side":"open_long",
        "timeInForce":"normal",
        "totalProfits":0,
        "posSide":"long",
        "marginCoin":"USDT",
        "filledAmount": 31.4421,
        "leverage":"20",
        "marginMode":"crossed",
        "orderType":"limit",
        "reduceOnly": false,
        "enterPointSource": "WEB",
        "tradeSide": "open_long",
        "holdMode": "double_hold",
        "orderSource": "normal",
        "cTime": "1665452796883",
        "uTime": "1665452797002"
      }
    ]
  },
  "msg":"success",
  "requestTime":1627299486707
}

返回值说明

返回字段 字段说明
symbol 交易对名称
size 委托数量
orderId 订单号
clientOid 客户端自定义id
filledQty 成交数量，左币
fee 手续费
price 委托价格
priceAvg 成交均价
state 订单状态
side 开单方向
timeInForce 订单有效期
totalProfits 总盈亏
posSide 持仓方向 long,short,net
marginCoin 保证金币种
filledAmount 成交金额，右币
leverage 杠杆倍数
marginMode 账户模式
orderType 订单类型
reduceOnly 只减仓
enterPointSource enterPointSource
tradeSide 交易方向
holdMode 持仓模式 single_hold 单向持仓,double_hold双向持仓
orderSource orderSource
cTime 创建时间
uTime 更新时间

获取全部历史委托

限速规则: 5次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
startTime String 是 开始时间(时间戳)
endTime String 是 结束时间(时间戳)
pageSize String 是 查询条数, 最大100
lastEndId String 否 上一次的查询orderId
clientOid String 否 精确匹配
isPre Boolean 否 是否查询上一页(默认false)

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/historyProductType?productType=umcbl&startTime=1659403328000&endTime=1659410528000&pageSize=20" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":{
        "nextFlag":false,
        "endId":"802355881591844864",
        "orderList":[
            {
                "symbol":"BTCUSDT_UMCBL",
                "size":1,
                "orderId":"802382049422487552",
                "clientOid":"RFIut#1627028708738",
                "filledQty":0,
                "fee":0,
                "price":23999.3,
                "state":"canceled",
                "side":"open_long",
                "timeInForce":"normal",
                "totalProfits":0,
                "posSide":"long",
                "marginCoin":"USDT",
                "leverage":"20",
                "marginMode":"crossed",
                "orderType":"limit",
                "reduceOnly": false,
                "enterPointSource": "WEB",
                "tradeSide": "open_long",
                "holdMode": "double_hold",
                "cTime": "1665452796883",
                "uTime": "1665452797002"
            }
        ]
    },
    "msg":"success",
    "requestTime":1627299486707
}

返回值说明

返回字段 字段说明
symbol 交易对名称
size 委托数量
orderId 订单号
clientOid 客户端自定义id
filledQty 成交数量
fee 手续费
price 委托价格
priceAvg 成交均价
state 订单状态
side 开单方向
timeInForce 订单有效期
totalProfits 总盈亏
posSide 持仓方向 long,short,net
marginCoin 保证金币种
leverage 订单杠杆
marginMode 账户模式
orderType 订单类型
reduceOnly 只减仓
enterPointSource enterPointSource
tradeSide 交易方向
holdMode 持仓模式 single_hold 单向持仓,double_hold双向持仓
orderSource orderSource
cTime 创建时间
uTime 更新时间

获取订单详情

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
orderId String 否 订单号, int64类型字符串, 'orderId' or 'clientOid' 必需提供一个
clientOid String 否 用户自定义ID, 'orderId' or 'clientOid' 必需提供一个

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/detail?symbol=BTCUSDT_UMCBL&orderId=802382049422487552" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
  "code":"00000",
  "data":{
    "symbol":"BTCUSDT_UMCBL",
    "size":1,
    "orderId":"802382049422487552",
    "clientOid":"RFIut#1627028708738",
    "filledQty":0,
    "priceAvg":0,
    "fee":0,
    "price":23999.3,
    "state":"canceled",
    "side":"open_long",
    "timeInForce":"normal",
    "totalProfits":0,
    "posSide":"long",
    "marginCoin":"USDT",
    "presetTakeProfitPrice":69582.5,
    "presetStopLossPrice":21432.5,
    "filledAmount":45838,
    "orderType":"limit",
    "leverage": "6",
    "marginMode": "fixed",
    "reduceOnly": false,
    "enterPointSource": "WEB",
    "tradeSide": "buy_single",
    "holdMode": "single_hold",
    "orderSource": "market",
    "cTime":1627028708807,
    "uTime":1627028717807
  },
  "msg":"success",
  "requestTime":1627300098776
}

返回值说明

返回字段 字段说明
symbol 交易对名称
size 委托数量
orderId 订单号
clientOid 客户端自定义id
filledQty 成交数量
priceAvg 成交均价
fee 手续费
price 委托价格
state 订单状态
side 开单方向
timeInForce 订单有效期
totalProfits 总盈亏
posSide 持仓方向 long,short,net
marginCoin 保证金币种
presetTakeProfitPrice 预设止盈价格
presetStopLossPrice 预设止损价格
filledAmount 成交额度
orderType 交易类型 limit 限价 market 市价
leverage 杠杆倍数
marginMode Margin Mode(仓位模式)
reduceOnly 是否只减仓
enterPointSource enterPointSource
tradeSide 交易方向(交易方向)
holdMode Hold mode(持仓模式)
orderSource orderSource
cTime 创建时间, ms
uTime 更新时间, ms

查询成交明细

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
orderId String 否 订单号
startTime String 否 开始时间(时间戳毫秒) 如果orderId为空此字段必传
endTime String 否 结束时间(时间戳毫秒) 如果orderId为空此字段必传
lastEndId String 否 分页参数；上一次查询结果的tradeId，orderId为空时生效

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/fills?symbol=BTCUSDT_UMCBL&orderId=802382049422487552" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":[
        {
            "tradeId":"802377534023585793",
            "symbol":"BTCUSDT_UMCBL",
            "orderId":"802377533381816325",
            "price":"0",
            "sizeQty":"0.3247",
            "fee":"0E-8",
            "side":"burst_close_long",
            "fillAmount":"0.3247",
            "profit":"0E-8",
            "enterPointSource": "WEB",
            "tradeSide": "buy_single",
            "holdMode": "single_hold",
            "takerMakerFlag": "taker",
            "cTime":"1627027632241"
        }
    ],
    "msg":"success",
    "requestTime":1627386245672
}

返回值说明

返回字段 字段说明
tradeId 成交id
symbol 交易对名称
orderId 订单号
price 成交价格
sizeQty 成交数量
fee 手续费
side 成交类型
fillAmount 成交量
profit 利润
enterPointSource enterPointSource
tradeSide 交易方向
holdMode 持仓模式 single_hold 单向持仓,double_hold双向持仓
takerMakerFlag taker
cTime 成交时间

查询业务线成交明细

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 是 产品类型 umcbl 合约业务 dmcbl 币本位
startTime String 是 开始时间(时间戳毫秒) 如果查询全部明细此字段必传
endTime String 是 结束时间(时间戳毫秒) 如果查询全部明细此字段必传
lastEndId String 否 查询上一次的tradeId

默认查询100条

请求示例

curl "https://api.coincatch.com/api/mix/v1/order/allFills?productType=umcbl&startTime=1659406928000&endTime=1659410528000" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code":"00000",
    "data":[
        {
            "tradeId":"802377534023585793",
            "symbol":"BTCUSDT_UMCBL",
            "orderId":"802377533381816325",
            "price":"0",
            "sizeQty":"0.3247",
            "fee":"0E-8",
            "side":"burst_close_long",
            "fillAmount":"0.3247",
            "profit":"0E-8",
            "enterPointSource": "WEB",
            "tradeSide": "buy_single",
            "holdMode": "single_hold",
            "takerMakerFlag": "taker",
            "cTime":"1627027632241"
        }
    ],
    "msg":"success",
    "requestTime":1627386245672
}

返回值说明

返回字段 字段说明
tradeId 成交id
symbol 交易对名称
orderId 订单号
price 成交价格
sizeQty 成交数量
fee 手续费
side 成交类型
fillAmount 成交量
profit 利润
enterPointSource enterPointSource
tradeSide 交易方向
holdMode 持仓模式 single_hold 单向持仓,double_hold双向持仓
takerMakerFlag taker
cTime 成交时间

计划委托下单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种 必须大写
size String 是 下单数量
executePrice String 否 执行价格, orderType=limit时, 必填
triggerPrice String 是 触发价格
side String 是 开单方向
orderType String 是 订单类型
triggerType String 是 触发类型
clientOid String 否 客户端标识 唯一
presetTakeProfitPrice String 否 预设止盈价格
presetStopLossPrice String 否 预设止损价格
reduceOnly String 否 默认false; 只减仓，单向持仓平仓时仓位价值小于5USDT则需要设置为true, 双向持仓时不生效

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/placePlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","size": "0.01","executePrice": "23145.5","triggerPrice":"23555.5","side":"open_long","orderType":"limit","triggerType":"market_price","clientOid":"test@483939290000"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

修改计划委托

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
orderId String 否 计划委托订单号, 'orderId' 与 'clientOid' 必需提供一个
clientOid String 否 'orderId' 与 'clientOid' 必需提供一个
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
executePrice String 否 执行价格, orderType=limit时, 必填
triggerPrice String 是 触发价格
triggerType String 是 触发类型
orderType String 是 交易类型

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/modifyPlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"orderId":"803521986049314816","symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","executePrice": "23145.5","triggerPrice":"23555.5","orderType":"limit","triggerType":"market_price"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

修改计划委托预设止盈止损

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
orderId String 否 计划委托订单号, 'orderId' 与 'clientOid' 必需提供一个
clientOid String 否 'orderId' 与 'clientOid' 必需提供一个
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
presetTakeProfitPrice String 否 止盈价格 如果为空则取消止盈
presetStopLossPrice String 否 止损价格 如果为空则取消止损

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/modifyPlanPreset" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"orderId":"803521986049314816","symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","presetTakeProfitPrice": "23145.5","presetStopLossPrice":"23555.5"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

止盈止损下单

限速规则: 10次/1s (uid)

目前止盈止损/移动止盈止损下单, 只支持市价, 且触发类型为成交价触发

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
planType String 是 止盈止损类型 planType，请使用"profit_plan"、"loss_plan" and "moving_plan"
triggerPrice String 是 触发价格
triggerType String 否 触发类型, fill_price(成交价)/market_price(标记价) 默认成交价
holdSide String 是 本仓位是多仓还是空仓
size String 否 下单数量 默认仓位数量
rangeRate String 否 回调幅度(planType="moving_plan"时使用)，“1” 表示 1.0%的价格回调, 最多两位小数
clientOid String 否 Client order ID, 幂等控制

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/placeTPSL" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","size": "0.01","planType": "profit_plan","triggerPrice":"23555.5","holdSide":"long"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

追踪委托下单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
triggerPrice String 是 触发价格
triggerType String 否 触发类型 fill_price(成交价)/market_price(标记价) 默认成交价
side String 是 开单方向
size String 是 下单数量 不能超过可用仓位数量
rangeRate String 是 回调幅度，planType="moving_plan"时使用；"1" 表示 1.0%的价格回调, 最大10
clientOid String 否 Client order ID, 幂等控制

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/placeTrailStop" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","size": "0.01","triggerPrice":"23555.5","side":"open_long","rangeRate":"10"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

仓位止盈止损

限速规则: 10次/1s (uid)

仓位止盈止损触发时默认会以市价委托仓位全部数量

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
planType String 是 仓位止盈止损plan type: 请使用"pos_profit", "pos_loss"
triggerPrice String 是 触发价格
triggerType String 是 触发类型
holdSide String 是 本仓位是多仓还是空仓
clientOid String 否 Client order ID, 幂等控制

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/placePositionsTPSL" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","planType": "pos_profit","triggerPrice":"23555.5","holdSide":"long"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

修改止盈止损

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
orderId String 否 止盈止损订单号, 'orderId' 与 'clientOid' 必需提供一个
clientOid String 否 'orderId' 与 'clientOid' 必需提供一个
marginCoin String 是 保证金币种 必须大写
symbol String 是 产品ID 必须大写
triggerPrice String 是 触发价格
planType String 是 参考plan type：取值："pos_profit"、"profit_plan"、"pos_loss"、"loss_plan"

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/modifyTPSLPlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"orderId":"803521986049314816","symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","triggerPrice":"23555.5","planType":"profit_plan"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

计划委托(止盈止损)撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
orderId String 否 计划委托订单ID, 'orderId' 或 'clientOid' 必需提供一个
clientOid String 否 clientOid, 'orderId' 或 'clientOid' 必需提供一个
symbol String 是 产品ID 必须大写
marginCoin String 是 保证金币种
planType String 是 plan type

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/cancelPlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"orderId":"803521986049314816","symbol": "BTCUSDT_UMCBL","marginCoin": "USDT","planType":"loss_plan"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

计划委托(止盈止损)按symbol撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
planType String 是 plan type

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/cancelSymbolPlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"symbol": "BTCUSDT_UMCBL","planType":"loss_plan"}'

返回数据

{
    "code":"00000",
    "data":true,
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
data 撤单指定是否成功接收

最终的撤单结果需要通过websocket/当前计划委托查询以确定

策略一键撤单

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Body)

参数名 参数类型 是否必须 描述
productType String 是 产品类型
planType String 是 撤单类型, default 'plan'

请求示例

curl -X POST "https://api.coincatch.com/api/mix/v1/plan/cancelAllPlan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json" \
  -d \'{"productType":"umcbl","planType":"loss_plan"}'

返回数据

{
    "code":"00000",
    "data":{
        "clientOid":"RFIut#1627300490884",
        "orderId":"803521986049314816"
    },
    "msg":"success",
    "requestTime":1627300490899
}

返回值说明

返回字段 字段说明
clientOid 客户端自定义id
orderId 订单号

获取当前计划委托(止盈止损)列表

限速规则: 20次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
symbol String 是 产品ID 必须大写
isPlan String 否 查询类型
productType String 否 产品类型 如果查询使用此参数 不需要symbol

请求示例

curl "https://api.coincatch.com/api/mix/v1/plan/currentPlan?symbol=BTCUSDT_UMCBL&isPlan=plan" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 0,
    "data": [
        {
            "orderId": "1083147482484514819",
            "clientOid": "1083147482484514818",
            "symbol": "SBTCSUSDT_SUMCBL",
            "marginCoin": "SUSDT",
            "size": "0.01",
            "executePrice": "0",
            "triggerPrice": "26746.5",
            "status": "not_trigger",
            "orderType": "market",
            "planType": "normal_plan",
            "side": "buy_single",
            "triggerType": "market_price",
            "presetTakeProfitPrice": "0",
            "presetTakeLossPrice": "0",
            "rangeRate": "",
            "enterPointSource": "API",
            "tradeSide": "buy_single",
            "holdMode": "single_hold",
            "reduceOnly": false,
            "cTime": "1693968404408",
            "uTime": null
        }
    ]
}

返回值说明

返回字段 字段说明
orderId 订单号
clientOid Client Order Id
symbol 币对名称
marginCoin 保证金币种
size 委托数量
executePrice 委托价格
triggerPrice 触发价格
status 订单状态
orderType 交易类型
planType 订单类型
side 开单方向
triggerType 触发类型
presetTakeProfitPrice 预设止盈价格
presetTakeLossPrice 预设止损价格
rangeRate 回调幅度(planType="moving_plan"时有值)，“1” 表示 1.0%的价格回调, 最多两位小数
enterPointSource enterPointSource
tradeSide Trade Side
holdMode Hold Mode
reduceOnly 只减仓
cTime 创建时间
uTime 更新时间

获取历史计划委托(止盈止损)列表

限速规则: 10次/1s (uid)

HTTP请求

请求参数(Request Param)

参数名 参数类型 是否必须 描述
productType String 否 产品类型
symbol String 否 产品ID 必须大写
startTime String 是 开始时间 （托管子账户访问时，StartTime 时间不能早于 绑定开始的时间）
endTime String 是 结束时间
pageSize Integer 否 查询条数 默认100
isPre boolean 否 是否查询上一页 默认false
isPlan String 否 查询类型

请求示例

curl "https://api.coincatch.com/api/mix/v1/plan/historyPlan?symbol=BTCUSDT_UMCBL&startTime=1659406928000&endTime=1659414128000&pageSize=20" \
  -H "ACCESS-KEY:you apiKey" \
  -H "ACCESS-SIGN:*******" \
  -H "ACCESS-PASSPHRASE:*****" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

返回数据

{
    "code": "00000",
    "msg": "success",
    "requestTime": 1693968259096,
    "data": [
        {
            "orderId": "1048210602999750657",
            "clientOid": "1048210602999750656",
            "executeOrderId": "1048508364888899593",
            "symbol": "SBTCSUSDT_SUMCBL",
            "marginCoin": "SUSDT",
            "size": "0.001",
            "executePrice": "27500",
            "triggerPrice": "27200",
            "status": "triggered",
            "orderType": "limit",
            "planType": "normal_plan",
            "side": "sell_single",
            "triggerType": "market_price",
            "presetTakeProfitPrice": "0",
            "presetTakeLossPrice": "0",
            "rangeRate": null,
            "enterPointSource": "API",
            "tradeSide": "sell_single",
            "holdMode": "single_hold",
            "reduceOnly": false,
            "executeTime": "1685709795259",
            "executeSize": "0.001",
            "cTime": "1685638803243",
            "uTime": "1685709795259"
        }
    ]
}

返回值说明

返回字段 字段说明
orderId 订单号
clientOid Client Order Id
executeOrderId 触发委托单id
symbol 币对名称
marginCoin 保证金币种
size 委托数量
executePrice 委托价格
triggerPrice 触发价格
status 订单状态
orderType 交易类型
planType 订单类型
side 开单方向
triggerType 触发类型
presetTakeProfitPrice 预设止盈价格
presetTakeLossPrice 预设止损价格
rangeRate 回调幅度(planType="moving_plan"时有值)，“1” 表示 1.0%的价格回调, 最多两位小数
enterPointSource enterPointSource
tradeSide Trade Side
holdMode Hold Mode
reduceOnly 只减仓
executeTime 执行时间
executeSize 执行数量
cTime 创建时间
uTime 更新时间

WebSocketAPI

概述

WebSocket是HTML5一种新的协议(Protocol)。它实现了客户端与服务器全双工通信， 使得数据可以快速地双向传播。通过一次简单的握手就 可以建立客户端和服务器连接， 服务器根据业务规则可以主动推送信息给客户端。其优点如下：

强烈建议开发者使用WebSocket API获取市场行情和买卖深度等信息。 ​

域名 WebSocket API 建议使用
public domain wss://ws.coincatch.com/public/v1/stream 公共channel
private domain wss://ws.coincatch.com/private/v1/stream 私有channel

连接说明：

连接上ws后30s内订阅或订阅后30s内用户未发送ping指令，系统会自动断开连接

连接

连接说明：

连接限制：100个/IP

订阅限制：240次/小时

如果出现网络问题，系统会自动断开连接

如果连接成功后30s未订阅或订阅后30s内服务器未向用户推送数据，系统会自动断开连接

为了保持连接有效且稳定，建议您进行以下操作：

  1. 每次接收到消息后，用户设置一个定时器，定时30秒。
  2. 如果定时器被触发（30秒内没有收到新消息），发送字符串 'ping'。
  3. 期待一个文字字符串'pong'作为回应。如果在 N秒内未收到，请发出错误或重新连接。
  4. Websocket服务器每秒最多接受10个消息。消息包括:
    • PING帧
    • JSON格式的消息，比如订阅，断开订阅。
  5. 如果用户发送的消息超过限制，连接会被断开连接。反复被断开连接的IP有可能被服务器屏蔽；
  6. 单个连接最多可以订阅 1000 个Streams；
  7. 单个IP最多可以创建100个连接。

登录

api_key:用于调用API的用户身份唯一标示，需要用户申请

passphrase:API Key 的密码,如果没有口令的话传入空字符串("")即可

timestamp: 时间戳 是Unix Epoch时间，单位是秒， 时间戳30秒后会过期

sign:为签名字符串，签名规则参照如下:

Message即(待签名字符串)为： timestamp+method+requestPath

其中timestamp示例:const timestamp = '' + Date.now() / 1000

method一律默认为'GET'

requestPath 一律默认为'/user/verify'

 请求在时间戳之后30秒会失效，如果您的服务器时间和API服务器时间有偏差，推荐使用 REST API查询API服务器的时间，然后设置时间戳

签名方式说明参考API概述里的验证部分

生成最终签名的步骤

第1步，将待签名字符串使用私钥secretkey进行hmac sha256加密

Signature = hmac_sha256(secretkey, Message)

第2步，对于Signature进行base64编码

Signature = base64.encode(Signature)

如果登录失败会自动断开链接

请求格式说明：

{
    "op":"login",
    "args":[
        {
            "apiKey":"<api_key>",
            "passphrase":"<passphrase>",
            "timestamp":"<timestamp>",
            "sign":"<sign>"
        }
    ]
}

请求示例：

{
    "op":"login",
    "args":[
        {
            "apiKey":"cc_573af5eca856acd91c230da294ce2105",
            "passphrase":"123456",
            "timestamp":"1538054050",
            "sign":"8RCOqCJAhhEh4PWcZB/96QojLDqMAg4qNynIixFzS3E="
        }
    ]
}

成功返回示例：

{
    "event":"login",
    "code":"0",
    "msg":""
}

失败返回示例：

{
    "event":"error",
    "code":"30005",
    "msg":"login fail"
}

订阅

订阅说明

请求格式说明

{
    "op":"subscribe",
    "args":[
        "<SubscriptionTopic> "
    ]
}

WebSocket 频道： 公共频道 

公共频道无需登录，包括行情频道，K线频道，交易数据频道，深度数据频道等。

用户可以选择订阅一个或者多个频道，多个频道总长度不能超过4096个字节。

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"mc",
            "channel":"ticker",
            "instId":"BTCUSDT"
        },
        {
            "instType":"mc",
            "channel":"candle1m",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe
args Array 是 请求订阅的频道列表
> instType String 否 产品类型 MC：公共频道
> channel String 是 频道名
> instId String 否 产品ID或产品名称

返回示例

{
    "event":"subscribe",
    "arg":{
        "instType":"mc",
        "channel":"ticker",
        "instId":"BTCUSDT"
    }
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe error
arg Object 否 订阅的频道
> instType String 否 产品类型
> channel String 是 频道名
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

取消订阅

可以取消一个或者多个频道

请求格式说明

{
    "op":"unsubscribe",
    "args":[
        "< SubscriptionTopic > "
    ]
}

请求示例

{
    "op":"unsubscribe",
    "args":[
        {
            "instType":"MC",
            "channel":"ticker",
            "instId":"BTCUSDT"
        },
        {
            "instType":"MC",
            "channel":"candle1D",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，unsubscribe
args Array 是 取消订阅的频道列表
instType String 是 产品类型 MC：公共频道
> channel String 是 频道名
> instId String 是 产品ID

返回示例

{
    "event":"unsubscribe",
    "arg":{
        "instType":"MC",
        "channel":"ticker",
        "instId":"BTCUSDT"
    }
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，unsubscribe error
arg Object 否 取消订阅的频道
> instType String 否 产品类型
> channel String 是 频道名
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

Checksum机制

此机制可以帮助用户校验深度数据的准确性。

深度合并

用户订阅增量推送（如：books）深度频道成功后，首先获取初始全量深度数据，当获取到增量推送数据后，更新本地全量深度数据。

  1. 如果有相同价格，则比较数量；数量为0删除此深度，数量有变化则替换此数据。
  2. 如果没有相同价格，则按照价格优劣排序（bids为价格降序，asks为价格升序），将深度信息插入到全量数据中

计算校验和

先用深度合并后前25档bids和asks组成一个字符串（其中ask和bid中的价格和数量以冒号连接），再计算其crc32值（32位有符号整型）。

1.bid和ask超过25档
合并后全量深度数据（在此仅展示2档数据，实际应截取25档数据）：
"bids": [
    [ 3366.1, 7 ],  //bid1
    [ 3366 , 6]
]
"asks": [
    [ 3366.8, 9],   //ask1
    [ 3368 , 8]
]
校验字符串：
"3366.1:7:3366.8:9:3366:6:3368:8"

2.bid或ask不足25档  
合并后全量深度数据：
"bids": [
    [ 3366.1, 7]
]
"asks": [
    [ 3366.8, 9],
    [ 3368  , 8 ],
    [ 3372  , 8 ]
]
校验字符串：
"3366.1:7:3366.8:9:3368:8:3372:8"
  1. 当bid和ask深度数据超过25档时，截取各自25档数据，要校验的字符串按照bid、ask深度数据交替方式连接。如：bid1[价格:数量]:ask1[价格:数量]:bid2[价格:数量]:ask2[价格:数量]...
  2. bid或ask深度数据不足25档时，直接忽略缺失的深度。如：bid1[价格:数量]:ask2[价格:数量]:ask3[价格:数量]:ask4[价格:数量]...
  3. 如果返回的价格为0.5000, 请注意使用原始值计算checksum，不要使用trim掉0后的0.5

公共频道

行情频道

获取产品的最新成交价、买一价、卖一价和24小时交易量等信息，150ms数据更新推送一次数据

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"MC",
            "channel":"ticker",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
1 op String 是 操作，subscribe unsubscribe
2 args Array 是 请求订阅的频道列表
3 > instType String 是 产品类型 MC：公共频道
4 > channel String 是 频道名，ticker
5 > instId String 是 产品名称

成功返回示例

{
    "event":"subscribe",
    "arg":{
        "instType":"MC",
        "channel":"ticker",
        "instId":"BTCUSDT"
    }
}

失败返回示例

{
    "event":"error",
    "code":30003,
    "msg":"instType:MC,channel:ticker,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> instType String 是 产品类型
> channel String 是 频道名
> instId String 是 产品ID
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "action":"snapshot",
    "arg":{
        "instType":"mc",
        "channel":"ticker",
        "instId":"BTCUSDT"
    },
    "data":[
        {
            "instId":"BTCUSDT",
            "last":"44962.00",
            "bestAsk":"44962",
            "bestBid":"44961",
            "high24h":"45136.50",
            "low24h":"43620.00",
            "priceChangePercent":"0.02",
            "capitalRate":"-0.00010",
            "nextSettleTime":1632495600000,
            "systemTime":1632470889087,
            "markPrice":"44936.21",
            "indexPrice":"44959.23",
            "holding":"1825.822",
            "baseVolume":"39746.470",
            "quoteVolume":"1760329683.834",
            "openUtc": "17088.5000000000000000",
            "chgUTC": "-0.00778",
            "symbolType": 1,
            "symbolId": "BTCUSDT_UMCBL",
            "deliveryPrice": "0",
            "bidSz": "10.344",
            "askSz": "3.024"
        }
    ]
}

返回参数

参数名 类型 描述
arg Object 订阅成功的频道
> instType String 产品类型
> channel String 频道名
> instId String 产品名称
action String 推送数据动作，增量推送数据还是全量推送数据snapshot：全量update：增量
data Array 订阅的数据
> instId String 产品名称
>last String 最新价
>bestAsk String 卖一价
>bestBid String 买一价
>high24h String 24小时最高价
>low24h String 24小时最低价
>priceCahngePercent String 24小时涨跌幅
>capitalRate String 资金费率
>nextSettleTime String 下次资金费率结算时间 时间戳毫秒
>systemTime String 系统时间
>marketPrice String 标记价格
>indexPrice String 指数价格
>holding String 持仓量
>baseVolume String 左币交易量
>quoteVolume String 右币交易量
>openUtc String UTC 00:00时刻价格
>chgUTC String 自UTC 00:00涨跌幅
>symbolType String SymbolType：perpetual->永续 delivery->交割
>symbolId String Symbol Id
>deliveryPrice String 交割合约交割价，SymbolType=perpetual时为0
>bidSz String Best bid size
>askSz String Best ask size

K线频道

获取产品的K线数据。

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"MC",
            "channel":"candle1D",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> instType String 是 产品类型 MC：公共频道
> channel String 是 频道名，candle1Wcandle1Dcandle12H candle4H  candle1Hcandle30m candle15m candle5m candle1m
> instId String 是 产品名称

成功返回示例

{
    "event":"subscribe",
    "arg":{
        "instType":"MC",
        "channel":"candle1D",
        "instId":"BTCUSDT"
    }
}

失败返回示例

{
    "event":"error",
    "code":30003,
    "msg":"instType:MC,channel:candle1D,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
> instId String 是 产品名称
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "arg":{
        "instType":"mc",
        "channel":"candle1D",
        "instId":"BTCUSDT"
    },
    "data":[
        [
            "1597026383085",
            "8533.02",
            "8553.74",
            "8527.17",
            "8548.26",
            "45247"
        ]
    ]
}

返回参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instId String 产品ID
> instType String 产品类型
data Array 订阅的数据
> ts String 开始时间，Unix时间戳的毫秒数格式，如 1597026383085
> o String 开盘价格
> h String 最高价格
> l String 最低价格
> c String 收盘价格
> v String 数值为左币交易量

深度频道

获取深度数据，books是全量深度频道，books5是5档频道；

books 首次推全量快照数据，以后增量推送，以后增量推送，即有深度有变化推送一次变化的数据

books1首次推1档快照数据，以后全量推送，有深度变化推送一次1档数据，即每次都推送1档数据

books5首次推5档快照数据，以后全量推送，有深度变化推送一次5档数据，即每次都推送5档数据

books15 首次推15档快照数据，以后全量推送，有深度变化推送一次15档数据，即每次都推送15档数据

数据根据币对的不同在 100 ~ 200 ms内推送一次

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"mc",
            "channel":"books5",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> instType String 是 产品类型 MC：公共频道
> channel String 是 频道名，books books1 books5 books15
> instId String 是 产品ID

成功返回示例

{
    "event":"subscribe",
    "arg":{
        "instType":"sp",
        "channel":"books5",
        "instId":"BTCUSDT"
    }
}

失败返回示例

{
    "event":"error",
    "code":30003,
    "msg":"instType:MC,channel:books5,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> instType String 是 产品类型
> channel String 是 频道名
> instId String 是 产品名称
msg String 否 错误消息
code String 否 错误码

推送示例:全量

{
    "action": "snapshot",
    "arg": {
        "instType": "MC",
        "channel": "books",
        "instId": "BTCUSDT"    
    },
        "data": [  {            
        "asks": [
            [44849.3, 0.0031]
        ],
        "bids": [
            [44845.2, 0.725]
        ],
        "checksum":" -1638549107",
         "ts": "1628826748009" 
    }   ]
}

返回参数

参数名 类型 描述
arg Object 订阅成功的频道
> instType String 产品类型
> channel String 频道名
> instId String 产品名称
action String 推送数据动作，增量推送数据还是全量推送数据snapshot：全量update：增量
data Array 订阅的数据
> asks Array 卖方深度
> bids Array 买方深度
> ts String 数据更新时间戳，Unix时间戳的毫秒数格式，如 1597026383085
> checksum Integer 检验和

asks和bids值数组举例说明： ["411.8", "10"] 411.8为深度价格，10为此价格的基础币量

交易频道

获取最近的成交数据，有成交数据就推送, 首次推送最近50条成交记录, 后续增量推送

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"MC",
            "channel":"trade",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> instType String 是 产品类型 MC：公共频道
> channel String 是 频道名，trade
> instId String 是 产品ID

成功返回示例

{
    "event":"subscribe",
    "arg":[
        {
            "instType":"MC",
            "channel":"trade",
            "instId":"BTCUSDT"
        }
    ]
}

失败返回示例

{
    "event":"error",
    "code":30003,
    "msg":"instType:MC,channel:trade,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> instType String 是 产品类型
> channel String 是 频道名
> instId String 是 产品名称
code String 否 错误码
msg String 否 错误消息

推送示例

{
    "action":"snapshot",
    "arg":{
        "instType":"mc",
        "channel":"trade",
        "instId":"BTCUSDT"
    },
    "data":[
        [
            "1630585523753",
            "45653.5",
            "0.0100",
            1
        ],
        [
            "1630572379706",
            "45653.5",
            "0.0221",
            1
        ]
    ]
}

返回参数

参数名 类型 描述
action String snapshot/update
arg Object 订阅成功的频道
> instType String 产品类型
> channel String 频道名
> instId String 产品名称
data Array 订阅的数据
> ts String 成交时间，Unix时间戳的毫秒数格式，如 1597026383085
> px String 成交价格
> sz String 成交数量
> side String 成交方向，buy 买 sell卖

交易详情频道

获取最近的成交数据，有成交数据就推送, 首次推送最近50条成交记录, 后续增量推送

请求示例

{
    "op":"subscribe",
    "args":[
        {
            "instType":"MC",
            "channel":"tradeNew",
            "instId":"BTCUSDT"
        }
    ]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> instType String 是 产品类型 MC：公共频道
> channel String 是 频道名，tradeNew
> instId String 是 产品ID

成功返回示例

{
    "event":"subscribe",
    "arg":[
        {
            "instType":"MC",
            "channel":"tradeNew",
            "instId":"BTCUSDT"
        }
    ]
}

失败返回示例

{
    "event":"error",
    "code":30003,
    "msg":"instType:MC,channel:tradeNew,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe error
arg Object 否 订阅的频道
> instType String 是 产品类型
> channel String 是 频道名
> instId String 是 产品名称
code String 否 错误码
msg String 否 错误消息

推送示例 - snapshot

{
  "data": [
    {
      "p": "20221.5",
      "c": "0.009",
      "ti": "969054894406951028",
      "ty": "sell",
      "ts": 1666766611672
    },
    {
      "p": "20221.5",
      "c": "1.100",
      "ti": "969054894406951026",
      "ty": "sell",
      "ts": 1666766611672
    }
  ],
  "arg": {
    "instType": "mc",
    "instId": "BTCUSDT",
    "channel": "tradeNew"
  },
  "action": "snapshot"
}

推送示例 - update

{
  "data": [
    {
      "p": "20221.0",
      "c": "0.249",
      "ti": "969054896504102913",
      "ty": "buy",
      "ts": 1666766612172
    }
  ],
  "arg": {
    "instType": "mc",
    "instId": "BTCUSDT",
    "channel": "tradeNew"
  },
  "action": "update"
}

返回参数

参数名 类型 描述
action String snapshot/update
arg Object 订阅成功的频道
> instType String 产品类型
> channel String 频道名
> instId String 产品名称
data Array 订阅的数据
> ts String 成交时间，Unix时间戳的毫秒数格式，如 1597026383085
> p String 成交价格
> c String 成交数量
> ty String 成交方向，buy 买 sell卖
> ti String tradeId

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

私有频道

账户频道

获取账户信息，首次订阅按照订阅维度推送数据，此外，当下单、撤单等事件触发时，推送数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "instType": "UMCBL",
        "channel": "account",
        "instId": "default"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> instType String 是 产品类型 UMCBL:专业合约私有频道 DMCBL:混合合约私有频道
> channel String 是 频道名，account
> instId String 是 币种, 全部传 default

成功返回示例

{
    "event":"subscribe",
    "arg":{
        "instType":"UMCBL",
        "channel":"account",
        "instId":"default"
    }
}

失败返回示例

{
    "event": "error",
    "code": 30003,
    "msg": "instType:UMCBL,channel:account,instId:BTC-USDT Symbol not exists" 
} 

返回参数

参数 类型 是否必须 描述
event String 是 操作，subscribe unsubscribe error
arg Object 否 订阅的频道
> instType String 是 产品类型
> channel String 是 频道名
> instId String 否 币种
code String 否 错误码
msg String 否 错误消息

推送数据参数

参数名 类型 描述
arg Object 请求订阅的频道
> instType String 产品类型
> channel String 频道名
> instId String 币种
data Array 订阅的数据
marginCoin String 保证金币种
locked String 冻结资产
available String 当前可用资产
maxOpenPosAvailable String 最大可用开仓余额
maxTransferOut String 最大可转出
equity String 账户权益
usdtEquity String 账户权益美金价值

首次推送: 全量推送

增量推送: 推送交易变化

持仓频道

获取持仓信息，首次订阅推送数据，此外，当下单、撤单等事件触发时，推送数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "instType": "UMCBL",
        "channel": "positions",
        "instId": "default"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名，positions
> instType String 是 产品类型 UMCBL:专业合约私有频道 DMCBL:混合合约私有频道
> instId String 否 产品ID 只支持 default ：全部仓位

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
> instId String 产品ID
data Array 订阅的数据
> posId String 持仓ID
> instId String 产品id
> instName String 产品名称
> marginCoin String 占用保证金的币种
> margin String 占用保证金
>marginMode String 保证金模式， crossed：全仓 fixed：逐仓
> holdSide String 持仓方向 long：多头 short：空头
> holdMode String 持仓模式 single_hold 单向持仓,double_hold双向持仓
> total String 持仓数量
> available String 可平仓数量
> locked String 冻结数量
>averageOpenPrice String 开仓平均价
> leverage String 杠杆倍数
> achievedProfits String 已实现盈亏
> upl String 未实现盈亏
> uplRate String 未实现盈亏率
> liqPx String 预估强平价
> keepMarginRate String 维持保证金率
> fixedMarginRate String 逐仓时，实际保证金率
> marginRate String 风险率
> cTime String 持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085
> uTime String 最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085

如果同时成交多个订单，那么将持仓频道的推送尽量进行聚合。

首次推送，只推用户持有的仓位。

定时推送，只推用户持有的仓位。

订单频道

获取订单信息，首次订阅不推送，只有当下单、撤单、强平、成交等事件触发时，推送数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "orders",
        "instType": "UMCBL",
        "instId": "default"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名， orders
> instType String 是 产品类型 UMCBL:专业合约私有频道 DMCBL:混合合约私有频道
> instId String 否 目前只支持 default 全部交易对订单

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "orders",
        "instType": "UMCBL",
        "instId": "default"
    }
}

失败返回示例

{
    "event": "error",
    "code": 30003,
    "msg": "instType:UMCBL,channel:orders,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型 MC
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送数据参数

参数名 类型 描述
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
> instId String 产品ID
data Array 订阅的数据
> instId String 产品ID
> ordId String 订单ID
> clOrdId String 由用户设置的订单ID来识别您的订单
> px String 委托价格
> sz String 原始委托数量，以币为单位
> hM String Hold Mode
> eps String enterPointSource
> tS String Trade Side
> notionalUsd String 委托单预估美元价值
> ordType String 订单类型market：市价单limit：限价单
> force String 订单有效期normal：普通委托post_only： 只做maker单fok：全部成交或立即取消单ioc：立即成交并取消剩余单
> side String 订单方向，buy sell
> posSide String 持仓方向long：双向持仓多头short：双向持仓空头net：单向持仓
> tdMode String 交易模式保证金模式 isolated：逐仓 cross：全仓
> tgtCcy String 保证金币种
> fillPx String 最新成交价格
> tradeId String 最新成交ID
> fillSz String 最新成交数量
> fillTime String 最新成交时间
> fillFee String 最新一笔成交的手续费, 负数
> fillFeeCcy String 最新一笔成交的手续费币种
> execType String 最新一笔成交的流动性方向 T：taker M maker
> accFillSz String 累计成交数量
> fillNotionalUsd String 委托单已成交的美元价值
> avgPx String 成交均价，如果成交数量为0，该字段为0；若未成交，该字段也为0
> status String 订单状态 new：未成交 partial-fill： 部分成交 full-fill：完全成交 cancelled：已撤单
> lever String 杠杆倍数
>orderFee Array
>> feeCcy String 交易手续费币种 收取的就是保证金
>> fee String 订单交易手续费，平台向用户收取的交易手续费
> pnl String 收益
> uTime String 订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085
> cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085
> low Boolean Is reduceOnly

计划委托频道

获取订单信息，首次订阅不推送，只有当下单、撤单、成交等事件触发时，推送数据

请求示例

{
    "op": "subscribe",
    "args": [{
        "channel": "ordersAlgo",
        "instType": "UMCBL",
        "instId": "default"
    }]
}

请求参数

参数 类型 是否必须 描述
op String 是 操作，subscribe unsubscribe
args Array 是 请求订阅的频道列表
> channel String 是 频道名， ordersAlgo
> instType String 是 产品类型 UMCBL:专业合约私有频道 DMCBL:混合合约私有频道
> instId String 否 目前只支持 default 全部交易对订单

成功返回示例

{
    "event": "subscribe",
    "arg": {
        "channel": "ordersAlgo",
        "instType": "UMCBL",
        "instId": "default"
    }
}

失败返回示例

{
    "event": "error",
    "code": 30003,
    "msg": "instType:UMCBL,channel:orders,instId:BTC-USDT Symbol not exists"
}

返回参数

参数 类型 是否必须 描述
event String 是 事件，subscribe unsubscribe errror
arg Object 否 订阅的频道
> channel String 是 频道名
> instType String 是 产品类型 MC
> instId String 否 产品ID
code String 否 错误码
msg String 否 错误消息

推送数据参数

参数名 类型 描述
action String 'snapshot'
arg Object 订阅成功的频道
> channel String 频道名
> instType String 产品类型
> instId String 产品ID
data Array 订阅的数据
> instId String 产品ID
> id String 订单ID
> cOid String 由用户设置的订单ID来识别您的订单
> triggerPx String 触发价格
> planType String Websocket planType, 为空时表示 'pl'
> ordPx String 委托价格
> sz String 原始委托数量，以币为单位
> actualSz String 实际委托数量 以币为单位
> ordType String 订单类型market：市价单limit：限价单
> side String 订单方向，buy sell
> posSide String 持仓方向；long：双向持仓多头，short：双向持仓空头；net：单向持仓
> tgtCcy String 保证金币种
> state String 订单状态 not_trigger：未触发 triggered： 已触发 fail_trigger：触发失败 cancel：已撤单
> hM String Hold mode
> eps String enterPointSource.
> triggerTime String 触发时间, ms
> userId String 用户ID
> version Long 版本号，内部使用
> triggerPxType String 'mark'：标记价格触发； 'last'：市价触发
> key String 内部使用
> tS String Trade Side(交易方向)
> uTime String 订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085
> cTime String 订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

RestAPI错误代码

错误提示 错误码 http状态码
请求头"ACCESS_KEY"不能为空 40001 400
请求头"ACCESS_SIGN"不能为空 40002 400
请求头"ACCESS_TIMESTAMP"不能为空 40003 400
无效的ACCESS_TIMESTAMP 40005 400
无效的ACCESS_KEY 40006 400
无效的Content_Type，请使用“application/json”格式 40007 400
请求时间戳过期 40008 400
api 校验失败 40009 400
请求太频繁 429 429
请求头"ACCESS_PASSPHRASE"不能为空 40011 400
apikey/passphrase不正确 40012 400
用户被冻结 40013 400
权限不正确 40014 400
系统错误 40015 400
用户必须绑定手机或者谷歌 40016 400
参数校验失败 40017 400
非法的ip请求 40018 400
止盈价格需要>当前价格 43013 400
止盈价格需要<当前价格 43014 400
止损价格需要<当前价格 43015 400
止损价格需要>当前价格 43016 400
您当前为交易员身份，暂不支持通过计划委托进行平仓 43001 400
止盈止损单不存在 43020 400
止盈止损单已经处于结束状态 43021 400
预设止盈止损触发失败 43022 429
仓位不足，不能设置止盈或者止损 43023 400
已有委托中的止盈/止损，请在全部撤销后更改 43024 400
计划委托单不存在 43025 400
计划委托单已经处于结束状态 43026 400
持仓数量 + 委托订单大于60 45116 400
您当前为交易员身份，请在当前带单下进行平仓 40728 400
可用仓位不足 40757 400
重复的clientOid 40786 400
service return an error 40725 400
请求超时 40010 400
参数校验异常 40808 400
参数 {0} 不应该为null 40811 400
条件 {0} 未满足 40812 400
参数 {0} 异常 40020 400
用户禁止提币 40021 400
此账号该业务已被限制 40022 400
此账号该业务已被限制 40023 400
参数 {0} 不能为空 40019 400
账户余额不足 43012 400
该交易对已下线 41113 400
当前交易对停盘中，具体开放时间请留意官方公告 41114 400
参数错误 {0} 43111 400
提币金额小于手续费 {0} 43112 400
委托价格高于最高买价 40815 400
委托价格低于于最低卖价 40816 400
触发最小下单数量 45111 400
您输入的价格应该是 {0} 的倍数 45115 400
该币种限制买入额度{0}，还剩{1} 43122 400
未知错误 45001 400

WebSocket错误代码

错误提示 错误码
频道不存在 30001
不合法的请求 30002
无效op 30003
用户需要登录 30004
登录失败 30005
请求频繁 30006
请求超限,连接关闭 30007
无效的ACCESS_KEY 30011
无效的ACCESS_PASSPHRASE 30012
无效的ACCESS_TIMESTAMP 30013
请求时间戳过期 30014
无效的签名 30015
console