Giter Club home page Giter Club logo

biger-api-doc's Introduction

BIGER 交易所 OPEN API

BIGER OPEN API 提供两种API, 1. Rest API 用于操作用户账户和订单,2, Rest API 用于获取K线数据,3. WebSocket API 用于获取实时行情信息,主要功能如下:

  • WebSocket API: 获取市场行情
  • REST API: 查询账户信息, 可用金额和冻结金额
  • REST API: 执行买入、卖出、撤单和查询挂单命令
  • REST API: 获取历史K线数据
  • Temporary websocket auth token exchange

官方 Java SDK

我们提供 一个open source java sdk 方便用户用java 调用我们提供的 open api. 请看看 https://github.com/biger-exchange/biger-client

REST API 简介

BIGER 的REST API URL为 https://pub-api.biger.pro (需要绑定IP,行情获取接口也提供不需要绑定IP URL: https://www.biger.pro/ ), 在使用REST API 操作订单时,需要使用签名认证,以保证通信安全。通过REST API操作以下功能

  • 行情的获取
  • 账户操作
  • 交易

签名认证

安全认证

基于安全考虑,除行情外的REST API均需要访问令牌,即Access Token.一个账户可以申请多个Access Token, 以满足每个APP使用独立的Access Token。Access Token需单独申请,请联系管理员. 申请时需提供公钥和Access Token的过期日, 还有用API的IP地址,目前支持的公钥是RSA。

To apply for access token, you will also first need to generate you rown RSA key pair, and give us your public key. (keep your private key safe on your own end).

To generate a RSA key pair, you can use a multitude of openly available tools.

        KeyPairGenerator g = KeyPairGenerator.getInstance("RSA");
        g.initialize(2048);
        KeyPair p = g.generateKeyPair();
        Files.write(Paths.get("private"), p.getPrivate().getEncoded(), StandardOpenOption.CREATE_NEW);
        Files.write(Paths.get("public"), p.getPublic().getEncoded(), StandardOpenOption.CREATE_NEW);

请求头

非行情API均需以下三个请求头

名字
BIGER-ACCESS-TOKEN 申请后获取的Access Token
BIGER-REQUEST-EXPIRY 此请求的过期时间,Unix epoch millisecond,+5s = 5 * 1000
BIGER-REQUEST-HASH 由请求参数和私钥计算出来的签名

签名运算

用SHA256进行签名,签名计算的字符串由以下四部分连接组成

  • query string
  • 请求方法
  • BIGER-REQUEST-EXPIRY的值
  • 请求体

示例

{ 
GET /exchange/someEndpoint?someKey=someValue&anotherKey=anotherValue
HOST:xxxx
BIGER-REQUEST-EXPIRY: 999999999999999
BIGER-ACCESS-TOKEN: myAccessToken
BIGER-REQUEST-HASH: c8owjqPSnY4mgFK8IHTk+1S+zhaEaAdoS6tJvr+o5FJFLymMyedOC6xJL9vCmVHALgXm+1mwF+0z1ZHVyJDKrdptZIfXis1tswBtt0v4k69ADYBlZkpLAhCpf0s55OQ18BbhGsrWpjm2kLtPEsPY3hvsh5nqWQQfJRAMzWFmg/8hnNa3MvWJLpZexFOYRLzmTdqthhKlw8pOvuE4pURbe27OLS4lINwY+0ck1DGINRE4/UtH+kYK3AAQq8CE/mSnWVNrIBFpYAe0frEZDluYppnuVXs3IGIQelR3RPqyYY5bfdccHVU8yBBaACRWZMTnvbdQW3TOSV/ccojaHEHBJA==
}

BIGER-REQUEST-HASH 计算公式如下:

{
Base64Encode(RSAEncrypt(myPrivateKey, SHA256(utf8ToBytes(“someKey=someValue&anotherKey=anotherValueGET999999999999999”)))
}
RSAEncrypt 要利用 RSA/ECB/PKCS1Padding

ECB - Electronic Codebook Mode, as defined in FIPS PUB 81, http://csrc.nist.gov/publications/fips/index.html. PKCS1Padding - The padding scheme described in PKCS #1, http://www.rsa.com/rsalabs/node.asp?id=2125.

REST API列表

市场信息查询接口列表

市场数据查询接口不需要进行签名和认证

查询数字货币24H价格历史

路径: https://pub-api.biger.pro/exchange/coins/query/all 方法: GET 请求参数 无

HTTP 请求 URL:

https://pub-api.biger.pro/exchange/coins/query/all

HTTP返回

{
    "result": "Success",
    "code": 200,
    "msg": "Success",
    "data": [
        {
            "coinCode": 102,
            "coinName": "BCH",
            "fullName": "BCH",
            "scale": 8,
            "iconUrl": "/s3-prd-static/images/share/admin/admin20181128175337_9870.png",
            "status": 1,
            "coinType": 0
        },
    ...
]}

示例

请求: https://pub-api.biger.pro/exchange/coins/query/all
返回: 
{
    "result": "Success",
    "code": 200,
    "msg": "Success",
    "data": [
        {
            "coinCode": 102,
            "coinName": "BCH",
            "fullName": "BCH",
            "scale": 8,
            "iconUrl": "/s3-prd-static/images/share/admin/admin20181128175337_9870.png",
            "status": 1,
            "coinType": 0
        },
    ...
]}

交易对24小时价格查询

此API用户获取交易所每个交易对24小时的价格变动

URL Path: /exchange/markets/query/all HTTP Method: GET

HTTP 请求 URL:

URL 需要注册IP   : https://pub-api.biger.pro/exchange/markets/query/all

HTTP 返回说明

{"result":"Success","code":200,"msg":"Success","data":[{"symbol":"AEUSDT","symbolDisplayName":"AE/USDT","baseCurrencyCode":212,"baseCurrencyName":"AE","quoteCurrencyCode":106,"quoteCurrencyName":"USDT","amountDivisibilityUnit":"0.001","priceDivisibilityUnit":"0.0001","last":"0.3880","rate24h":"-0.0358","open24h":"0.4024","close24h":"0.3880","low24h":"0.3857","high24h":"0.4534","volume24h":"85841.449","rate7d":"-0.0214","low7d":"0.3779","high7d":"0.4534","open7d":"0.3965","close7d":"0.3880","volume7d":"559853.902","maxPriceScale":4,"maxQuantityScale":3,"maxTotalPriceScale":7,"ticker":null},
    ...
]}

示例

Request: https://pub-api.biger.pro/exchange/markets/query/all
Response: 
{"result":"Success","code":200,"msg":"Success","data":[{"symbol":"AEUSDT","symbolDisplayName":"AE/USDT","baseCurrencyCode":212,"baseCurrencyName":"AE","quoteCurrencyCode":106,"quoteCurrencyName":"USDT","amountDivisibilityUnit":"0.001","priceDivisibilityUnit":"0.0001","last":"0.3880","rate24h":"-0.0358","open24h":"0.4024","close24h":"0.3880","low24h":"0.3857","high24h":"0.4534","volume24h":"85841.449","rate7d":"-0.0214","low7d":"0.3779","high7d":"0.4534","open7d":"0.3965","close7d":"0.3880","volume7d":"559853.902","maxPriceScale":4,"maxQuantityScale":3,"maxTotalPriceScale":7,"ticker":null},
    ...
]}

交易对 K线的历史查询

REST API https://pub-api.biger.pro/md/kline 只用于提供历史的K线查询,如果需要持续的详细K线数据,请使用 WebSocket API

路径: /md/kline 方法: GET 请求参数

参数 属性 类型 说明
symbol 必须 String oin pair symbol, eg. BTCUSDT
period / interval 必须 String K线时间周期,可能的值:1min,5min,15min,30min,60min,1day,1mon,1week,60,300,900,1800,3600,86400,604800, 2592000
start_time 可选 Integer 缺省为取200根K线的开始时间,从1970年1月1日开始计算的UTC时间,以秒为单位. eg. 1543274801
end_time 可选 Integer 缺省为当前时间,从1970年1月1日开始计算的UTC时间,以秒为单位. eg. 1543274801

HTTP 请求 URL 示例说明

https://pub-api.biger.pro/md/kline?id=0&symbol=<symbol>&start_time=<timestamp>&end_time=<timestamp>&period=<period>

HTTP返回说明

{“error":null,"id":0,"result":[
    [
        1492358400, 时间
        "7000.00",  开盘价
        "8000.0",   收盘价
        "8100.00",  最高价
        "6800.00",  最低价
        "1000.00"   成交量
        "123456.00" 成交额
        "BTCUSDT"   交易品种
    ]
    ...
]}

示例

请求: https://pub-api.biger.pro/md/kline?id=0&symbol=BTCUSDT&start_time=1543274801&end_time=1543374801&period=1day
返回: 
{“error":null,"id":0,"result":[
[1543190400,”4394","3863.05","4394","3701.72","1809.258054","7117136.76413459","BTCUSDT"],
[1543276800,”3862.7","3875.11","3939.02","3686.59","1597.117575","6097170.88594629","BTCUSDT"],
[1543363200,”3909.69","4262.39","4389.04","3887.99","1734.877599","7166445.63528313","BTCUSDT"]
]}

用户账户和订单接口列表

用户账户和订单接口属于保护接口,每次接口的调用必须对请求体进行签名。

查询用户账户余额

路径:/exchange/accounts/list/accounts 方法: GET 示例:

路径	/exchange/accounts/list/accounts
返回	{
	"result"		: 	"Success",
 	"code"		: 	200,
 	"msg"		: 	"Success",
 	"data"		: 
	[
    	{
      		"coinCode"				:	 101,
      		"coinName"				:	 "BTC",
     		"balance"					:	 "9945.41972572",
		    "balanceUpdateTime"		: 	1530520590125,
		    "lockedAmount"			: 	"0",
		    "availBalance"				: 	"9945.41972572",
		    "lockedAmountUpdateTime"	: 	1530520592901
},
…
]
}

查询指定单

路径: /exchange/orders/get/orderId/{orderId} 方法: GET 示例: 路径 /exchange/orders/get/orderId/43960eab-d040-4eca-a4cd-bb20473e9960 返回

{
"result":		"Success",
	"code":		200,
	"msg":		"Success",
	"data":
	{
		"orderId"			:"43960eab-d040-4eca-a4cd-bb20473e9960",
		"clientOrderId"		:11741743498134528,
		"side"				:"SELL",
		"symbol"				:"LTCUSDT",
		"baseCurrencyCode"	:103,
		"orderType"			:"LIMIT",
		"orderState"			:"FILLED",
		"price"				:"56.79",
		"orderQty"			:"1.08751",
		"filledQty"			:"1.08751",
		"totalPrice"			:"61.7596929",
		"dealPrice"			:"56.79",
		"completeTime"		:1537160398445,
		"createTime"			:1537160398408,
		"updateTime"			:1537160398448,
		"rejectReason"		:null
	}
}

返回字段说明

字段名 描述 取值
orderId 系统产生的订单标识 GUID
clientOrderId 终端显示的订单标识 64bit Integer
orderState 订单状态 PENDING: 系统接收了订单,正在处理中 ; NEW: 新订单处理完毕 ; PARTIALLY_FILLED: 部分成交 ; FILLED: 全部成交 ; PENDING_CANCEL: 正在取消 ; CANCELED: 已取消(可能有部分成交) ; REJECTED: 已拒接(拒接原因在rejectReason)
filledQty 成交数量 到目前成交数量
totalPrice 成交额 到目前所有成交额加总,单个成交的成交额=成交数量*成交价格
dealPrice 成交均价 totalPrice / filledQty
completeTime 完成时间 Unix epoch milliseconds. 仅全成交有此值
updateTime 更新时间 Unix epoch milliseconds
rejectReason 拒接原因 String
side 买卖 BUY, SELL
symbol 交易对 参考 Appendix A
orderType 类型 LIMIT,暂时只支持限价
orderQty 数量 string
Price 单价 String

查询当前所有单

路径: /exchange/orders/current?symbol={ symbol }&side={ side }&offset={ offset=}&limit={ limit } 方法: GET 请求参数

参数名 必须 默认 描述 取值
symbol NA 币对 参考 Appendix A
side NA 买卖 BUY, SELL
offset 0 起始偏移量 用于分页获取
limit 20 获取数量 最大100

示例: 路径 /exchange/orders/current?symbol=LTCUSDT&side=BUY&offset=0&limit=50 返回

{
"result"	:	"Success",
"code"	: 	200,
"msg"	:	"Success",
"data"	:
[
	{
		"orderId"		:	"fdb97848-2034-4638-bd58-dd023e570c3d",
		"clientOrderId":	11362746867123200,
		...
	},
	{
		"orderId"		:	"0f92fb04-ffc7-42f2-9032-b1b6006d3f9d",
		"clientOrderId":	11230322151130112
		...
	}
]
}

下单

Note that when creating an order, the order quantity and order price scale(number of decimal points) will be truncated if they were higher than our accepted values. For example, eg LTC/USDT orders will have the order price truncated to 2 decimal places while order quantity will be truncated to 5 decimal places. See appendix B

路径: /exchange/orders/create 方法: POST 请求体

参数名 必须? 默认 描述 取值
symbol 交易对
side 买卖 BUY, SELL
price 交易价格 unit price - String
orderQty 交易数量 String to avoid rounding issues
orderType 订单类型 LIMIT

示例: 路径 /exchange/orders/create 请求体

{
	"symbol" 	:  "BCHUSDT",
	"side"   		:  "BUY",
	"price"		:  "451.29",
	"orderQty" 	:  "0.14536",
	"orderType"	:  "LIMIT"
}

返回

{
	"result":	"Success",
	"code":	200,
	"msg":	"Success",
	"data":
	{
		"orderId"			:"c0a480e7-211f-4090-8b56-96abee5d32ce",
		"clientOrderId"			:11741744533079040,
		"side"					:"BUY",
		"symbol"					:"BCHUSDT",
		"orderType"				:"LIMIT",
		"orderState"				:"PENDING",
		"price"					:"451.29",
		"orderQty"				:"0.14536",
		"filledQty"				:"0.00000",
		"totalPrice"				:"0.0000000",
		"dealPrice"				:"0",
		"completeTime"			:null,
		"createTime"				:1537160400382,
		"updateTime"				:null,
		"rejectReason"			:null
	}
}

撤单

路径: /exchange/orders/cancel/{orderId} 方法: PUT 示例: 路径 /exchange/orders/cancel/725c0119-114c-471c-a2c5-d5c51d0210dd 返回

{
	"result"		: "Success",
	"code"   	: 200,
	"msg"    	: "Success"
}
Or in cases of error	{
	"result" 		: "Error",
	"code"   	: 99506,
	"msg"    	: "Some error message"
}

常见错误

  • order.not.exist – 给定订单不存在或者在PENDING状态
  • order.update.error.user.mismatch – 不是此用户订单
  • order.update.error.cancelled – 此此订单已撤销
  • order.cancel.failed.wrong.state – 此订单不可撤销,非NEW和 PARTIALLY_FILLED状态
  • ORDER CANCEL FAILURE PENDING ENGINE – 此订单不在订单簿中,可能已成交
  • The system is busy, please try again later – 系统繁忙,请重试

Websocket API

Websocket API URL为 wss://www.biger.pro/ws , 通过websocket API可以获取市场数据。

Temporary token exchange

Some websocket APIs require you to authenticate using a temporary API token. To retrieve this temporary API token, you need to request via a HTTP POST to https://pub-api.biger.pro/tokens/exchange with HTTP header BIGER-ACCESS-TOKEN-FOR-EXCHANGE where the value is your access token.

You should get a HTTP 200 response (if not then check your access token or contact us) that looks like the below-

{
    "code": 200,
    "result": "0d4fCb6YHhhOg6QsTyhydOLqISfF8V8aU8CV39w1BjeBXMv9oHiKrAcsRkpasmrRNh/LJzoEf/Ah4ul/ELnmKg0z/jvJ3DOhnsPO16UhW2LC6+Gw1EHh5bpMQx1AVeMjDAZZ9fMCJe52lbwvV6QaresUtez8tJFrvIfoL/APVX0wt60Ze54Gu0lCOVTUoYLHlOopBg+Vrrzxm5vtsSSG32Ivm2zr2vQ7ydxhiutpXwA4CXUfT60QBo0cU0l6UL9yd/dPnB/UXQ7PIveoQzb7/kxJ8dIeykxSVbkVN7q0JL9psKDGqn//UmkGui5huvIWlJuun2RAKujZna5uMdVW1aRObt8nSxjJey1AXThaW6AWnObre1h49l1MHn+qf+I6StJiUOljPKL0gbdvOGMXlsiMRNdxnvDeJuwWghiFByINYmGvp1BrYb7Ipe7Ja38YRMdidd3Z7TvXUKIj7iv5BWL0fNO+OGeXpuWQOelP5rhyeOwvra2yRPzrUMkUnuZGrrpjQpQvqmiGpkPvdCyLYsjUhaCpRRwAcGbtw+yN+SY=",
    "encryptedKey": "Ukb6CLSg5g0Ey4iKZUeVq/HcNacXKwjGC+8UCwMAdej7V+V7Xdp4yE4drYV5YPJu/fr/nVtVWVogfLMKF9sHMpPU6KDZeFsGZlsciTDnf3uDcS5b7mgpsap6DU38rxE7+20GiWQf5TUTIcJ23lI9oRZSE9ooU5NCDgHtQsrshIP1HiI4+iACC9WiLOqo9zESgFsRr9I7ICjQNM7sFjw4NsCLurJdFaFdC79vjMruq6DpcnkWRbLysQFqRWxBQsxAkXB1i1FMeU3McTdKkEWyuOKwpLBXDm9VKlauS7VKOgWEPQ+mUeiPi6KwHBhtIGzbJ8glCAsxVyQ+j06KuxajRg=="
}

Now perform the following steps

  • base64 decode the value of 'encryptedKey', and then use your private key to decrypt the result to obtain AES secret key
  • base64 decode the value of 'result', and then perform AES decryption using the AES secret key on the result to obtain your temporary token

Note that the temporary token is only valid for 30 seconds.

系统接口

心跳请求

客户端需定时向系统发送心跳请求以确认网络和系统状态正常。正常情况下,系统会立即回复Pong消息。系统超出30秒没有收到客户端的心跳请求,将关闭客户端网络链接。

语法

{
"method"	: "server.ping",
"params"	: [],
"id"		: <id>
}

示例

请求: {"method": "server.ping", "params": [], "id": 1516681178}
返回: {"result": "pong", "error": null, "id": 1516681178}

查询系统时间

获取当前系统时间,回复时间从Epoch开始计算起,单位为秒。本文以下所有涉及时间的参数以及回复内容均为Epoch时间。建议客户端用此时间作为与系统交互的时间基准。

语法

{
  "method"	: "server.time",
  "params"	: [],
  "id"		: <id>
}

示例

请求: {"method": "server.time", "params": [], "id": 1516681178}
返回: {"result": 1520437025, "error": null, "id": 1516681178}

K线接口

K线间隔参数可设置为以下之一:60(1分钟),300(5分钟), 600(10分钟),900(15分钟),1800(30分钟),3600(1小时),14400(4小时),86400(1天),604800(1周), 2592000(1月)。

查询K线

K线查询数量最多可以同时请求2500条,如果超出范围系统将返回参数错误。

语法

{
  "method"	: "kline.query",
  "params"	: [<market>, <start_time>, <end_time>, <interval>],
  "id"		:      <id>
}
参数 数据类型 描述
market String 交易品种
start_time Integer 开始时间
end_time Integer 结束时间
Interval Integer K线间隔

回复语法:

"result": [
    [
        1492358400, 时间
        "7000.00",  开盘价
        "8000.0",   收盘价
        "8100.00",  最高价
        "6800.00",  最低价
        "1000.00"   成交量
        "123456.00" 成交额
        "BTCUSDT"   交易品种
    ]
    ...
]

示例

> {"method": "kline.query", "params": ["BTCBCH", 1520432255, 1520433255, 900], "id": 1516681178}
< {
"result": 
[
        [
            1520432100,
            "8093",
            "8008",
            "8093",
            "8008",
            "45",
            "361758",
            "BTCUSDT"
        ],
        [
            1520433000,
            "8089",
            "8079",
            "8089",
            "8021",
            "57",
            "459239",
            "BTCUSDT"
        ]
    ],
    "error"	: null,
    "id"		: 1516681178
}

订阅K线

订阅成功之后,系统在发现数据变化时会及时推送最新的一到两根K线。 语法

{
  "method"	: "kline.subscribe",
  "params"	: [<market>, <interval>],
  "id"		:      <id>
}
参数 数据类型 描述
market String 交易品种
interval Integer K线间隔

示例

> {"method": "kline.subscribe", "params": ["BTCUSDT", 900], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}
< {"method": "kline.update", "id": null, "params": [[1520436600, "8040", "8040", "8040", "8040", "9", "72360", "BTCUSDT"]]}

取消K线订阅

语法

{
  "method"	: "kline.unsubscribe",
  "params"	: [<market>],
  "id"		: <id>
}
参数 数据类型 描述
market String 交易品种。若参数为空,即取消所有K线订阅。

示例

> {"method": "kline.unsubscribe", "params": [], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}

最新报价接口

查询最新报价

语法

{
  "method"	: "price.query",
  "params"	: [<market>],
  "id"		:  <id>
}
参数 数据类型 描述
market String 交易品种

示例

> {"method": "price.query", "params": ["BTCUSDT"], "id": 1516681178}
< {
    "result"	: "8074.00000000",
    "error"	: null,
    "id"		: 1516681178
  }

订阅最新报价

订阅成功之后,系统在发现数据变化时会及时推送最新报价。

语法

{
  "method"	: "price.subscribe",
  "params"	: [<market>],
  "id"		:  <id>
}
参数 数据类型 描述
market String 交易品种

示例

> {"method": "price.subscribe", "params": ["BTCUSDT"], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}
< {"method": "price.update", "id": null, "params": ["BTCUSDT", "8050"]}

取消最新报价订阅

语法

{
  "method"	: "price.unsubscribe",
  "params"	: [<market>],
  "id"		:      <id>
}
参数 数据类型 描述
market String 交易品种。若参数为空,即取消所有报价订阅。

示例

> {"method": "price.unsubscribe", "params": [], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}

市场成交数据接口

查询逐笔成交历史

支持查询最多100条历史成交数据查询。 语法

{
  "method"	: "deals.query",
  "params"	: [“<market>”, “<limit>”, “<last_id>”],
  "id"		:      <id>
}
参数 数据类型 描述
market String 交易品种
last_id String 上次查询返回的最新成交ID

示例

> {"method": "deals.query", "params": ["BTCUSDT", 3, 0], "id": 1516681178}
< {
    "result": [
        {
            "price"	: "8056",
            "time"	: 1520438100.3066709,
            "id"		: 1759,
            "amount"	: "3",
            "type"	: "buy"
        },
        {
            "price"	: "8007",
            "time"	: 1520438000.2892129,
            "id"		: 1758,
            "amount"	: "9",
            "type"	: "buy"
        },
        {
            "price"	: "8050",
            "time"	: 1520437900.2736571,
            "id"		: 1757,
            "amount"	: "6",
            "type"	: "buy"
        }
    ],
    "error"	: null,
    "id"		: 1516681178
}

逐笔成交数据订阅

订阅成功之后,系统在发现数据变化时会及时推送成交数据。

语法

{
"method"	: "deals.subscribe",
"params"	: [“<market>”],
"id"		: <id>
}
参数 数据类型 描述
market String 交易品种

示例

> {"method": "deals.subscribe", "params": ["BTCUSDT"], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}
< {"method": "deals.update", "id": null, "params": ["BTCUSDT", [{"price": "8044", "type": "buy", "time": 1520438400.361028, "amount": "2", "id": 1762}, {"price": "8078", "type": "buy", "time": 1520438300.341769, "amount": "9", "id": 1761}, {"price": "8076", "type": "buy", "time": 1520438200.324909, "amount": "10", "id": 1760}, {"price": "8056", "type": "buy", "time": 1520438100.3066709, "amount": "3", "id": 1759}, {"price": "8007", "type": "buy", "time": 1520438000.2892129, "amount": "9", "id": 1758}, {"price": "8050", "type": "buy", "time": 1520437900.2736571, "amount": "6", "id": 1757}, {"price": "8074", "type": "buy", "time": 1520437800.257802, "amount": "1", "id": 1756}, {"price": "8014", "type": "buy", "time": 1520437700.239372, "amount": "4", "id": 1755}, {"price": "8054", "type": "buy", "time": 1520437600.223423, "amount": "9", "id": 1754}, {"price": "8049", "type": "buy", "time": 1520437500.2082629, "amount": "8", "id": 1753}, {"price": "8002", "type": "buy", "time": 1520437400.1939909, "amount": "2", "id": 1752}, {"price": "8000", "type": "buy", "time": 1520437300.1761429, "amount": "5", "id": 1751}, {"price": "8002", "type": "buy", "time": 1520437200.1584849, "amount": "10", "id": 1750}, {"price": "8065", "type": "buy", "time": 1520437100.142282, "amount": "5", "id": 1749}, {"price": "8099", "type": "buy", "time": 1520437000.1258199, "amount": "5", "id": 1748}, {"price": "8009", "type": "buy", "time": 1520436900.1072299, "amount": "6", "id": 1747}, {"price": "8066", "type": "buy", "time": 1520436800.0908389, "amount": "10", "id": 1746},
...

取消逐笔成交数据订阅

语法

{
  "method"	: "deals.unsubscribe",
  "params"	: [<market>],
  "id"		:      <id>
}
参数 数据类型 描述
market String 交易品种。若参数为空,即取消所有成交订阅。

示例

> {"method": "deals.unsubscribe", "params": [], "id": 1516681178}
< {"result": {"status": "success"}, "error": null, "id": 1516681178}

市场深度数据接口

查询最新市场深度

语法

{
  "method"	: "depth.query",
  "params"	: [“<market>”, <limit>, <interval>],
  "id"		: <id>
}
参数 数据类型 描述
market String 交易品种
limit Integer 盘口深度
interval String 盘口报价精度。“0”为最大精度。可选精度为: “0”,”0.1", “0.01", “0.001", “0.0001", “0.00001", “0.000001", “0.0000001", "0.00000001"

示例

> {"method": "depth.query", "params": ["BTCUSDT", 10, "0"], "id": 1516681178}
< {
    "error"	: null,
"result": 
{
        "asks": [],
        "bids": [
            [
                "803.25",
                "0.063"
            ],
            [
                "803.2",
                "0.051" 
            ],
            [
                "803.15",
                "0.057"
            ],
            [
                "803.1",
                "0.083"
            ],
            [
                "803.05",
                "0.077"
            ],
            [
                "803",
                "0.074"
            ],
            [
                "802.95",
                "0.119"
            ],
            [
                "802.9",
                "0.085"
            ],
            [
                "802.85",
                "0.05"
            ],
            [
                "802.8",
                "0.054"
            ]
    },
    "id": 1516681178
}

订阅市场深度

订阅成功之后,系统在发现数据变化时会及时推送深度数据。深度数据更新中的布尔变量为true时,即为全推数据,若是false,即为变化推送。一般情况下,系统只推送深度变化数据,即深度数据的增加和修改,减少(当数量为0时即为删除该档数据)。系统在每超过一分钟之后,有一次全推的数据。

语法

{
  "method"	: "depth.subscribe",
  "params"	: [“<market>”, <limit>, <interval> ],
  "id"		: <id>
}
参数 数据类型 描述
market String 交易品种
limit Integer 盘口深度
interval String 盘口报价精度。“0”为最大精度。可选精度为: “0”,”0.1", “0.01", “0.001", “0.0001", “0.00001", “0.000001", “0.0000001", "0.00000001"

示例

> {"method": "depth.subscribe", "params": ["BTCUSDT", 10, "0"], "id": 1516681178}
< {"error": null, "result": {"status": "success"}, "id": 1516681178}
< {"method": "depth.update", "params": [true, {"asks": [], "bids": []}, "BTCUSDT"], "id": null}

取消市场深度订阅

语法

{
"method"	: "depth.unsubscribe",
"params"	: [],
"id"		:      <id>
}
参数 数据类型 描述
market String 交易品种。若参数为空,即取消所有深度订阅。

示例

> {"method": "depth.unsubscribe", "params": [], "id": 1516681178}
< {"error": null, "result": {"status": "success"}, "id": 1516681178}

错误处理

当接口调用失败时,系统会返回表示错误的应答。 语法

{
  	“error"	: 
{
    		“code"		: <code>,
    		“message"	: "<message>"
  	},
  "id"		:1516681178,
  "result"	:null
}
参数 数据类型 描述
code Integer 错误码,具体内容参考下面说明
message String 错误信息,具体内容参考下面说明

错误代码说明

错误代码 错误原因
6001 任何的参数错误,系统返回返回参数错误代码
6005 系统回复超时。若是系统内部由于某种原因无法在5秒钟内正常回复数据,系统将返回此错误代码。
6012 用户验证失败。若是用户Access token验证失败,系统将会返回此错误代码。
6013 服务繁忙。若是客户端与系统之间网络传输缓慢,系统将会丢掉过时数据,并且返回此服务繁忙错误代码。
6014 请求频率超出限制。若是过度发送请求,系统将返回此错误代码并且延迟回复数据。
6015 订阅数超出请求。若是订阅数量超出超出系统限制,系统将会返回此错误代码并且关掉网络链接。

PUBLIC API申请

1.申请准备

2.发起申请

申请格式如下:

key info

key type: PKCS#1/PKCS#8
key length: 2048

public key

-----BEGIN PUBLIC KEY-----
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-----END PUBLIC KEY-----

account info

phone:
+852 88888888
email:
[email protected]

ip list

111.111.111.11
111.111.111.12

资源汇总

FAQ

  • 1.我应该生成什么格式的签名密钥?
    根据我们提供的签名SDK,建议如下:
    python和cpp使用pkcs#1的密钥格式,java和C#使用pkcs#8的密钥格式

  • 2.websocket接口中的id如何获取? id是异步IO时关联上下文用的,用户可以自己设置,如果是同步IO,可以随便填,为整型

Appendix A - Symbol list

  • LTCUSDT
  • ETHUSDT
  • BTCUSDT
  • BCHUSDT
  • LTCETH
  • BCHETC
  • ETHBTC
  • LTCBTC
  • BCHBTC

=======

Appendix B - accepted order quantity and order price scale

Note that when creating an order, the order quantity and order price scale(number of decimal points) will be truncated if they were higher than our accepted values. For example, eg LTC/USDT orders will have the order price truncated to 2 decimal places while order quantity will be truncated to 5 decimal places.

Symbol Price Scale Qty Scale
ETHBTC 6 3
BCHBTC 5 3
LTCBTC 6 3
BTCUSDT 2 6
ETHUSDT 2 5
BCHUSDT 2 5
LTCUSDT 2 5
BCHETH 8 8
LTCETH 5 3

Appendix C - Check validity of access token

Once given your access token, you can use our open-source testing utility to check the validity and usability of your access token. Check it out at BigerFX

Appendix D - golang signature generation example

We do not yet provide a golang client, but have sample code to illustrate how to generate the signature hash using golang. Please see golang signature example

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.