miya-start / poloniex-node-api

Node.js library for Poloniex

Poloniex Node.js API

Node.js library for Poloniex.

Installation

npm install poloniex-node-api

Usage

PublicClient

import { PublicClient } from "poloniex-node-api";
const client = new PublicClient();

• getTickers

const tickers = await client.getTickers();

• getVolume

const volume = await client.getVolume();

• getOrderBook

const currencyPair = "USDT_BTC";
const depth = 25;
const book = await client.getOrderBook({ currencyPair, depth });

• getTradeHistory

const currencyPair = "currencyPair";
const start = 1410158341;
const end = 1410499372;
const trades = await client.getTradeHistory({ currencyPair, start, end });

• getChartData

const currencyPair = "BTC_XMR";
const period = 14400;
const start = 1546300800;
const end = 1546646400;
const candles = await client.getChartData({ currencyPair, period, start, end });

• getCurrencies

const includeMultiChainCurrencies = true;
const currencies = await client.getCurrencies({ includeMultiChainCurrencies });

• getLoanOrders

const currency = "USDT";
const loans = await client.getLoanOrders({ currency });

AuthenticatedClient

import { AuthenticatedClient } from "poloniex-node-api";
const key = "poloniexapikey";
const secret = "poloniexapisecret";
const client = new AuthenticatedClient({ key, secret });

• getBalances

const balances = await client.getBalances();

• getCompleteBalances

const account = "all";
const balances = await client.getCompleteBalances({ account });

• getDepositAddresses

const addresses = await client.getDepositAddresses();

• getNewAddress

const currency = "ZEC";
const addresses = await client.getNewAddress({ currency });

• getDepositsWithdrawals

const start = 1539954535;
const end = 1540314535;
const result = await client.getDepositsWithdrawals({ start, end });

• getOpenOrders

const currencyPair = "BTC_DASH";
const orders = await client.getOpenOrders({ currencyPair });

• getHistoryTrades

const currencyPair = "BTC_ETC";
const start = 1573953463;
const end = 1576588663;
const limit = 5000;
const trades = await client.getHistoryTrades({
  currencyPair,
  start,
  end,
  limit,
});

• getOrderTrades

const orderNumber = 96238912842;
const trades = await client.getOrderTrades({ orderNumber });

• getOrderStatus

const orderNumber = 96238912842;
const trades = await client.getOrderStatus({ orderNumber });

• buy

const currencyPair = "BTC_ETH";
const rate = 0.01;
const amount = 1;
const clientOrderId = 12345;
const postOnly = 1;
const order = await client.buy({
  currencyPair,
  rate,
  amount,
  postOnly,
  clientOrderId,
});

• sell

const currencyPair = "BTC_ETH";
const rate = 10;
const amount = 1;
const order = await client.sell({ currencyPair, rate, amount });

• cancelOrder

const orderNumber = 514845991795;
let result = await client.cancelOrder({ orderNumber });
// or by `clientOrderId`
const clientOrderId = 12345;
result = await client.cancelOrder({ clientOrderId });

• cancelAllOrders

const currencyPair = "BTC_ETH";
const orders = await client.cancelAllOrders({ currencyPair });

• moveOrder

const orderNumber = 514851026755;
const rate = 0.00015;
const clientOrderId = 12345;
const result = await client.moveOrder({ rate, orderNumber, clientOrderId });

• withdraw

const currency = "EOS";
const amount = 1000;
const address = "eos-address";
const paymentId = 1234567890;
const result = await client.withdraw({
  currency,
  amount,
  address,
  paymentId,
});

• getFeeInfo

const fees = await client.getFeeInfo();

• getAccountBalances

const account = "lending";
const balances = await client.getAccountBalances({ account });

• getTradableBalances

const balances = await client.getTradableBalances();

• transferBalance

const currency = "BTC";
const amount = 0.5;
const fromAccount = "lending";
const toAccount = "exchange";
const transfer = await client.transferBalance({
  currency,
  amount,
  fromAccount,
  toAccount,
});

• getMarginSummary

const summary = await client.getMarginSummary();

• marginBuy

const currencyPair = "BTC_ETH";
const rate = 0.01;
const amount = 1;
const lendingRate = 0.01;
const order = await client.marginBuy({
  currencyPair,
  rate,
  amount,
  lendingRate,
});

• marginSell

const currencyPair = "BTC_ETH";
const rate = 10;
const amount = 1;
const lendingRate = 0.015;
const clientOrderId = 12345;
const order = await client.marginSell({
  currencyPair,
  rate,
  amount,
  lendingRate,
  clientOrderId,
});

• getMarginPosition

const currencyPair = "BTC_ETH";
const position = await client.getMarginPosition({ currencyPair });

• closeMarginPosition

const currencyPair = "BTC_ETH";
const position = await client.closeMarginPosition({ currencyPair });

• createLoanOffer

const currency = "BTC";
const amount = 0.1;
const duration = 2;
const autoRenew = 0;
const lendingRate = 0.015;
const offer = await client.createLoanOffer({
  currency,
  amount,
  duration,
  autoRenew,
  lendingRate,
});

• cancelLoanOffer

const orderNumber = 1002013188;
const offer = await client.cancelLoanOffer({ orderNumber });

• getOpenLoanOffers

const offers = await client.getOpenLoanOffers();

• getActiveLoans

const loans = await client.getActiveLoans();

• getLendingHistory

const start = 1483228800;
const end = 1483315200;
const limit = 100;
const history = await client.getLendingHistory({ start, end, limit });

• toggleAutoRenew

const orderNumber = 1002013188;
const result = await client.toggleAutoRenew({ orderNumber });

• swapCurrencies

const fromCurrency = "WBTC";
const toCurrency = "BTC";
const amount = 1.2;
const result = await client.swapCurrencies({
  fromCurrency,
  toCurrency,
  amount,
});

WebsocketClient

import { WebsocketClient } from "poloniex-node-api";
const key = "poloniexapikey";
const secret = "poloniexapisecret";
const channels = [1000, "BTC_DOGE"];
const websocket = new WebsocketClient({ key, secret, channels });
websocket.on("open", () => console.log("open"));
websocket.on("close", () => console.log("close"));
websocket.on("error", (error) => console.error(error));
websocket.on("message", (message) => console.info(message));

• connect

await websocket.connect();

• disconnect

await websocket.disconnect();

• subscribe

await websocket.subscribe(1003);

• unsubscribe

await websocket.unsubscribe("BTC_ZEC");

Test

npm test