简介
kraken-api-universal-client 是一种基于 Node.js 开发的 Kraken API 客户端,它支持 Kraken 所提供的全部 API 并且具有优秀的可扩展性,使用该客户端可以极大地提升开发效率并降低开发难度。本文将介绍如何使用该 npm 包。
安装
在使用 kraken-api-universal-client 之前,您需要将其安装到您的项目中。您可以使用 yarn 或者 npm 命令进行安装。
yarn add kraken-api-universal-client
或者
npm install kraken-api-universal-client --save
使用
在项目中使用 kraken-api-universal-client 可以分为以下几步:
- 导入模块
const KrakenApi = require('kraken-api-universal-client');
- 创建实例
const kraken = new KrakenApi({ key: 'YOUR_API_KEY', secret: 'YOUR_API_SECRET', otp: 'YOUR_OTP', timeout: 5000, // 请求超时时间,默认为 5000 retries: 3, // 请求重试次数,默认为 3 });
在创建实例时,您需要提供以下参数:
- key - 您的 Kraken API key,可以在 Kraken 官网的 API 管理页面上生成。
- secret - 您的 Kraken API secret,可以在 Kraken 官网的 API 管理页面上生成。
- otp - 您的 Kraken API one-time password(可选),可以在 Kraken 官网的 two-factor authentication 页面上生成。如果您没有开启 two-factor authentication,则可以留空。
- timeout - 请求超时时间,最大值为 30000ms,默认为 5000ms。
- retries - 请求重试次数,默认为 3。
- 调用接口
例如,调用 Kraken 的 Ticker API:
kraken.api('Ticker', { pair: 'XBTUSD' }).then((result) => { console.log(result); }).catch((err) => { console.log(err); });
在调用接口时,您需要提供以下参数:
- method - Kraken API 的方法名,例如
Ticker
。 - params - Kraken API 的参数,以对象的形式传递,例如
{ pair: 'XBTUSD' }
。
- 支持的接口
kraken-api-universal-client 支持 Kraken API 的全部接口,包括 Public API 和 Private API。您可以在 Kraken 官网上查看全部的 API 文档,也可以在源码仓库中查看。
例如,调用 Kraken 的 Balance API:
kraken.api('Balance').then((result) => { console.log(result); }).catch((err) => { console.log(err); });
其中,Balance
是 Kraken API 的方法名。
示例
-- -------------------- ---- ------- ----- --------- - --------------------------------------- ----- ------ - --- ----------- ---- --------------- ------- ------------------ ---- ----------- --- -------------------- - ----- -------- ---------------- -- - -------------------- -------------- -- - ----------------- ---
结语
kraken-api-universal-client 是一个非常有用的 npm 包,它能够帮助开发者更加轻松地接入 Kraken API,并且具有优秀的可扩展性。在使用过程中,您可能需要查看 Kraken API 的文档来了解更多方法和参数的含义。希望这篇文章对您有所帮助,谢谢阅读!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562c481e8991b448e003d