Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/dutu/poloniex-api-node

Poloniex API client for REST and WebSocket API
https://github.com/dutu/poloniex-api-node
api callback node-wrapper poloniex poloniex-api promise rest rest-api websocket websocket-api websocket-client
Last synced: about 11 hours ago
JSON representation
Poloniex API client for REST and WebSocket API
Host: GitHub
URL: https://github.com/dutu/poloniex-api-node
Owner: dutu
License: mit
Created: 2016-09-28T21:38:50.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-09-27T23:00:37.000Z (over 1 year ago)
Last Synced: 2024-12-15T17:07:25.429Z (about 1 month ago)
Topics: api, callback, node-wrapper, poloniex, poloniex-api, promise, rest, rest-api, websocket, websocket-api, websocket-client
Language: JavaScript
Homepage: https://www.npmjs.com/package/poloniex-api-node
Size: 16.9 MB
Stars: 141
Watchers: 14
Forks: 59
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project

README

        poloniex-api-node

=======

[![Tests](https://github.com/dutu/poloniex-api-node/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/dutu/poloniex-api-node/actions/workflows/nodejs-ci.yml) 

**poloniex-api-node** is a simple node.js wrapper for Poloniex REST and WebSocket API.

### Contents

* [Changelog](#changelog)

* [Install](#install)

* [Usage](#usage)

	* [Constructor](#constructor)

	* [REST API](#rest-api)

	* [WebSocket API](#websocket-api)

* [Contributors](#contributors)

* [License](#license)

# Changelog

See detailed [GitHub Releases](https://github.com/dutu/poloniex-api-node/releases)

## Breaking changes introduced in version 3.0.0

Legacy Poloniex API is no longer supported.

Poloniex has announced that **the legacy API is slated to be decommissioned on Jan 31st, 2023**.

Module supporting the legacy API has been moved to [branch legacy_API](https://github.com/dutu/poloniex-api-node/tree/legacy_API), and it is not longer maintained. 

# Install

    npm install --save poloniex-api-node

# Usage

## Constructor

* `new Poloniex({ apiKey, apiSecret })`

To access the private Poloniex API methods you must supply your API key id and key secret. If you are only accessing the public API endpoints, you can leave the parameter out.

Examples:

```js

const poloniex = new Poloniex({ apiKey: 'myKey', apiSecret: 'mySecret' })

```

## REST API

### Properties

* `apiCallRateLimits` - API call rate limits for endpoints sets (resource-intensive and non-resource-intensive private and public endpoints)

	Example output:

	```javascript

  {

    riPub: 10,

    nriPub: 200,

    nriPriv: 50,

    riPriv: 10

  }

  ```

* `apiCallRates` - Current call rate for resource-intensive and non-resource-intensive private and public API calls

	Example output:

	```javascript

  {

    riPub: 8,

    nriPub: 100,

    nriPriv: 5,

    riPriv: 7

  }

  ```

See https://docs.poloniex.com/#rate-limits.

### Methods

All methods accept one object parameter, which is used to pass all request parameters for the API call.

[Official Poloniex API documentation](https://docs.poloniex.com/) lists all valid **Request Parameters** for API calls. 

When a **Request Parameter** needs to be included, a property with the exact same name needs to be added to the object parameter.

All methods return a promise.

Example:

```js

import Poloniex from 'poloniex-api-node'

let poloniex = new Poloniex({ apiKey: 'myKey', apiSecret: 'mySecret' })

const tradesHistory = poloniex.getTradesHistory({ limit: 1000, symbols: 'BTC_USDT' })

  .then((result) => console.log(result))

  .catch((err) => console.log(err))

```

An optional property `getApiCallRateInfo` can be specified. When set to `true` the corresponding API call is not sent to the exchange, instead the current API call rate is returned. See [rate limits](https://docs.poloniex.com/#rate-limits).

Example:

```js

const callRateInfo = poloniex.getTradesHistory({ limit: 1000, symbols: 'BTC_USDT', getApiCallRateInfo: true })

```

Example output: 

```javascript

[

 'riPriv', // id of the API endpoind set (can be 'riPub', 'nriPub', 'riPriv' or 'nriPriv')  

 2,        // current API call rate

 10        // API call rate limit

]

```

### Public API Methods

#### Reference Data

* [`getSymbols`](https://docs.poloniex.com/#public-endpoints-reference-data-symbol-information) - get symbols and their trade info

* [`getCurrencies`](https://docs.poloniex.com/#public-endpoints-reference-data-currency-information) - get supported currencies

* [`getTimestamp`](https://docs.poloniex.com/#public-endpoints-reference-data-system-timestamp) - get current server time

#### Market Data

 * [`getPrices`](https://docs.poloniex.com/#public-endpoints-market-data-prices) - get the latest trade price for symbols

 * [`getMarkPrice`](https://docs.poloniex.com/#public-endpoints-market-data-mark-price) - get the latest mark price for cross margin symbols

 * [`getMarkPriceComponents`](https://docs.poloniex.com/#public-endpoints-market-data-mark-price-components) - get components of the mark price for a given symbol

 * [`getOrderBook`](https://docs.poloniex.com/#public-endpoints-market-data-order-book) - get the order book for a given symbol

 * [`getCandles`](https://docs.poloniex.com/#public-endpoints-market-data-candles) - returns OHLC for a symbol at given timeframe (interval)

 * [`getTrades`](https://docs.poloniex.com/#public-endpoints-market-data-trades) - returns a list of recent trades

 * [`getTicker`](https://docs.poloniex.com/#public-endpoints-market-data-ticker) - returns ticker in last 24 hours for all symbols

#### Margin

 * [`getCollateralInfo`](https://docs.poloniex.com/#public-endpoints-margin-collateral-info) - get collateral information for currencies

 * [`getBorrowRatesInfo`](https://docs.poloniex.com/#public-endpoints-margin-borrow-rates-info) - get borrow rates information for all tiers and currencies

### Authenticated API Methods

#### Accounts

 * [`getAccountsInfo`](https://docs.poloniex.com/#authenticated-endpoints-accounts-account-information) - get a list of all accounts of a use

 * [`getAccountsBalances`](https://docs.poloniex.com/#authenticated-endpoints-accounts-all-account-balances) - get a list of accounts of a user with each account’s id, type and balances

 * [`getAccountsActivity`](https://docs.poloniex.com/#authenticated-endpoints-accounts-account-activity) - get a list of activities such as airdrop, rebates, staking, credit/debit adjustments, and other (historical adjustments)

 * [`accountsTransfer`](https://docs.poloniex.com/#authenticated-endpoints-accounts-accounts-transfer) - transfer amount of currency from an account to another account for a user

 * [`getAccountsTransferRecords`](https://docs.poloniex.com/#authenticated-endpoints-accounts-accounts-transfer-records) - get a list of transfer records of a user

 * [`getFeeInfo`](https://docs.poloniex.com/#authenticated-endpoints-accounts-fee-info) - get fee rate

#### Subaccounts

 * [`getSubaccountsInfo`](https://docs.poloniex.com/#authenticated-endpoints-subaccounts-subaccount-information) - get a list of all the accounts within an Account Group for a user

 * [`getSubaccountsBalances`](https://docs.poloniex.com/#authenticated-endpoints-subaccounts-subaccount-balances) - get balances information by currency and account type

 * [`subaccountsTransfer`](https://docs.poloniex.com/#authenticated-endpoints-subaccounts-subaccount-transfer) - transfer amount of currency from an account and account type to another account and account type among the accounts in the account group

 * [`getSubaccountsTransferRecords`](https://docs.poloniex.com/#authenticated-endpoints-subaccounts-subaccount-transfer-records) - get a list of transfer records of a user

#### Wallets

 * [`getDepositAddresses`](https://docs.poloniex.com/#authenticated-endpoints-wallets-deposit-addresses) - get deposit addresses for a user

 * [`getWalletsActivityRecords`](https://docs.poloniex.com/#authenticated-endpoints-wallets-wallets-activity-records) - get deposit and withdrawal activity history

 * [`createNewCurrencyAddress`](https://docs.poloniex.com/#authenticated-endpoints-wallets-new-currency-address) - Create a new address for a currency

 * [`withdrawCurrency`](https://docs.poloniex.com/#authenticated-endpoints-wallets-withdraw-currency) - immediately places a withdrawal for a given currency

#### Margin

 * [`getMarginAccountInfo`](https://docs.poloniex.com/#authenticated-endpoints-margin-account-margin) - get account margin information

 * [`getMarginBorrowStatus`](https://docs.poloniex.com/#authenticated-endpoints-margin-borrow-status) - get borrow status of currencies

 * [`getMarginMaxSize`](https://docs.poloniex.com/#authenticated-endpoints-margin-maximum-buy-sell-amount) - get maximum and available buy/sell amount for a given symbol

#### Orders

 * [`createOrder`](https://docs.poloniex.com/#authenticated-endpoints-orders-create-order) - create an order for an account

 * [`createBatchOrders`](https://docs.poloniex.com/#authenticated-endpoints-orders-create-multiple-orders) - create multiple orders via a single request

 * [`replaceOrder`](https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-replace-order) - cancel an existing active order, new or partially filled, and place a new order

 * [`getOpenOrders`](https://docs.poloniex.com/#authenticated-endpoints-orders-open-orders) - get a list of active orders for an account

 * [`getOrderDetails`](https://docs.poloniex.com/#authenticated-endpoints-orders-order-details) - get an order’s status

 * [`cancelOrder`](https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-order-by-id) - cancel an active order

 * [`cancelBatchOrders`](https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-multiple-orders-by-ids) - batch cancel one or many active orders in an account by IDs

 * [`cancelAllOrders`](https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-all-orders) - cancel all orders in an account

 * [`setKillSwitch`](https://docs.poloniex.com/#authenticated-endpoints-orders-kill-switch) - set a timer that cancels all regular and smartorders after the timeout has expired

 * [`getKillSwitchStatus`](https://docs.poloniex.com/#authenticated-endpoints-orders-kill-switch-status) - get status of kill switch

#### Smart Orders

 * [`createSmartOrder`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-create-order) - create a smart order for an account

 * [`replaceSmartOrder`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-replace-order) - cancel an existing untriggered smart order and place a new smart order

 * [`getSmartOpenOrders`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-open-orders) - get a list of (pending) smart orders for an account

 * [`getSmartOrderDetails`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-order-details) - get a smart order’s status

 * [`cancelSmartOrder`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-order-by-id) - cancel a smart order

 * [`cancelBatchSmartOrders`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-multiple-orders-by-id) - batch cancel one or many smart orders in an account by IDs

 * [`cancelAllSmartOrders`](https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-all-orders) - batch cancel all smart orders in an account

#### Order History

 * [`getOrdersHistory`](https://docs.poloniex.com/#authenticated-endpoints-order-history-orders-history) - get a list of historical orders in an account

 * [`getSmartOrdersHistory`](https://docs.poloniex.com/#authenticated-endpoints-order-history-smart-orders-history) - get a list of historical smart orders in an account

#### Trades

 * [`getTradesHistory`](https://docs.poloniex.com/#authenticated-endpoints-trades-trade-history) - get a list of all trades for an account

 * [`getOrderTrades`](https://docs.poloniex.com/#authenticated-endpoints-trades-trades-by-order-id) - get a list of all trades for an order specified by its orderId

## Websocket API

The module uses [forever-websocket](https://github.com/dutu/forever-websocket) to connect to Poloniex websocket server.  

`ForeverWebSocket` extends [`WebSocket`](https://github.com/websockets/ws/blob/master/doc/ws.md#class-websocket), and in additions supports:

* automatic reconnection

* configurable reconnecting timers

* configurable timeouts and reconnects when no message received

* automatic pings to keep connection alive

### Connection

* `newPublicWebSocket(options)` - establishes a WebSocket connection for public channels  

* `newAuthenticatedWebSocket(options)` - establishes a WebSocket connection for authenticated channels

`options` parameter properties (check [`ForeverWebSocket`](https://github.com/dutu/forever-websocket) for additional explanations):

Property name | Type            | Attributes | Default                                                                     | Description

--------------|-----------------|------------|-----------------------------------------------------------------------------|--------------

`reconnect` | object or `null` | optional | `{ factor: 1.5, initialDelay: 50, maxDelay: 10000, randomizeDelay: false }` | Reconnecting parameters. Defaults to exponential backoff strategy 

`timeout` | number          | optional | no timeout	                                                                 | Timeout in milliseconds after which the websockets reconnects when no messages are received

`newPublicWebSocket()` and `newAuthenticatedWebSocket()` return a `ForeverWebSocket` instance.

#### Ping

Ping function is activated by default, ping requests are issued every 30 seconds to keep the connection alive.

```javascript

{

"event": "ping"

}

```

### Public channels

See https://docs.poloniex.com/#public-channels

Example:

```javascript

import Poloniex from 'poloniex-api-node'

const poloniex = new Poloniex()

// Create a new WebSocket connected to public endpoint. The WebSocket should not reconnect if disconnected. 

const ws = poloniex.newPublicWebSocket({ reconnect: null })

// Specify event handlers

ws.on('open', () => console.log('Websocket connection open'))

ws.on('message', (data) => console.log('Websocket data received'))

ws.on('error', () => console.log('Websocket error'))

ws.on('close', () => console.log('Websocket connection closed'))

```

### Authenticated channels

See https://docs.poloniex.com/#authenticated-channels

When `newAuthenticatedWebSocket()` is used to open a WebSocket connection to access private channels, the authentication `auth` message is automatically sent to Poloniex immediately after the WebSocket connection is open.

Subscriptions for authentication channels can be sent after poloniex server responds with successful authentication confirmation:

```javascript

{

  "data":  {

    "success": true,

    "ts": 1645597033915

  },

  "channel": "auth"

}

```

Example: 

```js

import Poloniex from 'poloniex-api-node'

const poloniex = new Poloniex({ apiKey: 'myKey', apiSecret: 'mySecret' })

// Create a new WebSocket connected to private endpoint. 

const ws = poloniex.newAuthenticatedWebSocket()

// Specify event handlers

ws.on('open', () => console.log('Websocket connection open'))

ws.on('message', (data) => {

  // if 'auth` message is received and authentication is sucessfull, send subscribe message 

  if (data.channel === 'auth' && data.data.success) {

    ws.send({

      event: 'subscribe',

      channel: ['orders'],

      symbols: ['all']

    })

  }  

})

```

# Contributors

This project exists thanks to all the people who contribute.

* [dutu](https://github.com/dutu)

* [julesGoullee](https://github.com/julesGoullee)

* [zymnytskiy](https://github.com/zymnytskiy)

* [Wallison Santos](https://github.com/wallybh)

* [Denis Bezrukov](https://github.com/anthrax63)

* [BarnumD](https://github.com/BarnumD)

* [zunderbolt](https://github.com/zunderbolt)

* [aloysius-pgast](https://github.com/aloysius-pgast)

* [SeanRobb](https://github.com/SeanRobb)

* [Robert Valmassoi](https://github.com/valmassoi)

* [epdev](https://github.com/epdev)

* [standup75](https://github.com/standup75)

* [kevflynn](https://github.com/kevflynn)

* [Alexey Marunin](https://github.com/alexeymarunin)

# License

[MIT](LICENSE)