poloniex.js-karan 是一个用于与 Poloniex 加密货币交易所交互的 Node.js 模块。本教程将介绍如何在前端项目中使用这个 npm 包。
安装
首先,在项目目录下打开终端,输入以下命令进行安装:
npm install poloniex.js-karan
在安装成功后,可以通过以下方式引入模块:
const polo = require('poloniex.js-karan');
基本使用
创建 API 客户端
使用 poloniex.js-karan,需要先创建 Poloniex 的 API 客户端。可以通过以下代码创建客户端:
const client = new polo.Client(apiKey, secretKey);
其中 apiKey 和 secretKey 就是在 Poloniex API 页面获取的。此外,您还可以选择提供第三个参数 options,其中包括:
timeout
: 超时时间(毫秒),默认为 5000。host
: API 主机名,可以是 'poloniex.com' 或者 'api.poloniex.com',默认为 'api.poloniex.com'。port
: API 端口号,可以是 80 或者 443,取决于您使用的协议(HTTP 或者 HTTPS),默认为 443。protocol
: API 协议,可以是 'http' 或者 'https',默认为 'https'。userAgent
: 用户代理字符串,用于标识您的应用,应定义为appName/versionNumber
。
例如:
const options = { timeout: 10000, host: 'poloniex.com', port: 80, protocol: 'http', userAgent: 'MyApp/1.0.0' }; const client = new polo.Client(apiKey, secretKey, options);
市场数据查询
可以使用 getTicker()
方法获取市场行情数据:
client.getTicker('BTC_ETH', function(err, ticker) { console.log(ticker); });
该方法的参数为交易对名称,例如 BTC_ETH 表示比特币对以太坊。返回的数据包括以下内容:
-- -------------------- ---- ------- - -------- - --- -- ----- ------------- ---------- ------------- ----------- ------------- -------------- --------- ----------- -------------- ------------ -------------- --------- ---- --------- ------------- -------- ------------ -- --- -
订单查询
使用 getOrders()
方法可以获取订单信息:
client.getOrders('BTC_ETH', function(err, orders) { console.log(orders); });
该方法的参数为交易对名称,例如 BTC_ETH。返回的数据如下:
[ { amount: '0.00100000', date: '2014-02-10 04:23:23', rate: '0.00000100', total: '0.00000100', type: 'sell', orderNumber: '1501174' }, ... ]
创建订单
使用 buy()
或者 sell()
方法可以创建订单:
client.buy('BTC_ETH', '0.001', '0.002', function(err, result) { console.log(result); });
该方法的参数分别为交易对名称、买入或者卖出数量和价格。返回的数据如下:
{ orderNumber: '20352435', resultingTrades: [ { amount: '0.00100000', date: '2014-02-10 04:23:23', rate: '0.00000100', total: '0.00000100', tradeID: '40834', type: 'sell' } ] }
取消订单
使用 cancelOrder()
方法可以取消订单:
client.cancelOrder('20352435', function(err, success) { if (success) { console.log('Order cancelled!'); } else { console.log('Failed to cancel order'); } });
该方法的参数为订单号。
示例代码
以下是一个完整的示例代码,用于获取市场行情和创建订单:
-- -------------------- ---- ------- ----- ---- - ----------------------------- ----- ------ - --- ------------------- ----------- -- ------ --------------------------- ------------- ------- - -------------------- --- -- ---- --------------------- -------- -------- ------------- ------- - -------------------- ---
总结与建议
以上就是 poloniex.js-karan 的基本使用方法。在使用该 npm 包时,建议先仔细阅读 Poloniex API 文档,了解 API 的基本参数和响应格式。此外,如果您使用的是 Webpack 或者 Browserify 等打包工具,建议在配置文件中添加以下别名:
alias: { 'poloniex.js-karan': path.resolve('./node_modules/poloniex.js-karan/lib'), },
这样可以避免由于打包过程中出现路径问题而导致的错误。
对于那些初次接触加密货币交易所 API 的开发者,建议先进行模拟交易,防止由于无知而造成的不必要损失。同时,也要保证 API 密钥的安全,避免泄露。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cbf81e8991b448da559