ContextQMD
Back to Ccxt

Coinbaseexchange

wiki/exchanges/coinbaseexchange.md

4.5.7324.8 KB
Original Source

<a name="coinbaseexchange" id="coinbaseexchange"></a>

coinbaseexchange{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="coinbaseexchange" id="coinbaseexchange"></a>

coinbaseexchange{docsify-ignore}

This is the institutional Coinbase Exchange API class (exchange.coinbase.com), the venue formerly served by Coinbase Pro's backend. Credentials for it are issued through Coinbase's Exchange API program and are separate from regular coinbase.com keys - retail Coinbase.com / Advanced Trade accounts should use the coinbase class instead. For Coinbase International derivatives see coinbaseinternational.

javascript
coinbaseexchange.coinbaseexchange ()

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - an associative dictionary of currencies

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchCurrencies (params?)

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for coinbaseexchange

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

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchMarkets (params?)

<a name="fetchAccounts" id="fetchaccounts"></a>

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

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

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchAccounts (params?)

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - a balance structure

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchBalance (params?)

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - an order book structure

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchOrderBook (symbol, limit?, params?)

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - a dictionary of ticker structures

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

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchTickers (symbols, params?)

<a name="fetchTicker" id="fetchticker"></a>

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchTicker (symbol, params?)

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch trades for
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
coinbaseexchange.fetchMyTrades (symbol, since?, limit?, params?)

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchTrades (symbol, since?, limit?, params?)

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchTradingFees (params?)

<a name="fetchOHLCV" id="fetchohlcv"></a>

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch trades for
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
coinbaseexchange.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchTime (params?)

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - An order structure

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

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id
symbol<code>string</code>Yesnot used by coinbaseexchange fetchOrder
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchOrder (id, symbol, params?)

<a name="fetchOrderTrades" id="fetchordertrades"></a>

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchOrderTrades (id, symbol, since?, limit?, params?)

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch open orders for
javascript
coinbaseexchange.fetchOrders (symbol, since?, limit?, params?)

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch open orders for
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
coinbaseexchange.fetchOpenOrders (symbol, since?, limit?, params?)

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch open orders for
javascript
coinbaseexchange.fetchClosedOrders (symbol, since?, limit?, params?)

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - an order structure

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified 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>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.createOrder (symbol, type, side, amount, price?, params?)

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - An order structure

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

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.cancelOrder (id, symbol, params?)

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Nounified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.cancelAllOrders (symbol?, params?)

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - a transaction structure

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.withdraw (code, amount, address, tag, params?)

<a name="fetchLedger" id="fetchledger"></a>

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 <code>coinbaseexchange</code>
Returns: <code>object</code> - a ledger structure

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code, default is undefined
since<code>int</code>Notimestamp in ms of the earliest ledger entry, default is undefined
limit<code>int</code>Nomax number of ledger entries to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch trades for
javascript
coinbaseexchange.fetchLedger (code, since?, limit?, params?)

<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - a list of transaction structure

See

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code for the currency of the deposit/withdrawals, default is undefined
since<code>int</code>Notimestamp in ms of the earliest deposit/withdrawal, default is undefined
limit<code>int</code>Nomax number of deposit/withdrawals to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.id<code>string</code>Noaccount id, when defined, the endpoint used is '/accounts/{account_id}/transfers/' instead of '/transfers/'
javascript
coinbaseexchange.fetchDepositsWithdrawals (code?, since?, limit?, params?)

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchDeposits (code, since?, limit?, params?)

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.fetchWithdrawals (code, since?, limit?, params?)

<a name="createDepositAddress" id="createdepositaddress"></a>

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of <code>coinbaseexchange</code>
Returns: <code>object</code> - an address structure

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
coinbaseexchange.createDepositAddress (code, params?)