## coinbaseinternational{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchAccounts](#fetchaccounts) * [fetchOHLCV](#fetchohlcv) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchFundingHistory](#fetchfundinghistory) * [fetchTransfers](#fetchtransfers) * [createDepositAddress](#createdepositaddress) * [setMargin](#setmargin) * [fetchPosition](#fetchposition) * [fetchPositions](#fetchpositions) * [fetchWithdrawals](#fetchwithdrawals) * [fetchDeposits](#fetchdeposits) * [fetchMarkets](#fetchmarkets) * [fetchCurrencies](#fetchcurrencies) * [fetchTickers](#fetchtickers) * [fetchTicker](#fetchticker) * [fetchBalance](#fetchbalance) * [transfer](#transfer) * [createOrder](#createorder) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [editOrder](#editorder) * [fetchOrder](#fetchorder) * [fetchOpenOrders](#fetchopenorders) * [fetchMyTrades](#fetchmytrades) * [withdraw](#withdraw) * [watchFundingRate](#watchfundingrate) * [watchFundingRates](#watchfundingrates) * [watchTicker](#watchticker) * [watchTickers](#watchtickers) * [watchOHLCV](#watchohlcv) * [watchTrades](#watchtrades) * [watchTradesForSymbols](#watchtradesforsymbols) * [watchOrderBook](#watchorderbook) * [watchOrderBook](#watchorderbook) ### fetchAccounts{docsify-ignore} fetch all the accounts associated with a profile **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a dictionary of [account structures](https://docs.ccxt.com/#/?id=account-structure) indexed by the account type **See**: https://docs.cloud.coinbase.com/intx/reference/getportfolios | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchAccounts ([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 [coinbaseinternational](#coinbaseinternational) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.cdp.coinbase.com/intx/reference/getinstrumentcandles | 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, default 100 max 10000 | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest candle to fetch | | params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [available parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript coinbaseinternational.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **See**: https://docs.cloud.coinbase.com/intx/reference/getinstrumentfunding | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the funding rate history for | | since | int | No | timestamp in ms of the earliest funding rate to fetch | | limit | int | No | the maximum amount of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | 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](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript coinbaseinternational.fetchFundingRateHistory (symbol[, since, limit, params]) ``` ### fetchFundingHistory{docsify-ignore} fetch the history of funding payments paid and received on this account **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [funding history structure](https://docs.ccxt.com/#/?id=funding-history-structure) **See**: https://docs.cdp.coinbase.com/intx/reference/gettransfers | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol | | since | int | No | the earliest time in ms to fetch funding history for | | limit | int | No | the maximum number of funding history structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchFundingHistory ([symbol, since, limit, params]) ``` ### fetchTransfers{docsify-ignore} fetch a history of internal transfers made on an account **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [transfer structures](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://docs.cdp.coinbase.com/intx/reference/gettransfers | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency transferred | | since | int | No | the earliest time in ms to fetch transfers for | | limit | int | No | the maximum number of transfers structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchTransfers (code[, since, limit, params]) ``` ### createDepositAddress{docsify-ignore} create a currency deposit address **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See** - https://docs.cloud.coinbase.com/intx/reference/createaddress - https://docs.cloud.coinbase.com/intx/reference/createcounterpartyid | 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 | | params.network_arn_id | string | No | Identifies the blockchain network (e.g., networks/ethereum-mainnet/assets/313ef8a9-ae5a-5f2f-8a56-572c0e2a4d5a) if not provided will pick default | | params.network | string | No | unified network code to identify the blockchain network | ```javascript coinbaseinternational.createDepositAddress (code[, params]) ``` ### setMargin{docsify-ignore} Either adds or reduces margin in order to set the margin to a specific value **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - A [margin structure](https://github.com/ccxt/ccxt/wiki/Manual#add-margin-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/setportfoliomarginoverride | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market to set margin in | | amount | float | Yes | the amount to set the margin to | | params | object | No | parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.setMargin (symbol, amount[, params]) ``` ### fetchPosition{docsify-ignore} fetch data on an open position **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getportfolioposition | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market the position is held in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchPosition (symbol[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getportfoliopositions | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | method | string | No | method name to call, "positionRisk", "account" or "option", default is "positionRisk" | ```javascript coinbaseinternational.fetchPositions ([symbols, params, method]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/gettransfers | 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 | | params.portfolios | string | No | Identifies the portfolios by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175). Can provide single or multiple portfolios to filter by or fetches transfers for all portfolios if none are provided. | | params.until | int | No | Only find transfers updated before this time. Use timestamp format | | params.status | string | No | The current status of transfer. Possible values: [PROCESSED, NEW, FAILED, STARTED] | | params.type | string | No | The type of transfer Possible values: [DEPOSIT, WITHDRAW, REBATE, STIPEND, INTERNAL, FUNDING] | | 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](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript coinbaseinternational.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) | 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 | | params.portfolios | string | No | Identifies the portfolios by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175). Can provide single or multiple portfolios to filter by or fetches transfers for all portfolios if none are provided. | | params.until | int | No | Only find transfers updated before this time. Use timestamp format | | params.status | string | No | The current status of transfer. Possible values: [PROCESSED, NEW, FAILED, STARTED] | | params.type | string | No | The type of transfer Possible values: [DEPOSIT, WITHDRAW, REBATE, STIPEND, INTERNAL, FUNDING] | | 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](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript coinbaseinternational.fetchDeposits (code[, since, limit, params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for coinbaseinternational **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - an array of objects representing market data **See**: https://docs.cloud.coinbase.com/intx/reference/getinstruments | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchMarkets ([params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - an associative dictionary of currencies **See**: https://docs.cloud.coinbase.com/intx/reference/getassets | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchCurrencies ([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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getinstruments | 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 coinbaseinternational.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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getinstrumentquote | 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 coinbaseinternational.fetchTicker (symbol[, 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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getportfoliobalances | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | | params.v3 | boolean | No | default false, set true to use v3 api endpoint | ```javascript coinbaseinternational.fetchBalance ([params]) ``` ### transfer{docsify-ignore} Transfer an amount of asset from one portfolio to another. **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [transfer structure](https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/createportfolioassettransfer | 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 coinbaseinternational.transfer (code, amount, fromAccount, toAccount[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/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 you want to trade in units of the base currency, quote currency for 'market' 'buy' orders | | price | float | No | the price to fulfill the order, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.stopPrice | float | No | price to trigger stop orders | | params.triggerPrice | float | No | price to trigger stop orders | | params.stopLossPrice | float | No | price to trigger stop-loss orders | | params.postOnly | bool | No | true or false | | params.tif | string | No | 'GTC', 'IOC', 'GTD' default is 'GTC' for limit orders and 'IOC' for market orders | | params.expire_time | string | No | The expiration time required for orders with the time in force set to GTT. Must not go beyond 30 days of the current time. Uses ISO-8601 format (e.g., 2023-03-16T23:59:53Z) | | params.stp_mode | string | No | Possible values: [NONE, AGGRESSING, BOTH] Specifies the behavior for self match handling. None disables the functionality, new cancels the newest order, and both cancels both orders. | ```javascript coinbaseinternational.createOrder (symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/cancelorder | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | not used by coinbaseinternational cancelOrder() | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.cancelOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | 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 | ```javascript coinbaseinternational.cancelAllOrders (symbol[, params]) ``` ### editOrder{docsify-ignore} edit a trade order **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/modifyorder | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | cancel order id | | 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 | | params.clientOrderId | string | Yes | client order id | ```javascript coinbaseinternational.editOrder (id, symbol, type, side, amount[, price, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/modifyorder | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the order id | | symbol | string | Yes | unified market symbol that the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.fetchOrder (id, symbol[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetches information on all currently open orders **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getorders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the orders | | since | int | No | timestamp in ms of the earliest order, default is undefined | | limit | int | No | the maximum number of open order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | 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](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | | params.offset | int | No | offset | | params.event_type | string | No | The most recent type of event that happened to the order. Allowed values: NEW, TRADE, REPLACED | ```javascript coinbaseinternational.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://docs.cloud.coinbase.com/intx/reference/getmultiportfoliofills | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the trades | | since | int | No | timestamp in ms of the earliest order, default is undefined | | limit | int | No | the maximum number of trade structures 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](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript coinbaseinternational.fetchMyTrades (symbol[, since, limit, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See** - https://docs.cloud.coinbase.com/intx/reference/withdraw - https://docs.cloud.coinbase.com/intx/reference/counterpartywithdraw | 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 | No | an optional tag for the withdrawal | | params | object | No | extra parameters specific to the exchange API endpoint | | params.add_network_fee_to_total | boolean | No | if true, deducts network fee from the portfolio, otherwise deduct fee from the withdrawal | | params.network_arn_id | string | No | Identifies the blockchain network (e.g., networks/ethereum-mainnet/assets/313ef8a9-ae5a-5f2f-8a56-572c0e2a4d5a) | | params.nonce | string | No | a unique integer representing the withdrawal request | ```javascript coinbaseinternational.withdraw (code, amount, address[, tag, params]) ``` ### watchFundingRate{docsify-ignore} watch the current funding rate **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#funding-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.watchFundingRate (symbol[, params]) ``` ### watchFundingRates{docsify-ignore} watch the funding rate for multiple markets **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: object - a dictionary of [funding rates structures](https://docs.ccxt.com/#/?id=funding-rates-structure), indexe by market symbols **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#funding-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript coinbaseinternational.watchFundingRates (symbols[, 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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#instruments-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | 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 watch, 'LEVEL1' or 'INSTRUMENTS', default is 'LEVEL1' | ```javascript coinbaseinternational.watchTicker ([symbol, params]) ``` ### watchTickers{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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#instruments-channel | 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 watch, 'LEVEL1' or 'INSTRUMENTS', default is 'INSTLEVEL1UMENTS' | ```javascript coinbaseinternational.watchTickers ([symbols, params]) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, close price, and the volume of a market **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.cdp.coinbase.com/intx/docs/websocket-channels#candles-channel | 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 | ```javascript coinbaseinternational.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#match-channel | 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 coinbaseinternational.watchTrades (symbol[, since, limit, params]) ``` ### watchTradesForSymbols{docsify-ignore} get the list of most recent trades for a list of symbols **Kind**: instance method of [coinbaseinternational](#coinbaseinternational) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<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 coinbaseinternational.watchTradesForSymbols (symbols[, 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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#level2-channel | 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 coinbaseinternational.watchOrderBook (symbol[, 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 [coinbaseinternational](#coinbaseinternational) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://docs.cloud.coinbase.com/intx/docs/websocket-channels#level2-channel | 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 coinbaseinternational.watchOrderBook (symbol[, limit, params]) ```