npm 包 okcoin-api 使用教程

阅读时长 6 分钟读完

作为一名前端工程师,要跟进前端技术的飞速发展,了解并使用一些 npm 包是非常有必要的。在数字货币快速发展的今天,数字货币交易平台 API 的需求也越来越高。本文将介绍一个 npm 包 —— okcoin-api,旨在帮助前端同学使用该 npm 包,实现数字货币交易的自动化。

什么是 okcoin-api

okcoin-api 是 okcoin 的 API 封装库,对于需要与 okcoin 对接进行数字货币交易的前端同学来说,使用 okcoin-api 可以大大简化代码开发,提高开发效率。该 npm 包的 GitHub 地址为:https://github.com/okcoin-okex/API-docs-OKCoin.com/blob/master/API-For-Futures-CN/rest_api_cn.md

安装 okcoin-api

在项目中使用 okcoin-api 需要先进行安装。可通过以下命令进行安装:

使用 okcoin-api 发送请求

为了使用 okcoin-api 发送请求,需要先进行初始化。可以通过以下代码进行初始化:

-- -------------------- ---- -------
----- --------- - ----------------------
----- ------ - -
  ------- ----- --- -----
  ---------- ----- --- --------
  ---- -------------------------
  -------- ----
--

----- ------ - --- ------------------

然后就可以使用以下代码发送请求:

以上代码展示了如何获取永续合约用户信息,执行该代码后将会返回用户信息。

okcoin-api API

以下是 okcoin-api 的一些 API 接口,可供参考:

币币现货:

  • 获取所有币种提现/充值记录信息:getAccountRecords
  • 获取充值地址:getDepositAddress
  • 提币到人民币地址:withdrawal
  • 获取所有支持的币种/交易对信息:getSymbolsInfo
  • 获取用户钱包账户信息:getWalletInfo
  • 获取订单信息:getOrder
  • 获取交易对深度信息:getDepth
  • 单个下单接口:placeOrder
  • 批量下单接口:placeBatchOrder
  • 买卖限价单撤单接口:cancelOrder
  • 获取用户的所有订单信息:getOrderHistory

永续合约:

  • 获取永续合约用户账户信息:futureUserInfo
  • 获取永续合约持仓信息:futurePosition
  • 获取永续合约订单信息:futureOrderInfo
  • 获取永续合约所有订单信息:futureOrdersInfo
  • 下单(限价单/市价单):futureTrade
  • 批量下单(限价单):futureBatchTrade
  • 撤单:futureCancel
  • 获取永续合约所有交易对信息:futureSymbolsInfo
  • 获取永续合约K线数据:futureKLine
  • 获取永续合约深度数据:futureDepth

交割合约:

  • 获取交割合约用户账户信息:swapUserInfo
  • 获取交割合约持仓信息:swapPosition
  • 获取交割合约订单信息:swapOrderInfo
  • 获取交割合约所有订单信息:swapOrdersInfo
  • 下单(限价单/市价单):swapTrade
  • 批量下单(限价单):swapBatchTrade
  • 撤单:cancel
  • 获取交割合约所有交易对信息:swapSymbolsInfo
  • 获取交割合约K线数据:swapKLine
  • 获取交割合约深度数据:swapDepth

示例代码

以下是一个简单的基于 okcoin-api 的自动化交易策略实现,可供参考:

-- -------------------- ---- -------
----- --------- - --------------
----- --------- - ----------------------
----- ------ - -
  ------- ----- --- -----
  ---------- ----- --- --------
  ---- -----------------------
  -------- -----
--

----- ------ - --- ------------------
----- - ---------- --------------- - - - ---------- ----- ---------------- ---- --
--------------

----- -- - --- --------------------------------------------

------------- -------- ------ -
  --------------------
  ----- ---- - -
    --- ------------
    ----- ---------------------------------------
  --
  ------------------------------
---

---------------- -------- -------------- -
  ----- -------- - -----------------
  ----- - ----- ---- - - -----------------
  ----- ---- - --------------- - -----------
  ----- ----- - ---------- - ----------------

  -- ----- - ---- -
    ----------------------------- ---------- ------ ----------- ---- ---- ------ ---- -----
  -

  -- ------ - ---- -
    ----------------------------- ---------- ------- ----------- ---- ---- ------ ---- -----
  -
---

总结

okcoin-api 是一个非常有用的 npm 包,对于需要与 okcoin 对接进行数字货币交易的前端同学来说,使用 okcoin-api 可以极大地简化代码开发,提高开发效率。本文介绍了 okcoin-api 的安装、初始化、API、示例代码等使用教程。希望这篇文章可以对你有所帮助。

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

纠错
反馈