前言
Kucoin 是一家数字货币交易所,提供了开放的 API 接口供开发者使用。kucoin-v1 是对其 API 接口进行封装的 npm 包,可帮助开发者快速并简单地使用 API。
在本文中,我们将会详细介绍 kucoin-v1 的使用方法。
注:在本文中,我们默认已经安装了 Node.js 环境和 npm 包管理器。
安装 kucoin-v1
在项目中使用 kucoin-v1,需要将其作为一个依赖包安装。使用 npm 安装 kucoin-v1 的命令如下:
npm i kucoin-v1 --save
这里我们使用了 --save 选项,将 kucoin-v1 依赖包保存到项目的 package.json 文件中。这样可以避免在部署项目时遗漏依赖包。
使用 kucoin-v1
首先,我们需要引入 kucoin-v1 并创建一个 API 对象,用于调用相关的 API 接口:
var kucoinAPI = require('kucoin-v1'); var api = new kucoinAPI({ apiKey: '<your-api-key>', secretKey: '<your-secret-key>', environment: 'live' //环境有 dev 和 live 两种选择 });
在调用 API 接口时,我们需要使用自己的 API Key 和 Secret Key。可以在 Kucoin 的用户中心中创建自己的 API Key 和 Secret Key。
API 接口
API 接口是 kucoin-v1 中最重要的部分,它们通过发送请求并返回相应的数据来完成相应的操作。
获取市场 Ticker 信息
使用 ticker
方法来获取市场 Ticker 信息:
api.getTicker({pair: 'ETH-BTC'}, function(err, ticker) { console.log(ticker); });
其中,pair
参数为交易对名称,比如 ETH-BTC
。回调函数中的 ticker
参数为返回的市场信息。
获取市场深度信息
使用 depth
方法来获取市场深度信息:
api.getDepth({pair: 'ETH-BTC', type: 'full'}, function(err, depth) { console.log(depth); });
其中,pair
参数为交易对名称,type
参数为信息类型,比如 full
。回调函数中的 depth
参数为返回的市场深度信息。
创建订单
使用 createOrder
方法来创建新的订单:
api.createOrder({ pair: 'ETH-BTC', type: 'BUY', price: 0.001, amount: 1 }, function(err, order) { console.log(order); });
其中,pair
参数为交易对名称,type
参数为交易类型,price
参数为单价,amount
参数为数量。回调函数中的 order
参数为返回的新订单信息。
获取订单列表
使用 getOrderList
方法来获取当前用户的订单列表:
api.getOrderList({status: 'done'}, function(err, orders) { console.log(orders); });
其中,status
参数为订单状态,比如 done
。回调函数中的 orders
参数为返回的订单列表信息。
撤销订单
使用 cancelOrder
方法来撤销订单:
api.cancelOrder({ orderId: '5c15c2e99d8ce9086e0b11c1' }, function(err, order) { console.log(order); });
其中,orderId
参数为订单 ID。回调函数中的 order
参数为返回的被撤销的订单信息。
结语
以上就是 kucoin-v1 的使用方法介绍了。如果您想要了解更多关于 API 接口的细节,请访问 Kucoin 官方 API 文档。
kucoin-v1 能够大大方便开发者进行基于 Kucoin 的交易应用程序的开发。希望本文对于您的学习和指导有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f84238a385564ab6c18