eBTCbank——专业的数字资产交易平台
首頁 > 下載中心 > API

API

發佈時間:2017-10-27 14:59:56 發佈人:eBTCbank——专业的数字资产交易平台

API文档

一、说明

1、API服务器路径

2、请求过程说明

3、安全认证

二、接口

1、获取当前最新行情 — ticker

2、市场深度 — depth

3、市场交易 — orders

4、获取用户的订单 — orders_info_by_status

5、获取用户成交的订单 — user_trade

6、下单交易 — trade

7、批量下单 — batch_trade

8、撤销订单 — cancel_order

9、根据id获取用户的订单 — order_info

10、批量获取用户的订单 — orders_info

11、转出虚拟币 — withdraw

三.代码状态对照表

API使用说明

一、

1、API服务器路径

     m.ebtcbank.me m.ebtcbank.com

2、请求过程说明     

     用户提交的参数除sign外,都要参与签名。首先,将待签名字符串要求按照参数名进行排序(首先比较所有参数名的第一个字母,按abcd顺序排列,若遇到相同首字母,则看第二个字母,以此类推)。 例如:对于如下的参数进行签名 

array(       

       api_key => "SAFSFASDF234RFFQ2D",       

       price => 0.1,       

       amount => 100,       

       symbol =>"eth_btc",       

       tradeType => 1 

);

生成待签名的字符串

amount=100&api_key=SAFSFASDF234RFFQ2D&price=0.1&symbol=eth_btc&tradeType=1

然后,将待签名字符串添加私钥参数生成最终待签名字符串。

例如:

amount=100&api_key=SAFSFASDF234RFFQ2D&price=0.1&symbol=eth_btc&tradeType=1&secret_key=secretKey

注意, "&secret_key=secretKey"为签名必传参数。

最后,是利用32MD5算法,对最终待签名字符串进行签名运算,从而得到签名结果字符串(该字符串赋值于参数sign),MD5计算结果中字母全部大写。

3、安全认证

     所有的private API都需要经过认证

     Api的申请可以到安全中心 -> API,申请得到私钥和公钥,私钥EBTCbank将不做储存,如遗失请用认证手机来重置API!

     注意:请勿向任何人泄露这两个参数,这像您的密码一样重要

接口

二、

1、获取当前最新行情 — ticker

     Path:/api/ticker/

     Request类型:GET

    1.1、请求参数

            参数名         参数类型         必填                                                           描述
           symbol            String             否(默认eth_btc)                  eth_btc:以太坊    ltc_btc :莱特币    tv_btc :钛值  

    1.2、返回值说明

           market: 交易市场

         date:返回数据时服务器时间

         buy: 买一价

         high: 最高价

         last: 最新成交价

         low: 最低价

         sell: 卖一价

         vol: 成交量

         code:状态码

     1.3、返回结果示例

          {

              "market": "eth_btc",

              "date": 1508739998,

              "ticker": {

                        "buy": "0.04760000",

                        "high": "0.05070000",

                        "last": "0.04880000",

                        "low": "0.04840000",

                        "sell": "0.04880000",

                        "vol": "4.34400000"

                      },

                "code": 200

            }

2、市场深度 — depth

      描述:返回所有的市场深度,此回应的数据量会较大,所以请勿频繁调用。

     Path:/api/ticker/

     Request类型:GET

    2.1、请求参数

              参数名         参数类型            必填                                         描述

             symbol          String                                     eth_btc:以太坊    ltc_btc :莱特币    tv_btc :钛值   

              size             Integer         (默认200)

    2.2、返回值说明

                asks : 卖方深度

            bids :买方深度

     2.3、返回结果示例

               {

                 "asks": "[[0.25000000,0.25000000],[0.22000000,13.33790000],[0.08999800,0.03410400],[0.07900000,0.40000000],[0.07780000,0.40000000],[0.07770000,1.00000000],[0.07700000,0.30000000],[0.07620000,0.58000000],    [0.07600000,0.50000000],[0.07580000,1.02000000],[0.07500000,0.03800000],[0.07470000,1.03350000],[0.07460000,0.11140000],[0.05880000,9.57290000],[0.05140000,0.51600000]]",

    "bids": "[[0.04500000,1.00000000],[0.04000000,1.00000000],[0.03800000,2.00000000],[0.03500000,1.28000000],[0.03200000,2.60000000],[0.03000000,0.05970000],[0.02800000,0.60000000],[0.02500000,0.80000000],[0.01800000,3.00000000],[0.01000000,0.49989900]]"

}

3、市场交易 — orders

      描述:获取用户资产。

     Path:/api/userinfo

     Request类型:POST

    3.1、请求参数

              参数名         参数类型             必填                    描述

              api_key         String                  是              用户申请的api_key

                sign            String                  是               请求参数的签名

                coin            String                  否               用户查看余额的币种,默认btc,eth,ltc

    3.2、返回值说明

           result: 返回状态
           asset:账户可用余额
           freezed: 账户冻结余额
           code:状态码
     3.3、返回结果示例

           {
             "result": "true",
             "asset": {
             "btc": "0.14600000",
             "eth": "0.05780000",
             "ltc": "0.15780000",
                 },
             "freezed": {
             "btc": "0.04790000",
             "eth": "0.48770000",
             "ltc": "0.35480000",
                },
             "code": 200
     }
4、获取用户的订单 — orders_info_by_status

      Path:/api/orders_info_by_status

      Request类型:POST

     4.1、请求参数

           参数名       参数类型     必填              描述
           api_key        String          是        用户申请的apiKey
            sign           String          是        请求参数的签名
           status          String          否        用户订单状态,默认0

          symbol        String         是        交易市场
     4.2、返回值说明

           result: 返回状态
           amount :交易数量
           create_date: 订单生成时间
           deal_amount:已交易量
           order_id: 订单id
           price:交易价格
           fee: 交易手续费
           type:1买/2卖
           status: 订单状态(0:正在进行,1:已成交,2:已撤回)
           code:状态码
     4.3、返回结果示例

             {
                 "result": "true",
                 "orders": {
                 "amount": "100",
                 "create_date": "1508739998",
                 "deal_amount": "57",
                 "order_id": "1024",
                 "price": "0.05780000",
                 "fee": "0.00058000",
                 "type": "1",
                 "status": "0",
                             },
                 "code": 200
            }

5、获取用户成交的订单 — user_trade

     Path:/api/user_trade

     Request类型:POST

    5.1、请求参数

             参数名         参数类型       必填            描述
             api_key           String          是        用户申请的apiKey
             sign                String           是        请求参数的签名
             tradeType        String          是        用户成交的订单类型,1买/2卖
             times               String          否       返回时间戳以后的订单,默认0
     5.2、返回值说明

             result:返回状态
             id: 订单id
             userid :买方id
             peerid: 卖方id
             num:交易数量
             market: 交易市场
             price:交易价格
             type:1买/2卖
             addtime: 成交时间
             code:状态码

      5.3、返回结果示例
              {
                  "result": "true",
                  "orders": {
                  "id": "1475",
                  "userid": "14204",
                  "peerid": "12470",
                  "num": "10",
                  "market": "1024",
                  "price": "0.05780000",
                             "type": "1",
                  "addtime": "1508739998",
                 },
            "code": 200
           }

6、下单交易 — trade

     Path:/api/trade

     Request类型:POST

    6.1、请求参数

            参数名           参数类型              必填                          描述
            api_key            String                 是                       用户申请的apiKey
            sign                 String                 是                       请求参数的签名
            price                Double               是                       交易价格
            amount            Double               是                       交易数量
            symbol             String                是           eth_btc:以太坊    ltc_btc :莱特币    tv_btc :钛值    
            tradeType         String                是                  用户成交的订单类型,1买/2卖
    6.2、返回值说明

             result:返回状态
             id: 订单id
             code:状态码
     6.3、返回结果示例

              {
                   "result": "true",
                   "id": "1475",
                   "code": 200
              }
7、批量下单 — batch_trade

     Path:/api/trade

     Request类型:POST

    7.1、请求参数

              参数名                  参数类型                                必填                  描述
             api_key                    String                                    是            用户申请的apiKey
             sign                         String                                    是            请求参数的签名
             orders_data               String(格式                           是            price、amount和type参数参考trade接口中的说明
                                               [{'price':3,'amount':5,'type':1,'symbol':'eth_btc'},
                                               {'price':3,'amount':3,'type':1,'symbol':'eth_btc'}] )
    7.2、返回值说明

             success:成功订单id
             order_info: 订单id信息
             code:状态码
     7.3、返回结果示例

              {
                    "result": "true",
                     "order_info": "{order_id:1564},{order_id:1565},{order_id:-1,code:1019}",
                     "code":200
              }
     7.4、备注

              只要其中任何一单下单成功就返回true
              返回的订单信息和orders_data上传的订单顺序一致
              如果下单失败:order_id为-1,code为错误代码

8、撤销订单 — cancel_order

      Path:/api/cancel_order

      Request类型:POST

    8.1、请求参数

             参数名            参数类型           必填              描述
             api_key           String                 是          用户申请的apiKey
             sign                String                 是          请求参数的签名
             order_id          String                 是          订单id(多个订单ID中间以","分隔)

    8.2、返回值说明

             success:成功订单id
             error: 失败订单id

     8.3、返回结果示例
              {
                     "success": "1564,1454",
                     "error": "1248,1472",
               }
9、根据id获取用户的订单 — order_info

      Path:/api/order_info

      Request类型:POST

      9.1、请求参数

            参数名            参数类型         必填             描述
             api_key             String            是          用户申请的apiKey
             sign                  String            是          请求参数的签名
             order_id            String            否          用户订单id
      9.2、返回值说明

             result: 返回状态
             amount :交易数量
             create_date: 订单生成时间
             deal_amount:已交易量
             order_id: 订单id
             price:交易价格
             fee: 交易手续费
             type:1买/2卖
             status: 订单状态(0:正在进行,1:已成交,2:已撤回)
             code:状态码
       9.3、返回结果示例

               {
                      "result": "true",
                      "orders": {
                               "amount": "100",
                               "create_date": "1508739998",
                               "deal_amount": "57",
                               "order_id": "1024",
                               "price": "0.05780000",
                               "fee": "0.00058000",
                               "type": "1",
                               "status": "0",
                                   },
                       "code": 200
                }
10、批量获取用户的订单 — orders_info

      Path: /api/orders_info

      Request类型:POST

     10.1、请求参数

                参数名           参数类型        必填            描述
                 api_key           String             是         用户申请的apiKey
                 sign                String             是         请求参数的签名
                 order_id          String             否         用户订单id,用","隔开
     10.2、返回值说明

                result: 返回状态
                amount :交易数量
                create_date: 订单生成时间
                deal_amount:已交易量
                order_id: 订单id
                price:交易价格
                fee: 交易手续费
                type:1买/2卖
                status: 订单状态(0:正在进行,1:已成交,2:已撤回)
                code:状态码

      10.3、返回结果示例
                   {
                        "result": "true",
                        "orders": [{
                                         "amount": "100",
                                         "create_date": "1508739998",
                                         "deal_amount": "57",
                                         "order_id": "1024",
                                         "price": "0.05780000",
                                         "fee": "0.00058000",
                                         "type": "1",
                                         "status": "0",
                          },
                         {
                                        "amount": "105",
                                        "create_date": "150874889",
                                        "deal_amount": "0",
                                        "order_id": "1044",
                                        "price": "0.05980000",
                                        "fee": "0.00059000",
                                        "type": "1",
                                        "status": "0",
                          }
                          ],
                          "code": 200
                    }
11、转出虚拟币 — withdraw

      Path: /api/withdraw

      Request类型:POST

     11.1、请求参数

               参数名                   参数类型       必填                   描述
                 api_key                    String          是           用户申请的apiKey
                 sign                         String          是           请求参数的签名
                 symbol                     String          是           btc 比特币 eth 以太坊 ltc 莱特币
                 withdraw_amount     String           是           提币数量
                 target                      String           是           转出钱包地址
                 trade_pwd                String          是            交易密码
                 chargefee                 String          是          网络手续费(手续费越高,网络确认越快)
     11.2、返回值说明

                result:返回状态
                info:返回说明
                code: 状态码
      11.3、返回结果示例

                 {
                      "result": "true"
                      "info": "Successful transfer",
                      "code": 200,
                   }

三.代码状态对照表



X
ebtcbank
浏览行情酣畅交易指尖掌握