## blockchaincom{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchMarkets](#fetchmarkets) * [fetchOrderBook](#fetchorderbook) * [fetchL3OrderBook](#fetchl3orderbook) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [createOrder](#createorder) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [fetchTradingFees](#fetchtradingfees) * [fetchCanceledOrders](#fetchcanceledorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchOpenOrders](#fetchopenorders) * [fetchMyTrades](#fetchmytrades) * [fetchDepositAddress](#fetchdepositaddress) * [withdraw](#withdraw) * [fetchWithdrawals](#fetchwithdrawals) * [fetchWithdrawal](#fetchwithdrawal) * [fetchDeposits](#fetchdeposits) * [fetchDeposit](#fetchdeposit) * [fetchBalance](#fetchbalance) * [fetchOrder](#fetchorder) * [watchBalance](#watchbalance) * [watchOHLCV](#watchohlcv) * [watchTicker](#watchticker) * [watchTrades](#watchtrades) * [fetchOrders](#fetchorders) * [watchOrderBook](#watchorderbook) ### fetchMarkets{docsify-ignore} retrieves data on all markets for blockchaincom **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<object> - an array of objects representing market data **See**: https://api.blockchain.com/v3/#getsymbols | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchMarkets ([params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://api.blockchain.com/v3/#getl3orderbook | 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 blockchaincom.fetchOrderBook (symbol[, limit, params]) ``` ### fetchL3OrderBook{docsify-ignore} fetches level 3 information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - an [order book structure](https://docs.ccxt.com/#/?id=order-book-structure) **See**: https://api.blockchain.com/v3/#getl3orderbook | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | limit | int | No | max number of orders to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchL3OrderBook (symbol[, limit, 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 [blockchaincom](#blockchaincom) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.blockchain.com/v3/#gettickerbysymbol | 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 blockchaincom.fetchTicker (symbol[, 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 [blockchaincom](#blockchaincom) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.blockchain.com/v3/#gettickers | 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 blockchaincom.fetchTickers (symbols[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#createorder | 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 | ```javascript blockchaincom.createOrder (symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#deleteorder | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.cancelOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#deleteallorders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market to cancel orders in, all markets are used if undefined, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.cancelAllOrders (symbol[, params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See**: https://api.blockchain.com/v3/#getfees | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchTradingFees ([params]) ``` ### fetchCanceledOrders{docsify-ignore} fetches information on multiple canceled orders made by the user **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#getorders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | timestamp in ms of the earliest order, default is undefined | | limit | int | No | max number of orders to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchCanceledOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#getorders | 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 | ```javascript blockchaincom.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#getorders | 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 | ```javascript blockchaincom.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://api.blockchain.com/v3/#getfills | 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 | ```javascript blockchaincom.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://api.blockchain.com/v3/#getdepositaddress | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchDepositAddress (code[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.blockchain.com/v3/#createwithdrawal | 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 blockchaincom.withdraw (code, amount, address, tag[, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.blockchain.com/v3/#getwithdrawals | 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 blockchaincom.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchWithdrawal{docsify-ignore} fetch data on a currency withdrawal via the withdrawal id **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.blockchain.com/v3/#getwithdrawalbyid | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | withdrawal id | | code | string | Yes | not used by blockchaincom.fetchWithdrawal | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchWithdrawal (id, code[, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.blockchain.com/v3/#getdeposits | 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 blockchaincom.fetchDeposits (code[, since, limit, params]) ``` ### fetchDeposit{docsify-ignore} fetch information on a deposit **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.blockchain.com/v3/#getdepositbyid | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | deposit id | | code | string | Yes | not used by blockchaincom fetchDeposit () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchDeposit (id, code[, 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 [blockchaincom](#blockchaincom) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://api.blockchain.com/v3/#getaccounts | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchBalance ([params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.blockchain.com/v3/#getorderbyid | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the order id | | symbol | string | Yes | not used by blockchaincom fetchOrder | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.fetchOrder (id, symbol[, params]) ``` ### watchBalance{docsify-ignore} watch balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://exchange.blockchain.com/api/#balances | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript blockchaincom.watchBalance ([params]) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market. **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://exchange.blockchain.com/api/#prices | 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. Allows '1m', '5m', '15m', '1h', '6h' '1d'. Can only watch one timeframe per symbol. | | 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 | ```javascript blockchaincom.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### watchTicker{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://exchange.blockchain.com/api/#ticker | 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 blockchaincom.watchTicker (symbol[, params]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://exchange.blockchain.com/api/#trades | 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 blockchaincom.watchTrades (symbol[, since, limit, params]) ``` ### fetchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://exchange.blockchain.com/api/#mass-order-status-request-ordermassstatusrequest | 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 | ```javascript blockchaincom.fetchOrders (symbol[, since, limit, params]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [blockchaincom](#blockchaincom) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://exchange.blockchain.com/api/#l2-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 | objectConstructor | No | extra parameters specific to the exchange API endpoint | | params.type | string | No | accepts l2 or l3 for level 2 or level 3 order book | ```javascript blockchaincom.watchOrderBook (symbol[, limit, params]) ```