Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Forked 'plnx package' in order to improve error handling among other minor details with the library.
npm install --save plnx2
const plnx = require('plnx2')
// or
import plnx from 'plnx2'
plnx.METHOD([options], [callback])
options
: object (optional if empty)
callback
: function(err, data)
error
: Error instance if exists, or null
.response
: API response objectbody
: response bodyIf no callback is provided, a Promise object is returned.
// 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)
})
https://github.com/crossbario/autobahn-js
plnx.push((session) => {
session.subscribe('channel', (data) => {
console.log(data)
})
})
? = optional
{}
{}
{ currencyPair, depth? }
{ currencyPair, start?, end? }
{ currencyPair, start, end, period }
{}
{ currency }
key
andsecret
are required in all
{}
{account?}
{}
{ currency }
{ start, end }
{ currencyPair }
{ currencyPair, start?, end? }
{ orderNumber }
{ currencyPair, rate, amount, fillOrKill?, immediateOrCancel? }
{ currencyPair, rate, amount, fillOrKill?, immediateOrCancel? }
{ orderNumber }
{ orderNumber, rate }
{ currency, amount, address, paymentId? }
{ account? }
{}
{ currency, amount, fromAccount, toAccount }
{}
{ currencyPair, rate, amount, lendingRate? }
{ currencyPair, rate, amount, lendingRate? }
{ currencyPair, type?, liquidationPrice? }
{ currencyPair }
{ currency, amount, duration, autoRenew, lendingRate }
{ orderNumber }
{}
{}
{ start?, end?, limit? }
{ orderNumber }
(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.
FAQs
Forked and updated unofficial Poloniex API client
The npm package plnx2 receives a total of 0 weekly downloads. As such, plnx2 popularity was classified as not popular.
We found that plnx2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.