npm 包 okcoin-rest 使用教程-JavaScript中文网-JavaScript教程资源分享门户

本文将介绍如何使用 npm 包 okcoin-rest 进行 OKCoin 的 Restful API 调用，并提供示例代码，希望能够对前端开发者有所帮助。

什么是 okcoin-rest

okcoin-rest 是一个 npm 包，可以用来访问 OKCoin 的 Restful API。它提供了简单易用的 API 调用接口，同时支持 Promise 和回调函数两种方式调用 API。

如何使用 okcoin-rest

在使用 okcoin-rest 之前，需要先安装它。可以通过以下命令进行安装：

npm install okcoin-rest

接下来，就可以在代码中导入 okcoin-rest，然后创建一个 okcoin 实例，用于进行 API 调用。以下是示例代码：

const Okcoin = require('okcoin-rest');

const okcoin = new Okcoin('api_key', 'api_secret');

其中，'api_key' 和 'api_secret' 分别是 OKCoin 的 API Key 和 API Secret，需要在 OKCoin 网站上申请。

有了 okcoin 实例之后，就可以开始调用 API 了。以下是一个查询当前账户余额的示例：

okcoin.get('userinfo').then(result => {
  console.log(result.data.info.funds);
}).catch(error => {
  console.error(error);
});

其中，'userinfo' 是 API 方法名称，表示查询用户信息；get() 方法是 okcoin 实例提供的调用 API 的方法，它返回一个 Promise 对象，当 API 调用成功时，Promise 的状态变为 resolved，result 参数包含 API 响应数据；当 API 调用失败时，Promise 的状态变为 rejected，error 参数包含错误信息。

如果希望使用回调函数进行 API 调用，可以如下使用：

okcoin.get('userinfo', (error, result) => {
  if (error) {
    console.error(error);
  } else {
    console.log(result.data.info.funds);
  }
});

okcoin-rest API 方法

okcoin-rest 支持的 API 方法可以分为五类：

行情API：kline、depth、trades、ticker。
交易API：userinfo、trade、batch_trade、cancel_order、order_info、orders_info、order_history。
借贷API：borrow、cancel_borrow、borrows、borrow_money、repayment、unrepayments。
合约API：future_ticker、future_depth、future_trades、future_index、exchange_rate、future_estimated_price、future_kline、future_hold_amount、future_price_limit、future_volume、future_expire_info。
websocket API：subscribe、unsubscribe、close。

调用这些 API 方法的方式都与上面示例代码中的 userinfo 相同，具体只需要将 userinfo 替换为实际调用的方法名称即可。

总结

本文介绍了 npm 包 okcoin-rest 的使用方法，并提供了示例代码。通过 okcoin-rest，可以方便地访问 OKCoin 的 Restful API，进行行情查询、交易下单、借贷申请等操作。同时，okcoin-rest 也为前端开发者提供了一种便捷的方式，用 JavaScript 程序调用 API 接口，从而在网页中实现更加丰富的功能。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60066fac3d1de16d83a671df