Index Ticker

URL: https://api.bqi.com/api/public/ticker
Parameter: group, Required, Value 0, 20, 100, 500

Notes:
group: 0=all, 20=bqi20 

  1. curl "https://api.bqi.com/api/public/ticker?group=0"  
  2. response:
  3. {
  4.     "Group": 0,
  5.     "Data": {
  6.         "Last": 101.61,              //last index
  7.         "High24H": 102.87,           //24hour high index, Rolling granularity 5 minutes
  8.         "Low24H": 100.68,            //24hour low index, Rolling granularity 5 minutes
  9.         "Change24H": -0.49,          //24hour change index, Rolling granularity 5 minutes
  10.         "ChangeRate24H": -0.48,      //24hour change rate, Rolling granularity 5 minutes
  11.         "Time": 1577322393           //timestamp (seconds)
  12.     },
  13.     "Code": 200,        //200 on success
  14.     "Message": ""       //error cause
  15. }

Index Tickers

URL: https://api.bqi.com/api/public/tickers

  1. curl "https://api.bqi.com/api/public/tickers"
  2. response:
  3. {
  4.     "Data": [{
  5.         "Group": 0,                      //index group
  6.         "Last": 101.57,                  //last index
  7.         "High24H": 102.87,               //24hour high index, Rolling granularity 5 minutes
  8.         "Low24H": 100.68,                //24hour low index, Rolling granularity 5 minutes
  9.         "Change24H": -0.57,              //24hour change index, Rolling granularity 5 minutes
  10.         "ChangeRate24H": -0.55,          //24hour change rate, Rolling granularity 5 minutes
  11.         "Time": 1577322994               //timestamp (seconds)
  12.     }, {
  13.         "Group": 20,
  14.         "Last": 101.21,
  15.         "High24H": 102.4,
  16.         "Low24H": 100.36,
  17.         "Change24H": -0.47,
  18.         "ChangeRate24H": -0.46,
  19.         "Time": 1577322994
  20.     }, {
  21.         "Group": 100,
  22.         "Last": 78.46,
  23.         "High24H": 126.04,
  24.         "Low24H": 77.54,
  25.         "Change24H": -23.68,
  26.         "ChangeRate24H": -23.18,
  27.         "Time": 1577322994
  28.     }, {
  29.         "Group": 500,
  30.         "Last": 104.1,
  31.         "High24H": 104.82,
  32.         "Low24H": 101.45,
  33.         "Change24H": 2.3,
  34.         "ChangeRate24H": 2.26,
  35.         "Time": 1577322994
  36.     }],
  37.     "Code": 200,        //200 on success
  38.     "Message": ""       //error cause
  39. }

Index Kline

URL: https://api.bqi.com/api/public/kline
Parameter: group, Required, Value 0, 20, 100, 500
Parameter: granularity, Required, Value 60, 180, 300, 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400, 604800
Parameter: begin, Optional, BeginTime(Timestamp seconds)
Parameter: end, Optional, EndTime(Timestamp seconds)
Parameter: size, Optional, Result size(Max 2000)

Notes:
group: 0=all, 20=bqi20
granularity: 1Minute, 3Minute, 5Minute, 15Minute, 30Minute, 1Hour, 2Hour, 4Hour, 6Hour, 12Hour, 1Day, 1Week 

  1. curl "https://api.bqi.com/api/public/kline?group=0&granularity=60"  
  2. response:
  3. {
  4.     "Group": 0,
  5.     "Granularity": 60,
  6.     "Data": [
  7.         // Format [timestamp (seconds), open, high, low, close]
  8.         [1577202900, 102.78, 102.79, 102.78, 102.79],
  9.         [1577202960, 102.77, 102.77, 102.7, 102.7],
  10.         [1577323680, 101.6, 101.6, 101.6, 101.6]
  11.     ],
  12.     "Code": 200,        //200 on success
  13.     "Message": ""       //error cause
  14. }

Index Group Members

URL: https://api.bqi.com/api/public/members
Parameter: group, Required, Value 0, 20, 100, 500
Parameter: lang, Optional, Value en-us, zh-cn
Parameter: size, Optional, Result size

Notes:
group: 0=all, 20=bqi20
Sort results by market cap 

  1. curl "https://api.bqi.com/api/public/members?group=0"
  2. response:
  3. {
  4.     "Group": 0,
  5.     "Data": [{
  6.         "CoinCode": "bitcoin",            //coin code
  7.         "CoinName": "Bitcoin",            //coin name
  8.         "CoinSymbol": "BTC",              //coin symbol
  9.         "NativeName": "Bitcoin",          //coin native name
  10.         "MaxSupply": 21000000,            //max supply
  11.         "TotalSupply": 17901187,          //current total supply
  12.         "CirculatingSupply": 17901187,    //circulating supply
  13.         "MarketCap": 128903549134,        //market cap
  14.         "Volume": 6449145269.4336,        //volume
  15.         "LastPrice": 7200.838086,         //last price
  16.         "HighPrice24H": 7269.954023,      //24hour high price
  17.         "LowPrice24H": 7142.958062,       //24hour low price
  18.         "ChangePrice24H": -36.675691,     //24hour change price
  19.         "ChangePriceRate24H": -0.51,      //24hour change rate
  20.         "Time": 1577324733                //timestamp (seconds)
  21.     }, {
  22.         "CoinCode": "ethereum",
  23.         "CoinName": "Ethereum",
  24.         "CoinSymbol": "ETH",
  25.         "NativeName": "Ethereum",
  26.         "MaxSupply": 107100935,
  27.         "TotalSupply": 107100935,
  28.         "CirculatingSupply": 107100935,
  29.         "MarketCap": 13385208818,
  30.         "Volume": 2313965685.4661,
  31.         "LastPrice": 124.977516,
  32.         "HighPrice24H": 126.500768,
  33.         "LowPrice24H": 123.988757,
  34.         "ChangePrice24H": -1.283036,
  35.         "ChangePriceRate24H": -1.02,
  36.         "Time": 1577324733
  37.     }],
  38.     "Code": 200,
  39.     "Message": ""
  40. }

WebSocket API

WebSocket Server URL:
wss://api.bqi.com/ws/public

Notes:
Sending and receiving data requires gzip library
gzip library: https://github.com/imaya/zlib.js.git

  1. <!DOCTYPE html>
  2. <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4.     <meta charset="utf-8" />
  5.     <title>WebSocket Demo</title>
  6. </head>
  7. <body>
  9.     <script src="gzip.min.js"></script>
  10.     <script src="gunzip.min.js"></script>
  12.     <script>
  14.         var WebSocketAPI = function (onopen) {
  16.             var obj = {};
  17.             var sock = null;
  18.             var dispose_func = null;
  19.             var timer = null;
  21.             var kline_queue = new Array();
  22.             var ticker_queue = new Array();
  23.             var cointicker_queue = new Array();
  25.             obj.onkline = function (data) { };
  26.             obj.onticker = function (data) { };
  27.             obj.oncointicker = function (data) { };
  29.             var gzip_compress = function (data) {
  30.                 var plain = new TextEncoder().encode(data);
  31.                 var gzip = new Zlib.Gzip(plain);
  32.                 var compressed = gzip.compress();
  33.                 return compressed;
  34.             };
  36.             var gzip_decompress = function (data) {
  37.                 var gunzip = new Zlib.Gunzip(data);
  38.                 var plain = gunzip.decompress();
  39.                 return new TextDecoder().decode(plain);
  40.             };
  42.             var init = function () {
  44.                 var isclose = false;
  45.                 sock = new WebSocket('wss://api.bqi.com/ws/public');
  47.                 sock.onopen = function () {
  49.                     sock.onmessage = function (ev) {
  50.                         ev.data.arrayBuffer().then(function (buffer) {
  52.                             if (null === sock) {
  53.                                 return;
  54.                             }
  56.                             try {
  58.                                 var data = gzip_decompress(new Uint8Array(buffer));
  59.                                 data = JSON.parse(data);
  61.                                 if (data.Type === "response") {
  63.                                     if (data.Action === 'ticker') {
  64.                                         var item = ticker_queue.shift();
  65.                                         item.Callback(null, data);
  66.                                     }
  67.                                     else if (data.Action === 'kline') {
  68.                                         var item = kline_queue.shift();
  69.                                         item.Callback(null, data);
  70.                                     }
  71.                                     else if (data.Action === 'coin-ticker') {
  72.                                         var item = cointicker_queue.shift();
  73.                                         item.Callback(null, data);
  74.                                     }
  75.                                 }
  76.                                 else if (data.Type === "event") {
  78.                                     if (data.Action === 'ticker') {
  79.                                         obj.onticker(data);
  80.                                     }
  81.                                     else if (data.Action === 'kline') {
  82.                                         obj.onkline(data);
  83.                                     }
  84.                                     else if (data.Action === 'coin-ticker') {
  85.                                         obj.oncointicker(data);
  86.                                     }
  87.                                 }
  88.                             }
  89.                             catch (e) {
  90.                                 sock.close();
  91.                             }
  93.                         });
  94.                     };
  96.                     var clear = function (ev) {
  97.                         while (kline_queue.length > 0) {
  98.                             var item = kline_queue.shift();
  99.                             item.Callback(new Error("code: " + ev.code + ", reason: " + ev.reason), null);
  100.                         }
  101.                         while (ticker_queue.length > 0) {
  102.                             var item = ticker_queue.shift();
  103.                             item.Callback(new Error("code: " + ev.code + ", reason: " + ev.reason), null);
  104.                         }
  105.                         while (cointicker_queue.length > 0) {
  106.                             var item = cointicker_queue.shift();
  107.                             item.Callback(new Error("code: " + ev.code + ", reason: " + ev.reason), null);
  108.                         }
  109.                         sock = null;
  110.                     };
  112.                     sock.onclose = function (ev) {
  113.                         if (false == isclose) {
  114.                             isclose = true;
  115.                             clear(ev);
  116.                             if (null === dispose_func) {
  117.                                 if (null !== timer) clearTimeout(timer);
  118.                                 timer = setTimeout(init, 1000);
  119.                             }
  120.                             else {
  121.                                 dispose_func();
  122.                             }
  123.                         }
  124.                     };
  126.                     sock.onerror = function (ev) {
  127.                         if (false == isclose) {
  128.                             isclose = true;
  129.                             clear(ev);
  130.                             if (null === dispose_func) {
  131.                                 if (null !== timer) clearTimeout(timer);
  132.                                 timer = setTimeout(init, 1000);
  133.                             }
  134.                             else {
  135.                                 dispose_func();
  136.                             }
  137.                         }
  138.                     };
  140.                     onopen();
  141.                 };
  142.             };
  144.             // Index Ticker
  145.             // group = 0, 20, 100, 500
  146.             // enable = true | false
  147.             // func = (err,data) =>{}
  148.             obj.ticker = function (group, enable, func) {
  149.                 ticker_queue.push({
  150.                     Action: 'ticker', Group: group, Enable: enable,
  151.                     Callback: func
  152.                 });
  153.                 sock.send(gzip_compress(JSON.stringify({
  154.                     Action: 'ticker', Group: group, Enable: enable
  155.                 })));
  156.             };
  158.             // Index Kline
  159.             // group = 0, 20, 100, 500
  160.             // granularity = 60, 180, 300, 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400, 604800
  161.             // enable = true | false
  162.             // func = (err,data) =>{}
  163.             obj.kline = function (group, granularity, enable, func) {
  164.                 kline_queue.push({
  165.                     Action: 'kline', Group: group, Granularity: granularity, Enable: enable,
  166.                     Callback: func
  167.                 });
  168.                 sock.send(gzip_compress(JSON.stringify({
  169.                     Action: 'kline', Group: group, Granularity: granularity, Enable: enable
  170.                 })));
  171.             };
  173.             // Coin Ticker
  174.             // coincode = bitcoin,....
  175.             // enable = true | false
  176.             // func = (err,data) =>{}
  177.             obj.cointicker = function (coincode, enable, func) {
  178.                 cointicker_queue.push({
  179.                     Action: 'coin-ticker', CoinCode: coincode, Enable: enable,
  180.                     Callback: func
  181.                 });
  182.                 sock.send(gzip_compress(JSON.stringify({
  183.                     Action: 'coin-ticker', CoinCode: coincode, Enable: enable
  184.                 })));
  185.             };
  187.             // dispose
  188.             // func = () =>{}
  189.             obj.dispose = function (func) {
  191.                 if (null !== sock) {
  192.                     if (WebSocket.CONNECTING === sock.readyState) {
  193.                         sock.close();
  194.                         sock = null;
  195.                         func();
  196.                     }
  197.                     else {
  198.                         dispose_func = func;
  199.                         sock.close();
  200.                     }
  201.                 }
  202.                 else if (null !== timer) {
  203.                     clearTimeout(timer);
  204.                     timer = null;
  205.                     func();
  206.                 }
  207.                 else {
  208.                     func();
  209.                 }
  210.             };
  212.             init();
  214.             return obj;
  215.         };
  217.     </script>
  219.     <script>
  221.         // example
  222.         // disconnection will automatically reconnect
  223.         var api = new WebSocketAPI(function () {
  225.             // Receive event
  226.             api.onticker = function (data) {
  227.                 console.log(data);
  228.             };
  230.             api.onkline = function (data) {
  231.                 console.log(data);
  232.             };
  234.             api.oncointicker = function (data) {
  235.                 console.log(data);
  236.             };
  239.             // API
  240.             api.ticker(20, true, function (err, data) {
  241.                 console.log(data);
  242.             });
  244.             api.ticker(100, true, function (err, data) {
  245.                 console.log(data);
  246.             });
  248.             api.kline(20, 300, true, function (err, data) {
  249.                 console.log(data);
  250.             });
  252.             api.kline(20, 900, true, function (err, data) {
  253.                 console.log(data);
  254.             });
  256.             api.cointicker('bitcoin', true, function (err, data) {
  257.                 console.log(data);
  258.             });
  260.             api.cointicker('ethereum', true, function (err, data) {
  261.                 console.log(data);
  262.             });
  264.             api.cointicker('eos', true, function (err, data) {
  265.                 console.log(data);
  266.             });
  268.             api.cointicker('eos', false, function (err, data) {
  269.                 console.log(data);
  270.             });
  273.             //dispose 
  274.             /*api.dispose(function () {
  275.                 console.log("close");
  276.             });*/
  277.         });
  279.     </script>
  281. </body>
  282. </html>