rferro
plnx
Unofficial Poloniex API client, with public/private methods and push.
Install
npm install --save plnxUse
const plnx = require('plnx')
// or
import plnx from 'plnx'Private/Public Methods
plnx.METHOD([options], [callback])options: object (optional if empty)- With private methods, options.key and options.secret are required.
callback: function(err, data)err: Error instance if exists, ornull.data: API response object
If no callback is provided, a Promise object is returned.
Example
// public without options
plnx.returnTicker((err, data) => {
console.log(err, data)
})
// public with options
plnx.returnOrderBook({ currencyPair: 'BTC_ETH' }, (err, data) => {
console.log(err, data)
})
// private without options
plnx.returnCompleteBalances({ key: 'key', secret: 'secret' }, (err, data) => {
console.log(err, data)
})
// private with options
plnx.returnTradeHistory({ key: 'key', secret: 'secret', currencyPair: 'BTC_ETH' }, (err, data) => {
console.log(err, data)
})
// with promises
plnx.returnTicker()
.then((data) => {
console.log(data)
})
.catch((err) => {
console.log(err)
})
plnx.returnCompleteBalances({ key: 'key', secret: 'secret' })
.then((data) => {
console.log(data)
})
.catch((err) => {
console.log(err)
})Push
https://github.com/crossbario/autobahn-js
plnx.push((session) => {
session.subscribe('channel', (data) => {
console.log(data)
})
})Public and private methods and options
? = optional
Public
- returnTicker:
{} - return24Volume/return24hVolume:
{} - returnOrderBook:
{ currencyPair, depth? } - returnTradeHistory:
{ currencyPair, start?, end? } - returnChartData:
{ currencyPair, start, end, period } - returnCurrencies:
{} - returnLoanOrders:
{ currency }
Private
keyandsecretare required in all
- returnBalances:
{} - returnCompleteBalances:
{account?} - returnDepositAddresses:
{} - generateNewAddress:
{ currency } - returnDepositsWithdrawals:
{ start, end } - returnOpenOrders:
{ currencyPair } - returnTradeHistory:
{ currencyPair, start?, end? } - returnOrderTrades:
{ orderNumber } - buy:
{ currencyPair, rate, amount, fillOrKill?, immediateOrCancel? } - sell:
{ currencyPair, rate, amount, fillOrKill?, immediateOrCancel? } - cancelOrder:
{ orderNumber } - moveOrder:
{ orderNumber, rate } - withdraw:
{ currency, amount, address, paymentId? } - returnAvailableAccountBalances:
{ account? } - returnTradableBalances:
{} - transferBalance:
{ currency, amount, fromAccount, toAccount } - returnMarginAccountSummary:
{} - marginBuy:
{ currencyPair, rate, amount, lendingRate? } - marginSell:
{ currencyPair, rate, amount, lendingRate? } - getMarginPosition:
{ currencyPair, type?, liquidationPrice? } - closeMarginPosition:
{ currencyPair } - createLoanOffer:
{ currency, amount, duration, autoRenew, lendingRate } - cancelLoanOffer:
{ orderNumber } - returnOpenLoanOffers:
{} - returnActiveLoans:
{} - returnLendingHistory:
{ start?, end?, limit? } - toggleAutoRenew:
{ orderNumber }
License
(The MIT License)
Copyright (c) 2015 Ricardo Ferro <ricardo.ferro@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.