## coinlist{docsify-ignore}
**Kind**: global class
**Extends**: Exchange
* [fetchTime](#fetchtime)
* [fetchCurrencies](#fetchcurrencies)
* [fetchMarkets](#fetchmarkets)
* [fetchTickers](#fetchtickers)
* [fetchTicker](#fetchticker)
* [fetchOrderBook](#fetchorderbook)
* [fetchOHLCV](#fetchohlcv)
* [fetchTrades](#fetchtrades)
* [fetchTradingFees](#fetchtradingfees)
* [fetchAccounts](#fetchaccounts)
* [fetchBalance](#fetchbalance)
* [fetchMyTrades](#fetchmytrades)
* [fetchOrderTrades](#fetchordertrades)
* [fetchOrders](#fetchorders)
* [fetchOrder](#fetchorder)
* [fetchOpenOrders](#fetchopenorders)
* [fetchClosedOrders](#fetchclosedorders)
* [fetchCanceledOrders](#fetchcanceledorders)
* [cancelAllOrders](#cancelallorders)
* [cancelOrder](#cancelorder)
* [cancelOrders](#cancelorders)
* [createOrder](#createorder)
* [editOrder](#editorder)
* [transfer](#transfer)
* [fetchTransfers](#fetchtransfers)
* [fetchDepositsWithdrawals](#fetchdepositswithdrawals)
* [withdraw](#withdraw)
* [fetchLedger](#fetchledger)
### fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: int
- the current integer timestamp in milliseconds from the exchange server
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-system-time
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchTime ([params])
```
### fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- an associative dictionary of currencies
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-supported-assets
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchCurrencies ([params])
```
### fetchMarkets{docsify-ignore}
retrieves data on all markets for coinlist
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<object>
- an array of objects representing market data
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-symbols
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchMarkets ([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 [coinlist
](#coinlist)
**Returns**: object
- a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-symbol-summaries
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
| No | 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
coinlist.fetchTickers ([symbols, 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 [coinlist
](#coinlist)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-market-summary
| 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
coinlist.fetchTicker (symbol[, params])
```
### fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-order-book-level-2
| 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 (default 100, max 200) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchOrderBook (symbol[, limit, params])
```
### 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 [coinlist
](#coinlist)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-candles
| 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 | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchOHLCV (symbol, timeframe[, since, limit, params])
```
### fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<Trade>
- a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-auctions
| 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 (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchTrades (symbol[, since, limit, params])
```
### fetchTradingFees{docsify-ignore}
fetch the trading fees for multiple markets
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-fees
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchTradingFees ([params])
```
### fetchAccounts{docsify-ignore}
fetch all the accounts associated with a profile
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a dictionary of [account structures](https://docs.ccxt.com/#/?id=account-structure) indexed by the account type
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-accounts
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchAccounts ([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 [coinlist
](#coinlist)
**Returns**: object
- a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-balances
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchBalance ([params])
```
### fetchMyTrades{docsify-ignore}
fetch all trades made by the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<Trade>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-fills
| 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 (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchMyTrades (symbol[, since, limit, params])
```
### fetchOrderTrades{docsify-ignore}
fetch all the trades made from a single order
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-fills
| 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
coinlist.fetchOrderTrades (id, symbol[, since, limit, params])
```
### fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-orders
| 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 (default 200, max 500) |
| 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.status | string
, Array<string>
| No | the status of the order - 'accepted', 'done', 'canceled', 'rejected', 'pending' (default [ 'accepted', 'done', 'canceled', 'rejected', 'pending' ]) |
```javascript
coinlist.fetchOrders (symbol[, since, limit, params])
```
### fetchOrder{docsify-ignore}
fetches information on an order made by the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-specific-order-by-id
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | int
, string
| Yes | order id |
| symbol | string
| Yes | not used by coinlist fetchOrder () |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchOrder (id, symbol[, params])
```
### fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-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 order structures to retrieve (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchOpenOrders (symbol[, since, limit, params])
```
### fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-orders
| 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 closed order structures to retrieve (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchClosedOrders (symbol[, since, limit, params])
```
### fetchCanceledOrders{docsify-ignore}
fetches information on multiple canceled orders made by the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-orders
| 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 canceled order structures to retrieve (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchCanceledOrders (symbol[, since, limit, params])
```
### cancelAllOrders{docsify-ignore}
cancel open orders of market
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#cancel-all-orders
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.cancelAllOrders (symbol[, params])
```
### cancelOrder{docsify-ignore}
cancels an open order
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#cancel-specific-order-by-id
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | order id |
| symbol | string
| Yes | not used by coinlist cancelOrder () |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.cancelOrder (id, symbol[, params])
```
### cancelOrders{docsify-ignore}
cancel multiple orders
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- an list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#cancel-specific-orders
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| ids | Array<string>
| Yes | order ids |
| symbol | string
| Yes | not used by coinlist cancelOrders () |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.cancelOrders (ids, symbol[, params])
```
### createOrder{docsify-ignore}
create a trade order
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#create-new-order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' or 'stop_market' or 'stop_limit' or 'take_market' or 'take_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.postOnly | bool
| No | if true, the order will only be posted to the order book and not executed immediately (default false) |
| params.triggerPrice | float
| No | only for the 'stop_market', 'stop_limit', 'take_market' or 'take_limit' orders (the price at which an order is triggered) |
| params.clientOrderId | string
| No | client order id (default undefined) |
```javascript
coinlist.createOrder (symbol, type, side, amount[, price, params])
```
### editOrder{docsify-ignore}
create a trade order
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#modify-existing-order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' or 'stop_market' or 'stop_limit' or 'take_market' or 'take_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 |
```javascript
coinlist.editOrder (symbol, type, side, amount[, price, params])
```
### transfer{docsify-ignore}
transfer currency internally between wallets on the same account
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure)
**See**
- https://trade-docs.coinlist.co/?javascript--nodejs#transfer-funds-between-entities
- https://trade-docs.coinlist.co/?javascript--nodejs#transfer-funds-from-wallet-to-pro
- https://trade-docs.coinlist.co/?javascript--nodejs#transfer-funds-from-pro-to-wallet
| 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
coinlist.transfer (code, amount, fromAccount, toAccount[, params])
```
### fetchTransfers{docsify-ignore}
fetch a history of internal transfers between CoinList.co and CoinList Pro. It does not return external deposits or withdrawals
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: Array<object>
- a list of [transfer structures](https://docs.ccxt.com/#/?id=transfer-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#list-transfers
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| since | int
| No | the earliest time in ms to fetch transfers for |
| limit | int
| No | the maximum number of transfer structures to retrieve (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchTransfers (code[, since, limit, params])
```
### fetchDepositsWithdrawals{docsify-ignore}
fetch history of deposits and withdrawals from external wallets and between CoinList Pro trading account and CoinList wallet
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a list of [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-coinlist-wallet-ledger
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| No | unified currency code for the currency of the deposit/withdrawals |
| since | int
| No | timestamp in ms of the earliest deposit/withdrawal |
| limit | int
| No | max number of deposit/withdrawals to return (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
coinlist.fetchDepositsWithdrawals ([code, since, limit, params])
```
### withdraw{docsify-ignore}
request a withdrawal from CoinList wallet. (Disabled by default. Contact CoinList to apply for an exception.)
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#request-withdrawal-from-wallet
| 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
coinlist.withdraw (code, amount, address, tag[, params])
```
### fetchLedger{docsify-ignore}
fetch the history of changes, actions done by the user or operations that altered balance of the user
**Kind**: instance method of [coinlist
](#coinlist)
**Returns**: object
- a [ledger structure](https://docs.ccxt.com/#/?id=ledger-structure)
**See**: https://trade-docs.coinlist.co/?javascript--nodejs#get-account-history
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code, default is undefined |
| since | int
| No | timestamp in ms of the earliest ledger entry, default is undefined |
| limit | int
| No | max number of ledger entrys to return (default 200, max 500) |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
coinlist.fetchLedger (code[, since, limit, params])
```