## poloniex{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchOHLCV](#fetchohlcv) * [fetchMarkets](#fetchmarkets) * [fetchTime](#fetchtime) * [fetchTickers](#fetchtickers) * [fetchCurrencies](#fetchcurrencies) * [fetchTicker](#fetchticker) * [fetchTrades](#fetchtrades) * [fetchMyTrades](#fetchmytrades) * [fetchOpenOrders](#fetchopenorders) * [fetchClosedOrders](#fetchclosedorders) * [createOrder](#createorder) * [editOrder](#editorder) * [cancelAllOrders](#cancelallorders) * [fetchOrder](#fetchorder) * [fetchOrderTrades](#fetchordertrades) * [fetchBalance](#fetchbalance) * [fetchTradingFees](#fetchtradingfees) * [fetchOrderBook](#fetchorderbook) * [createDepositAddress](#createdepositaddress) * [fetchDepositAddress](#fetchdepositaddress) * [transfer](#transfer) * [withdraw](#withdraw) * [fetchDepositsWithdrawals](#fetchdepositswithdrawals) * [fetchWithdrawals](#fetchwithdrawals) * [fetchDepositWithdrawFees](#fetchdepositwithdrawfees) * [fetchDeposits](#fetchdeposits) * [setLeverage](#setleverage) * [fetchLeverage](#fetchleverage) * [fetchPositionMode](#fetchpositionmode) * [setPositionMode](#setpositionmode) * [fetchPositions](#fetchpositions) * [reduceMargin](#reducemargin) * [addMargin](#addmargin) ### fetchOHLCV{docsify-ignore} fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://api-docs.poloniex.com/spot/api/public/market-data#candles - https://api-docs.poloniex.com/v3/futures/api/market/get-kline-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms | | params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript poloniex.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for poloniex **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - an array of objects representing market data **See** - https://api-docs.poloniex.com/spot/api/public/reference-data#symbol-information - https://api-docs.poloniex.com/v3/futures/api/market/get-all-product-info | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchMarkets ([params]) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [poloniex](#poloniex) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See**: https://api-docs.poloniex.com/spot/api/public/reference-data#system-timestamp | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchTime ([params]) ``` ### fetchTickers{docsify-ignore} fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See** - https://api-docs.poloniex.com/spot/api/public/market-data#ticker - https://api-docs.poloniex.com/v3/futures/api/market/get-market-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchTickers (symbols[, params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an associative dictionary of currencies **See**: https://api-docs.poloniex.com/spot/api/public/reference-data#currency-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchCurrencies ([params]) ``` ### fetchTicker{docsify-ignore} fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See** - https://api-docs.poloniex.com/spot/api/public/market-data#ticker - https://api-docs.poloniex.com/v3/futures/api/market/get-market-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchTicker (symbol[, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://api-docs.poloniex.com/spot/api/public/market-data#trades - https://api-docs.poloniex.com/v3/futures/api/market/get-execution-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchTrades (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See** - https://api-docs.poloniex.com/spot/api/private/trade#trade-history - https://api-docs.poloniex.com/v3/futures/api/trade/get-execution-details | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trades structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | the latest time in ms to fetch entries for | | params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript poloniex.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api-docs.poloniex.com/spot/api/private/order#open-orders - https://api-docs.poloniex.com/spot/api/private/smart-order#open-orders // trigger orders - https://api-docs.poloniex.com/v3/futures/api/trade/get-current-orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch open orders for | | limit | int | No | the maximum number of open orders structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | set true to fetch trigger orders instead of regular orders | ```javascript poloniex.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api-docs.poloniex.com/v3/futures/api/trade/get-order-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest entry | ```javascript poloniex.fetchClosedOrders (symbol[, since, limit, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api-docs.poloniex.com/spot/api/private/order#create-order - https://api-docs.poloniex.com/spot/api/private/smart-order#create-order // trigger orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of currency you want to trade in units of base currency | | price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.triggerPrice | float | No | the price at which a trigger order is triggered at | | params.cost | float | No | *spot market buy only* the quote quantity that can be used as an alternative for the amount | ```javascript poloniex.createOrder (symbol, type, side, amount[, price, params]) ``` ### editOrder{docsify-ignore} edit a trade order **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api-docs.poloniex.com/spot/api/private/order#cancel-replace-order - https://api-docs.poloniex.com/spot/api/private/smart-order#cancel-replace-order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | No | how much of the currency you want to trade in units of the base currency | | price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.triggerPrice | float | No | The price at which a trigger order is triggered at | ```javascript poloniex.editOrder (id, symbol, type, side[, amount, price, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api-docs.poloniex.com/spot/api/private/order#cancel-all-orders - https://api-docs.poloniex.com/spot/api/private/smart-order#cancel-all-orders // trigger orders - https://api-docs.poloniex.com/v3/futures/api/trade/cancel-all-orders - contract markets | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | true if canceling trigger orders | ```javascript poloniex.cancelAllOrders (symbol[, params]) ``` ### fetchOrder{docsify-ignore} fetch an order by it's id **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api-docs.poloniex.com/spot/api/private/order#order-details - https://api-docs.poloniex.com/spot/api/private/smart-order#open-orders // trigger orders | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified market symbol, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | true if fetching a trigger order | ```javascript poloniex.fetchOrder (id, symbol[, params]) ``` ### fetchOrderTrades{docsify-ignore} fetch all the trades made from a single order **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://api-docs.poloniex.com/spot/api/private/trade#trades-by-order-id | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trades to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchOrderTrades (id, symbol[, since, limit, params]) ``` ### fetchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://api-docs.poloniex.com/spot/api/private/account#all-account-balances - https://api-docs.poloniex.com/v3/futures/api/account/balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchBalance ([params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See**: https://api-docs.poloniex.com/spot/api/private/account#fee-info | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchTradingFees ([params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See** - https://api-docs.poloniex.com/spot/api/public/market-data#order-book - https://api-docs.poloniex.com/v3/futures/api/market/get-order-book | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchOrderBook (symbol[, limit, params]) ``` ### createDepositAddress{docsify-ignore} create a currency deposit address **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#deposit-addresses | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency for the deposit address | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.createDepositAddress (code[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#deposit-addresses | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchDepositAddress (code[, params]) ``` ### transfer{docsify-ignore} transfer currency internally between wallets on the same account **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://api-docs.poloniex.com/spot/api/private/account#accounts-transfer | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | amount to transfer | | fromAccount | string | Yes | account to transfer from | | toAccount | string | Yes | account to transfer to | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.transfer (code, amount, fromAccount, toAccount[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#withdraw-currency | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | the amount to withdraw | | address | string | Yes | the address to withdraw to | | tag | string | Yes | | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.withdraw (code, amount, address, tag[, params]) ``` ### fetchDepositsWithdrawals{docsify-ignore} fetch history of deposits and withdrawals **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a list of [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#wallets-activity-records | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | unified currency code for the currency of the deposit/withdrawals, default is undefined | | since | int | No | timestamp in ms of the earliest deposit/withdrawal, default is undefined | | limit | int | No | max number of deposit/withdrawals to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchDepositsWithdrawals ([code, since, limit, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#wallets-activity-records | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch withdrawals for | | limit | int | No | the maximum number of withdrawals structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchDepositWithdrawFees{docsify-ignore} fetch deposit and withdraw fees **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [fees structures](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://api-docs.poloniex.com/spot/api/public/reference-data#currency-information | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | list of unified currency codes | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchDepositWithdrawFees (codes[, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api-docs.poloniex.com/spot/api/private/wallet#wallets-activity-records | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch deposits for | | limit | int | No | the maximum number of deposits structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchDeposits (code[, since, limit, params]) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - response from the exchange **See**: https://api-docs.poloniex.com/v3/futures/api/positions/set-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | leverage | int | Yes | the rate of leverage | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' | ```javascript poloniex.setLeverage (leverage, symbol[, params]) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure) **See**: https://api-docs.poloniex.com/v3/futures/api/positions/get-leverages | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchLeverage (symbol[, params]) ``` ### fetchPositionMode{docsify-ignore} fetchs the position mode, hedged or one way, hedged for binance is set identically for all linear markets or all inverse markets **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - an object detailing whether the market is in hedged or one-way mode **See**: https://api-docs.poloniex.com/v3/futures/api/positions/position-mode-switch | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.fetchPositionMode (symbol[, params]) ``` ### setPositionMode{docsify-ignore} set hedged to true or false for a market **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - response from the exchange **See**: https://api-docs.poloniex.com/v3/futures/api/positions/position-mode-switch | Param | Type | Required | Description | | --- | --- | --- | --- | | hedged | bool | Yes | set to true to use dualSidePosition | | symbol | string | Yes | not used by binance setPositionMode () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.setPositionMode (hedged, symbol[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [poloniex](#poloniex) **Returns**: Array<object> - a list of [position structures](https://docs.ccxt.com/#/?id=position-structure) **See**: https://api-docs.poloniex.com/v3/futures/api/positions/get-current-position | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | params.standard | boolean | No | whether to fetch standard contract positions | ```javascript poloniex.fetchPositions (symbols[, params]) ``` ### reduceMargin{docsify-ignore} remove margin from a position **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=reduce-margin-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | the amount of margin to remove | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.reduceMargin (symbol, amount[, params]) ``` ### addMargin{docsify-ignore} add margin **Kind**: instance method of [poloniex](#poloniex) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | amount of margin to add | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript poloniex.addMargin (symbol, amount[, params]) ```