简介
btccapi-tinycalf 是一个 npm 包,提供了 Bitcoin 交易所 BTCC 的 API 封装,方便开发者使用。本文将详细介绍 btccapi-tinycalf 的使用方法,包括 API 的调用、代码示例等。
安装
在项目根目录下,通过 npm 安装 btccapi-tinycalf:
npm i btccapi-tinycalf
使用
btccapi-tinycalf 提供了 BTCC API 的封装,具体的使用方法如下:
-- -------------------- ---- ------- ----- ------- - ---------------------------- -- -- ------- -- ----- --- - --- --------- ---------- ----------------------- ----------- ----------------------- --- -- -- --- -------------------------------- -- - ----------------- ------------ -- - ------------------- ---
在上述代码中,我们首先引入了 btccapi-tinycalf 模块,并创建了一个 BtccApi 的实例,用于调用 BTCC API。其中,publicKey
和 privateKey
为 BTCC 的 API 访问密钥,需要用户自行申请。
接着,我们调用了 getTicker
方法,获取指定币种的行情信息,这是 BTCC API 中的一个常用方法。最终,我们打印了返回的结果,或者输出错误信息。
API 文档
btccapi-tinycalf 封装了 BTCC API 的所有方法,以下为该库的 API 列表。
constructor(opts:Object)
创建 BtccApi 实例的构造函数,接受一个包含 publicKey
和 privateKey
属性的对象,用于进行 API 认证。
getTicker(symbol:String):Promise<any>
获取指定币种的实时行情信息,返回 Promise 对象。
getDepth(symbol:String, size:Number = 10):Promise<any>
获取指定币种的市场深度信息,返回 Promise 对象。size
参数指定返回的数据数量,默认为 10。
getTrades(symbol:String, sinceId:String = ''):Promise<any>
获取指定币种的最近交易记录,返回 Promise 对象。sinceId
参数指定起始的交易 ID,默认为空,即从最新交易记录开始。
getKlines(symbol:String, type:String, size:Number = 150, since:Number = 0):Promise<any>
获取指定币种的 K 线图数据,返回 Promise 对象。type
参数指定 K 线图类型,如 1min
、5min
等,size
参数指定返回的条目数量,默认为 150 条,since
参数指定起始时间戳,默认为 0,即从最早时间开始。
getUserInfo():Promise<any>
获取用户账户信息,返回 Promise 对象。
getOrderInfo(orderId:String):Promise<any>
获取指定订单的详细信息,返回 Promise 对象。
placeLimitOrder(symbol:String, price:Number, amount:Number, side:'buy'|'sell'):Promise<any>
以限价单的方式下单,返回 Promise 对象。price
参数指定下单价格,amount
参数指定下单数量,side
参数指定买入或卖出。
placeMarketOrder(symbol:String, amount:Number, side:'buy'|'sell'):Promise<any>
以市价单的方式下单,返回 Promise 对象。amount
参数指定下单数量,side
参数指定买入或卖出。
cancelOrder(orderId:String):Promise<any>
取消指定订单,返回 Promise 对象。
getOrders(symbol:String, status:'open'|'closed' = 'open', limit:Number = 50):Promise<any>
获取用户的订单列表,返回 Promise 对象。status
参数指定订单状态,limit
参数指定返回的订单数量,默认为 50 条。
示例代码
以下是一些调用 btccapi-tinycalf 的示例代码。
- 获取比特币行情信息:
-- -------------------- ---- ------- ----- --- - --- --------- ---------- ----------------------- ----------- ----------------------- --- -------------------------------- -- - ----------------- ------------ -- - ------------------- ---
- 以限价单的方式下单:
-- -------------------- ---- ------- ----- --- - --- --------- ---------- ----------------------- ----------- ----------------------- --- ----------------------------- ------ -- --------------- -- - ----------------- ------------ -- - ------------------- ---
- 获取用户的订单列表:
-- -------------------- ---- ------- ----- --- - --- --------- ---------- ----------------------- ----------- ----------------------- --- ----------------------- ------- ------------ -- - ----------------- ------------ -- - ------------------- ---
学习与指导
本文介绍了 BTCC API 的 npm 包 btccapi-tinycalf 的使用方法,涉及 API 的调用、参数、返回值等方面。读者可以通过本文学习 btccapi-tinycalf 的使用用法,以及如何进行比特币交易开发。
同时,本文所介绍的 BTCC API 也可以作为其他交易所 API 的参考,可以使用类似的封装方法进行其它交易所接口的开发。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005605181e8991b448de79b