Giters

jaggedsoft / bkex-official-api-docs

BKEX API document.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

*Read this in English: English

BKEX Official API Document

HTTP API

API服务域名：

api地址:

BASE_END_POINT=https://api.bkex.vip

备用api地址:

BASE_END_POINT=https://api.bkex.com

加密过程

假设用户申请得到的API key信息如下：

secretKey: NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j

accessKey: vmsUZE6mv9SD5VNak4HlWFsOr6aKE2zvsw0MuIgwCIGy6utIco14y7Ju91duEh82

以以下请求为例

curl -X GET \
  'https://<BASE_END_POINT>/v1/q/depth?&precision=2&pair=ETH_USDT' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'X_ACCESS_KEY: vmsUZE6mv9SD5VNak4HlWFsOr6aKE2zvsw0MuIgwCIGy6utIco14y7Ju91duEh82' \
  -H 'X_SIGNATURE: 550ac73ace8c34372e0e1dd6631e890c7bd16697af8bb4e2908e966b50aba4e0' \
  • 首先对请求参数的key进行ASCII排列得到结果 pair=ETH_USDT&precision=2
  • 然后使用secretKey 进行HMAC SHA256进行加密
[linux]$ echo -n "pair=ETH_USDT&precision=2" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"

得到的内容是 550ac73ace8c34372e0e1dd6631e890c7bd16697af8bb4e2908e966b50aba4e0

  • 构造http请求: 使用 X_ACCESS_KEY 这个header存储access key信息， 使用 X_SIGNATURE header 存储第二步生成的签名信息， 然后发送http请求

Examples

Exchange API

Get exchangeInfo

GET /v1/exchangeInfo

Response:

{
  "msg": "success",
  "code": 0,
  "data": {
    "coinTypes": [
      {
        "coinType": "ETH",
        "isSupportDeposit": true,
        "isSupportWithdraw": true,
        "isSupportTrade": true,
        "minWithdrawSingle": 10,
        "maxWithdrawSingle": 100,
        "maxWithdrawOneDay": 5000,
        "withdrawFee": 0.01,
      }
    ],
    "pairs": [
      {
        "pair": "ETH_USDT",
        "isSupportTrade": true,
        "pricePrecision": 8,
        "amountPrecision": 4,
        "minimumTradeAmount": 0.1,
      }
    ]
  }
}

Quotation API

Get quotation depth

GET /v1/q/depth

Parameters:

Name Type Required Default Description
pair STRING true
size INT false 50
precision INT false

Response:

{
  "msg": "success",
  "code": 0,
  "data": {
    "asks": [
      {
        "pair": "ETH_USDT",
        "direction": "ASK",
        "amt": 50,
        "price": 1.32
      },
      {
        "pair": "ETH_USDT",
        "direction": "ASK",
        "amt": 40,
        "price": 2.32
      }
    ],
    "bids": [
      {
        "pair": "ETH_USDT",
        "direction": "BID",
        "amt": 1250,
        "price": 1.12
      },
      {
        "pair": "ETH_USDT",
        "direction": "BID",
        "amt": 160,
        "price": 1.11
      }
    ]
  }
}

  • asks : 卖单构成的数组

    bids: 买单构成的数组

  • 单个买卖单

    direction: BID-- 买单 ASK-卖单

    amt: 该价格下总量

    price: 价格参数

Get quotation deals

GET /v1/q/deals

Parameters:

Name Type Required Default Description
pair STRING true
size INT false 20

Response:

{
  "msg": "success",
  "code": 0,
  "data": [
    {
      "pair": "ETH_USDT",
      "dealAmount": 10,
      "price": 1.3236,
      "createdTime": 1532190888913,
      "tradeDealDirection": "B"
    },
    {
      "pair": "ETH_USDT",
      "dealAmount": 10,
      "price": 1.3236,
      "createdTime": 1532190887795,
      "tradeDealDirection": "B"
    },
    {
      "pair": "ETH_USDT",
      "dealAmount": 10,
      "price": 1.3235,
      "createdTime": 1532190886739,
      "tradeDealDirection": "B"
    },
    {
      "pair": "ETH_USDT",
      "dealAmount": 10,
      "price": 1.3235,
      "createdTime": 1532190862672,
      "tradeDealDirection": "B"
    },
    {
      "pair": "ETH_USDT",
      "dealAmount": 10,
      "price": 1.3234,
      "createdTime": 1532190862398,
      "tradeDealDirection": "B"
    }
  ]
}

  • pair: 交易对

    dealAmount: 成交量

    price: 成交价格

    createTime: 成交时间

    tradeDealDirection: 主动成交方向。 主动成交方向，如果是主动发起买单成交，代表外盘，值是B， 如果是主动卖单来成交，代表内盘，值是S

24hr ticker price change statistics

GET /v1/q/ticker

Parameters:

Name Type Required Default Description
pair STRING true

Response:

{
  "msg": "success",
  "code": 0,
  "data": {
    "pair": "ETH_USDT",
    "o": 0.0, //开盘价
    "c": 0.0, //收盘价
    "h": 0.0, //最高价
    "l": 0.0, //最低价
    "a": 0.0, //交易量 amount
    "r": 0 //涨跌
  }
}

Pair price ticker

GET /v1/q/ticker/price

Parameters:

Name Type Required Default Description
pair STRING true

Response:

{
  "msg": "success",
  "code": 0,
  "data": {
    "pair": "ETH_USDT",
    "price": 0.0
  }
}

Kline

GET /v1/q/kline

Parameters:

Name Type Required Default Description
pair STRING true
interval STRING false 1m Interval enum: "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "6h", "8h", "12h", "1d", "3d", "1w"
size INT false 500 Default 500, max 1000
from LONG false
to LONG false

Response:

{
  "msg": "success",
  "code": 0,
  "data": [
    {
      "t": 1536636600, //时间
      "c": 990.0, //收盘价
      "o": 10.0, //开盘价
      "h": 990.0, //最高价
      "l": 10.0, //最低价
      "a": 262.25 //交易量 amount
    },
    {
      "t": 1536637500, //时间
      "c": 4990.0, //收盘价
      "o": 10.0, //开盘价
      "h": 4990.0, //最高价
      "l": 10.0, //最低价
      "a": 6165.05 //交易量 amount
    },
    {
      "t": 1536638400, //时间
      "c": 0.0, //收盘价
      "o": 0.0, //开盘价
      "h": 0.0, //最高价
      "l": 0.0, //最低价
      "a": 0.0 //交易量 amount
    }
  ]
}

Trade API

Get all unfinished order

GET /v1/u/trade/order/listUnfinished

Parameters:

Name Type Required Default Description
page INT false 1 Page number.
size INT false 10 Page size, max 100.
pair STRING true Trade pair, e.g., BTC_USDT.
direction STRING false Trade direction, BID or ASK.

Response:

{
  "code": 0,
  "data": {
    "data":[
      {
        "createdTime": 1532177952546,
        "dealAmount": 0,
        "dealAvgPrice": 0,
        "direction": "ASK",
        "frozenAmountByOrder": 10,
        "id": "2018072120591254687003222",
        "orderType": "LIMIT",
        "pair": "BKK_USDT",
        "price": 0.12,
        "status": 0,
        "totalAmount": 10,
        "updateTime": null
      }
    ],
    "pageRequest": {
      "page": 1, 
      "size": 100, 
      "orderBy": "id", 
      "asc": false
    },
    "total": 1
  },
  "msg": "success"
}

Get all finished order

GET /v1/u/trade/order/history

NOTE: Default duration is 3 days, and max duration is 7 days.

Parameters:

Name Type Required Default Description
page INT false 1 Page number.
size INT false 10 Page size, max 100.
startTime LONG false Order start time.
endTime LONG false Order finish time.
pair STRING true Trade pair, e.g., BTC_USDT.
direction STRING false Trade direction, BID or ASK.

Response:

{
  "code": 0,
  "data": {
    "data":[
      {
        "createdTime": 1532177952546,
        "dealAmount": 0,
        "dealAvgPrice": 0,
        "direction": "ASK",
        "frozenAmountByOrder": 10,
        "id": "2018072120591254687003222",
        "orderType": "LIMIT",
        "pair": "BKK_USDT",
        "price": 0.12,
        "status": 0,
        "totalAmount": 10,
        "updateTime": 1532177952546
      }
    ],
    "pageRequest": {
      "page": 1, 
      "size": 100, 
      "orderBy": "id", 
      "asc": false
    },
    "total": 1
  },
  "msg": "success"
}

Create new order

POST /v1/u/trade/order/create

Parameters:

Name Type Required Default Description
pair STRING true Trade pair, e.g., BTC_USDT.
direction STRING false Trade direction, BID or ASK.
price DECIMAL true Order price.
amount DECIMAL true Order amount.

Response:

{
  "code": 0,
  "data": "2018072120591254687003222",
  "msg": "success"
}

Cancel order

POST /v1/u/trade/order/cancel

Parameters:

Name Type Required Default Description
pair STRING true Trade pair, e.g., BTC_USDT.
orderNo STRING true Order id.

Response:

{
  "code": 0,
  "data": "2018072120591254687003222",
  "msg": "success"
}

Get unfinished order detail

GET /v1/u/trade/order/unfinished/detail

Parameters:

Name Type Required Default Description
pair STRING true Trade pair, e.g., BTC_USDT.
orderNo STRING true Order id.

Response:

{
  code: 0,
  data: {
    createdTime: 1532177952546,
    dealAmount: 0,
    dealAvgPrice: 0,
    direction: "ASK",
    frozenAmountByOrder: 10,
    id: "2018072120591254687003222",
    orderType: "LIMIT",
    pair: "BKK_USDT",
    price: 0.12,
    status: 0,
    totalAmount: 10,
    updateTime: null
  },
  msg: "success"
}

Get finished order detail

GET /v1/u/trade/order/finished/detail

Parameters:

Name Type Required Default Description
orderNo STRING true Order id.
updateTime LONG true Order update time.

Response:

{
  "code": 0,
  "data": {
    "createdTime": 1532177952546,
    "dealAmount": 0,
    "dealAvgPrice": 0,
    "direction": "ASK",
    "frozenAmountByOrder": 10,
    "id": "2018072120591254687003222",
    "orderType": "LIMIT",
    "pair": "BKK_USDT",
    "price": 0.12,
    "status": 0,
    "totalAmount": 10,
    "updateTime": null
  },
  "msg": "success"
}

Batch create new order

POST /v1/u/trade/order/batchCreate

Parameters:

Name Type Required Default Description
orders String true Order list, e.g., [{"pair":"BKK_USDT","direction":"BID","price":10,"amount":10}]

NOTE: The order quantity should be at least one, up to a maximum of 20.

Response:

{
  "code": 0,
  "data": {
    "success": 2,
    "fail": 0,
    "results": [
      "2018072120591254687003222",
      "2018072120591254687003223"
    ]
  },
  "msg": "success"
}

Wallet API

Get user account balance

GET /v1/u/wallet/balance

Parameters:

Name Type Required Default Description
coinTypes STRING false Coin type separate by ,, e.g., BTC, BTC,USDT.

Response:

{
  "code": 0,
  "data": [
    {
      "coinType": "BTC",
      "available": 1,
      "frozen": 0,
      "total": 1
    }
  ],
  "msg": "success"
}

Get user coin address

GET /v1/u/wallet/address

Parameters:

Name Type Required Default Description
coinType STRING true

Response:

{
  "code": 0,
  "data": [
    {
      "coinType": "BTC",
      "address": "0x0af7f36b8f09410f3df62c81e5846da673d4d9a9",
      "memo": null
    }
  ],
  "msg": "success"
}

Create withdraw

GET /v1/u/wallet/withdraw

Parameters:

Name Type Required Default Description
coinType STRING true
amount DECIMAL true
txAddress STRING true
memo STRING false
password STRING true

Response:

{
  "code": 0,
  "data": null,
  "msg": "success"
}

Get user deposit record

GET /v1/u/wallet/depositRecord

Parameters:

Name Type Required Default Description
coinType STRING false
from LONG false
to LONG false
page INT false 1
size INT false 10

Response:

{
  "code": 0,
  "data": {
    "data": [
      {
        "id": "2018061010003171",
        "createTime": 1532177952546,
        "coinType": "BTC",
        "fromAddress": "1FKN1DZqCm8HaTujDioRL2Aezdh7Qj7xxx",
        "toAddress": "1FKN1DZqCm8HaTujDioRL2Aezdh7Qj7xxx",
        "amount": 10,
        "status": 1,
        "hash": "7ce842de187c379abafadd64a5fe66c5c61c8a21fb04edff9532234a1dae6xxx",
        "confirmed": 30,
        "needConfirmed": 30
      }
    ],
    "pageRequest": {
      "page": 1,
      "size": 10,
      "asc": false
    },
    "total": 1
  },
  "msg": "success"
}

Get user withdraw record

GET /v1/u/wallet/withdrawRecord

Parameters:

Name Type Required Default Description
coinType STRING false
from LONG false
to LONG false
page INT false 1
size INT false 10

Response:

{
  "code": 0,
  "data": {
    "data": [
      {
        "id": "2018061010003171",
        "createTime": 1532177952546,
        "coinType": "BTC",
        "fromAddress": "1FKN1DZqCm8HaTujDioRL2Aezdh7Qj7xxx",
        "toAddress": "1FKN1DZqCm8HaTujDioRL2Aezdh7Qj7xxx",
        "amount": 10,
        "status": 1,
        "hash": "7ce842de187c379abafadd64a5fe66c5c61c8a21fb04edff9532234a1dae6xxx",
        "fee": 0.1
      }
    ],
    "pageRequest": {
      "page": 1,
      "size": 10,
      "asc": false
    },
    "total": 1
  },
  "msg": "success"
}

Web Socket API

web socket api地址:

BASE_END_POINT=wss://ws.bkex.vip

备用web socket api地址:

BASE_END_POINT=wss://ws.bkex.com

命名空间 /quotation

1.最新成交

request

[
    "quotationDealConnect",
    {
        "pair": "EOS_USDT", //交易对
    }
]

全量 response

[
    "quotationAllDeal",
    [
        {
            "pair": "EOS_USDT", //交易对
            "p": "0.0018", //价格 price
            "a": 100, //交易量 amount
            "t": 1536995479309, //时间
            "d": "S" //方向 direction
        },
        {
            "pair": "EOS_USDT", //交易对
            "p": "0.0017", //价格 price
            "a": 100, //交易量 amount
            "t": 1536995478065, //时间
            "d": "S" //方向 direction
        },
        {
            "pair": "EOS_USDT", //交易对
            "p": "0.0016", //价格 price
            "a": 100, //交易量 amount
            "t": 1536995476865, //时间
            "d": "S" //方向 direction
        }
    ]
]

增量 response

[
    "quotationListOrder",
    [
         {
            "pair": "EOS_USDT", //交易对
            "p": "0.0016", //价格 price
            "a": 100, //交易量 amount
            "t": 1536995476865, //时间
            "d": "S" //方向 direction
        }
    ]
]

d：主动成交方向，S：卖单成交，B：买单成交

2.深度

request

[
    "quotationOrderConnect",
    {
        "pair": "EOS_USDT", //交易对
        "number": 50
    }
]

全量 response

[
    "quotationAllOrder",
    [
        {
            "pair": "EOS_USDT", //交易对
            "p": "3521.0000", //价格 price
            "a": 1.0000, //交易量 amount
            "v": 3521.0000, //交易额 volume
            "d": "BID" //方向 direction
        },
        {
            "pair": "EOS_USDT", //交易对
            "p": "3515.0000", //价格 price
            "a": 1.0000, //交易量 amount
            "v": 3515.0000, //交易额 volume
            "d": "BID" //方向 direction
        },
        {
            "pair": "EOS_USDT", //交易对
            "p": "4337.0000", //价格 price
            "a": 1.0000, //交易量 amount
            "v": 3337.0000, //交易额 volume
            "d": "ASK" //方向 direction
        }
    ]
]

增量 response

[
    "quotationListOrder",
    [
        {
            "pair": "EOS_USDT", //交易对
            "p": "140.0000", //价格 price
            "a": -1.000000000000000000, //交易量 amount
            "v": -140.0000000000000000000000, //交易额 volume
            "d": "BID" //方向 direction
        }
    ]
]

D：委托方向，S：卖单，B：买单

24 小时行情

request

[
    "qAllConnect",{pair:"*"}
]

response

[
    "qPairsStats",
    [
        {pair: "BKK_USDT", o: 0.0698, c: 0.0712, h: 0.0734, l: 0.0694, a: 30079476.0691, r: 2}
	...
	...
	...
	{pair: "BEAM_USDT", o: 0.78, c: 0.804, h: 0.849, l: 0.773, a: 6649.3042, r: 3.07}
     ]
]

K 线

request

[
    "quotationConnect",
    {
        "pair": "EOS_USDT", //trading pair
        "type": "15", //time interval
        "from": 1536142476, //start time
        "to": 1537006536, //end time
        "no": "153700647609762483" //unique key
    }
]

类型包含 ’1’, '5', '15', '30', '60', '240', '360', '720', '1D', '1W’， 数字代表分钟, 1D代表：1天, 1W 代表：1周

全量

response

[
    "qPairsAllKLine",
    {
        "no": "153700647609762483",
        "list": [
            {
                "t": 1536636600, //time
                "c": 990.0, //closing price
                "o": 10.0, //opening price
                "h": 990.0, //the highest price
                "l": 10.0, //the lowest price
                "a": 262.25 //trading amount
            },
            {
                "t": 1536637500, //time
                "c": 4990.0, //closing price
                "o": 10.0, //opening price
                "h": 4990.0, //the highest price
                "l": 10.0, //the lowest price
                "a": 6165.05 //trading amount
            },
            {
                "t": 1536638400, //time
                "c": 0.0, //closing price
                "o": 0.0, //opening price
                "h": 0.0, //the highest price
                "l": 0.0, //the lowest price
                "a": 0.0 //trading amount
            }
        ]
    }
]

增量

response

[
    "qPairsKLine",
    {
        "t": 1537005600, //time
        "c": 0.0018, //closing price
        "o": 0.0018, //opening price
        "h": 0.0018, //the highest price
        "l": 0.0018, //the lowest price
        "a": 0.0, //trading amount
    }
]

Socket.io Demo(Recommended)

Socket.io Official Website: https://socket.io/

  var io = require('socket.io-client'); //@1.3.6
  //<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/1.3.6/socket.io.min.js"></script>

  var socket = io('wss://ws.bkex.com/quotation', { transports: ['websocket'] });
  
  socket.on('connect', function (data) {
    socket.emit('qAllConnect'); //get 24h change
  });

Native WebScoket Demo

    var pingPong = null;
    ws = new WebSocket("wss://ws.bkex.com/socket.io/?EIO=3&transport=websocket");
    ws.onopen = function() {
      pingPong = setInterval(function () { //stay linked with server end ping pong 
        ws.send('2');
      }, 20 * 1000)

    };
    ws.onmessage = function(e) {
        
        if(e.data === '40') { //connected successfully
          ws.send('40/quotation')
        }

        else if(e.data === '40/quotation') { //entered into name space successfully
          ws.send('42/quotation,["quotationConnect",{"pair": "EOS_USDT","type": "15","from": 1536142476,"to": 1537865828,"no": "153700647609762483"}]')
        } 
        
        else { //other info
          
        }
    };

About

BKEX API document.

Languages

Language:Python 100.0%