coinbaseexchange

coinbaseexchange{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchCurrencies
• fetchMarkets
• fetchAccounts
• fetchBalance
• fetchOrderBook
• fetchTickers
• fetchTicker
• fetchMyTrades
• fetchTrades
• fetchTradingFees
• fetchOHLCV
• fetchTime
• fetchOrder
• fetchOrderTrades
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• createOrder
• cancelOrder
• cancelAllOrders
• withdraw
• fetchLedger
• fetchDepositsWithdrawals
• fetchDeposits
• fetchWithdrawals
• createDepositAddress
• watchTicker
• watchTickers
• watchTrades
• watchMyTrades
• watchMyTradesForSymbols
• watchOrdersForSymbols
• watchOrders
• watchOrderBookForSymbols
• watchOrderBook

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of coinbaseexchange
Returns: object - an associative dictionary of currencies

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getcurrencies

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for coinbaseexchange

Kind: instance method of coinbaseexchange
Returns: Array<object> - an array of objects representing market data

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproducts

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchMarkets (params?)

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of coinbaseexchange
Returns: object - a dictionary of account structures indexed by the account type

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccounts

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.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 coinbaseexchange
Returns: object - a balance structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccounts

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchBalance (params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of coinbaseexchange
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproductbook

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

coinbaseexchange.fetchOrderBook (symbol, limit?, 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 coinbaseexchange
Returns: object - a dictionary of ticker structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproduct

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

coinbaseexchange.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 coinbaseexchange
Returns: object - a ticker structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproductticker

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

coinbaseexchange.fetchTicker (symbol, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of coinbaseexchange
Returns: Array<Trade> - a list of trade structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_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
params.until	int	No	the latest time in ms to fetch trades 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

coinbaseexchange.fetchMyTrades (symbol, since?, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of coinbaseexchange
Returns: Array<Trade> - a list of trade structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproducttrades

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

coinbaseexchange.fetchTrades (symbol, since?, limit?, params?)

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of coinbaseexchange
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getfees

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchTradingFees (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 coinbaseexchange
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getproductcandles

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 trades 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

coinbaseexchange.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of coinbaseexchange
Returns: int - the current integer timestamp in milliseconds from the exchange server

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchTime (params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of coinbaseexchange
Returns: object - An order structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getorder

Param	Type	Required	Description
id	string	Yes	the order id
symbol	string	Yes	not used by coinbaseexchange fetchOrder
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.fetchOrder (id, symbol, params?)

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of trade structures

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

coinbaseexchange.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of coinbaseexchange
Returns: Array<Order> - a list of order structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_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
params.until	int	No	the latest time in ms to fetch open orders for

coinbaseexchange.fetchOrders (symbol, since?, limit?, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of coinbaseexchange
Returns: Array<Order> - a list of order structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_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
params.until	int	No	the latest time in ms to fetch open orders 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

coinbaseexchange.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of coinbaseexchange
Returns: Array<Order> - a list of order structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_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
params.until	int	No	the latest time in ms to fetch open orders for

coinbaseexchange.fetchClosedOrders (symbol, since?, limit?, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of coinbaseexchange
Returns: object - an order structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postorders

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

coinbaseexchange.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of coinbaseexchange
Returns: object - An order structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_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

coinbaseexchange.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of order structures

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_deleteorders

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

coinbaseexchange.cancelAllOrders (symbol, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of coinbaseexchange
Returns: object - a transaction structure

See

• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postwithdrawpaymentmethod
• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postwithdrawcoinbaseaccount

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

coinbaseexchange.withdraw (code, amount, address, tag, params?)

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of coinbaseexchange
Returns: object - a ledger structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccountledger

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 entries to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint
params.until	int	No	the latest time in ms to fetch trades for

coinbaseexchange.fetchLedger (code, since?, limit?, params?)

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of coinbaseexchange
Returns: object - a list of transaction structure

See

• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_gettransfers
• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccounttransfers

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
params.id	string	No	account id, when defined, the endpoint used is '/accounts/{account_id}/transfers/' instead of '/transfers/'

coinbaseexchange.fetchDepositsWithdrawals (code?, since?, limit?, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of transaction structures

See

• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_gettransfers
• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccounttransfers

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

coinbaseexchange.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of transaction structures

See

• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_gettransfers
• https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getaccounttransfers

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

coinbaseexchange.fetchWithdrawals (code, since?, limit?, params?)

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of coinbaseexchange
Returns: object - an address structure

See: https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postcoinbaseaccountaddresses

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

coinbaseexchange.createDepositAddress (code, 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 coinbaseexchange
Returns: object - a ticker structure

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

coinbaseexchange.watchTicker (symbol, params?)

watchTickers{docsify-ignore}

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list

Kind: instance method of coinbaseexchange
Returns: object - a ticker structure

Param	Type	Required	Description
symbols	Array<string>	No	unified symbol of the market to fetch the ticker for
params	object	No	extra parameters specific to the exchange API endpoint
params.channel	string	No	the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers

coinbaseexchange.watchTickers (symbols?, params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of trade structures

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

coinbaseexchange.watchTrades (symbol, since?, limit?, params?)

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of trade structures

Param	Type	Required	Description
symbol	string	Yes	unified market symbol of the market trades were made in
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trade structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.watchMyTrades (symbol, since?, limit?, params?)

watchMyTradesForSymbols{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of trade structures

Param	Type	Required	Description
symbols	Array<string>	Yes	unified symbol of the market to fetch trades for
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trade structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.watchMyTradesForSymbols (symbols, since?, limit?, params?)

watchOrdersForSymbols{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of order structures

Param	Type	Required	Description
symbols	Array<string>	Yes	unified symbol of the market to fetch orders for
since	int	No	the earliest time in ms to fetch orders for
limit	int	No	the maximum number of trade structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.watchOrdersForSymbols (symbols, since?, limit?, params?)

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of coinbaseexchange
Returns: Array<object> - a list of order structures

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

coinbaseexchange.watchOrders (symbol, since?, limit?, params?)

watchOrderBookForSymbols{docsify-ignore}

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of coinbaseexchange
Returns: object - A dictionary of order book structures indexed by market symbols

Param	Type	Required	Description
symbols	Array<string>	Yes	unified array of symbols
limit	int	No	the maximum amount of order book entries to return
params	object	No	extra parameters specific to the exchange API endpoint

coinbaseexchange.watchOrderBookForSymbols (symbols, 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 coinbaseexchange
Returns: object - A dictionary of order book structures indexed by market symbols

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

coinbaseexchange.watchOrderBook (symbol, limit?, params?)