介绍
bitso-node-api
是 Bitso 的官方 API。它提供所有的公开和私有 API 功能。它支持访问用户账户信息、订单簿、交易历史等等。
本篇文章将详细介绍 bitso-node-api
的使用方法,并提供示例代码以供参考。
安装
您可以通过npm
安装bitso-node-api
:
npm install bitso-node-api --save
使用方法
在使用 bitso-node-api
之前,需要先注册一个 Bitso 的账户并获取 API Key 和 Secret。
const Bitso = require('bitso-node-api'); const bitso = new Bitso('API_KEY', 'API_SECRET');
您也可以设置环境变量 BITSO_KEY
和 BITSO_SECRET
,来代替直接传递 API Key 和 Secret:
const Bitso = require('bitso-node-api'); const bitso = new Bitso();
公开 API 方法
以下列出了 bitso-node-api
所支持的所有的公开 API 方法。
getAvailableBooks
获取可交易的货币对及相关信息。
const books = await bitso.getAvailableBooks();
返回结果:
-- -------------------- ---- ------- - - ------- ---------- ----------------- -------- ----------------- ---------------- ---------------- -------------- ---------------- ------------------- ---------------- -------------- ---------------- ------------------ -- - ------- ---------- ----------------- -------- ----------------- ---------------- ---------------- -------------- ---------------- ------------------- ---------------- -------------- ---------------- ------------------ - -
getTicker
获取指定货币对的最新行情数据。
const ticker = await bitso.getTicker('btc_mxn');
返回结果:
{ "bid": "312080.00", "ask": "312465.00", "last_trade": "312465.00" }
getOrderBook
获取指定货币对的订单簿。您可以指定属性来筛选数据,例如只获取卖单、只获取前 10 条数据等等。
const orderBook = await bitso.getOrderBook('btc_mxn', { aggregate: true });
返回结果:
-- -------------------- ---- ------- - ------- - - -------- ---------- --------- ------------- ------------ -------------------------- -- - -------- ---------- --------- ------------- ------------ -------------------------- - -- ------- - - -------- ---------- --------- ------------- ------------ -------------------------- -- - -------- ---------- --------- ------------- ------------ -------------------------- - - -
getTrades
获取指定货币对的交易历史。您可以指定属性来筛选数据,例如只获取从指定时间起的交易、只获取前 10 条数据等等。
const trades = await bitso.getTrades('btc_mxn', { time: '2018-01-01' });
返回结果:
-- -------------------- ---- ------- - - ------ --------- -------- ---------- --------- ------------- ----------- --------------------------- ------- ----- -- - ------ --------- -------- ---------- --------- ------------- ----------- --------------------------- ------- ------ - -
私有 API 方法
以下列出了 bitso-node-api
所支持的所有的私有 API 方法。在使用私有 API 方法前,您需要先进行身份验证。
const authenticate = bitso.authenticate();
getAccountStatus
获取账户状态和余额。
const accountStatus = await bitso.getAccountStatus();
getAccountBalance
获取账户余额。
const accountBalance = await bitso.getAccountBalance();
getWithdrawals
获取提现历史。
const withdrawals = await bitso.getWithdrawals();
createWithdrawal
创建新提现请求。
const withdrawalRequest = { amount: '100.00', currency: 'mxn', beneficiary: '002' }; const withdrawal = await bitso.createWithdrawal(withdrawalRequest);
结论
bitso-node-api
可以方便地访问 Bitso 的所有 API 功能。无论您是想要访问公开的行情数据,还是进行私人账户操作,通过 bitso-node-api
,操作都可以变得简单易行。
下面是一个完整的使用示例:
-- -------------------- ---- ------- ----- ----- - -------------------------- ----- ----- - --- -------- ----- -------- ------ - --- - ----- ----- - ----- -------------------------- --------------------- ------- ----- ------ - ----- --------------------------- ---------------------- -------- ----- --------- - ----- ----------------------------- - ---------- ---- --- ------------------------- ----------- ----- ------ - ----- -------------------------- - ----- ------------ --- ---------------------- -------- ----- ------------ - --------------------- ----- ------------- - ----- ------------------------- ----------------------------- --------------- ----- -------------- - ----- -------------------------- ------------------------------ ---------------- ----- ----------- - ----- ----------------------- --------------------------- ------------- ----- ----------------- - - ------- --------- --------- ------ ------------ ----- -- ----- ---------- - ----- ------------------------------------------ -------------------------- ------------ - ----- ----- - ----------------- - - -------
希望这篇文章能够对你有所帮助,谢谢!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005727781e8991b448e8aaa