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