介绍
在Web开发中,我们经常需要使用到第三方库,以提高我们开发的效率。npm是一个非常流行的JavaScript包管理工具,它提供了数以万计的包供我们使用。其中@bitr/bitflyer-fx是一个用于操作比特币交易所BitFlyer的npm包。
本文将详细介绍如何使用@bitr/bitflyer-fx来操作BitFlyer交易所的API。
安装
首先,我们需要使用npm进行安装。在终端中输入以下命令:
npm install @bitr/bitflyer-fx
使用
安装完成后,在我们的代码中引入@bitr/bitflyer-fx即可开始使用。
实例化
在使用@bitr/bitflyer-fx之前,我们需要先实例化一个BitFlyerFX
对象,以便于我们对交易所API进行操作。
const BitFlyerFX = require('@bitr/bitflyer-fx').default; const bitflyerFX = new BitFlyerFX({ apiKey: 'YOUR_API_KEY', apiSecret: 'YOUR_API_SECRET', });
在实例化时,需要传递一个包含apiKey和apiSecret字段的配置对象,这两个字段分别为我们在BitFlyer上申请的API Key和API Secret。
获取资产信息
我们可以使用getBalance()
方法来获取我们在BitFlyer上所有贸易币种的余额信息。
const balance = await bitflyerFX.getBalance(); console.log(balance);
输出结果如下:
-- -------------------- ---- ------- - ---- - ---------- --- ------ -- -------- - -- ---- - ---------- ------ ------ -- -------- - -- ---- - ---------- -- ------ -- -------- - - -
其中,available
字段代表可用余额,order
字段代表订单中的余额,deposit
字段代表已入金的余额。
获取订单信息
我们可以使用getOrders()
方法来获取我们在BitFlyer上所有的订单信息。
const orders = await bitflyerFX.getOrders(); console.log(orders);
输出结果如下:
-- -------------------- ---- ------- - - --- ---------------------------- --------------- -------- ----- ------ ------ ------ ----- ------ ---------------- ------------ --------------- ---------------------- ------------- ------------------------------------------- ---------------- -- ----------- -- ------------ -------------------------- ---------- --------- ---------------- -- -------- ------ ------------- ------------------------- -- -- ---- ------ -
下单
我们可以使用sendChildOrder()
方法来下单。
await bitflyerFX.sendChildOrder({ productCode: 'FX_BTC_JPY', childOrderType: 'LIMIT', side: 'BUY', price: 500000, size: 0.01, timeInForce: 'GTC' });
上述代码将以500000日元的价格买入0.01个比特币。
取消订单
我们可以使用cancelChildOrder()
方法来取消订单。
await bitflyerFX.cancelChildOrder('JFX20201016-00112233445566778899-0000001');
获取成交历史
我们可以使用getExecutions()
方法来获取我们在BitFlyer上所有的成交历史信息。
const executions = await bitflyerFX.getExecutions(); console.log(executions);
输出结果如下:
-- -------------------- ---- ------- - - --- ---- ------------- ------------------------------------------- ----- ------ ------ ------- ----- ----- ----------- -- --------- -------------------------- ----------------------- ------------------------------------------- ------------------- ----- -- -- ---- ---------- -
结论
通过本教程,我们学习了如何使用@bitr/bitflyer-fx操作BitFlyer交易所的API。虽然我们只是简单介绍了API的一部分,但我们通过这些示例代码,我们可以获得更深入的理解,从而可以更好的开发自己的交易策略。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005753b81e8991b448ea48d