coinbaseinternational
coinbaseinternational cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
🔌 Looking for raw exchange endpoints? See the coinbaseinternational implicit API — every endpoint in this exchange's API exposed as an implicit method.
coinbaseinternational
Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchCurrencies
- fetchOHLCV
- fetchFundingRateHistory
- fetchTickers
- fetchTicker
- fetchOrderBook
- fetchBalance
- fetchTransfers
- fetchPosition
- fetchPositions
- fetchDepositsWithdrawals
- fetchWithdrawals
- fetchDeposits
- createOrder
- cancelOrder
- cancelAllOrders
- editOrder
- fetchOrder
- fetchOpenOrders
- fetchMyTrades
- fetchLeverage
- setLeverage
- watchBalance
- watchMyTrades
- unWatchMyTrades
- watchOrders
- watchOrdersForSymbols
- unWatchOrders
- watchPositions
- unWatchPositions
- watchFundingRate
- watchFundingRates
- unWatchFundingRate
- unWatchFundingRates
- watchTicker
- unWatchTicker
- watchTickers
- unWatchTickers
- watchMarkPrice
- watchMarkPrices
- unWatchMarkPrice
- unWatchMarkPrices
- watchBidsAsks
- unWatchBidsAsks
- watchOHLCV
- watchOHLCVForSymbols
- unWatchOHLCV
- unWatchOHLCVForSymbols
- watchTrades
- watchTradesForSymbols
- unWatchTrades
- unWatchTradesForSymbols
- watchOrderBook
- watchOrderBookForSymbols
- unWatchOrderBook
- unWatchOrderBookForSymbols
- createOrderWs
- editOrderWs
- cancelOrderWs
- cancelAllOrdersWs
- fetchOrderWs
- fetchOpenOrdersWs
- fetchOrdersWs
- fetchBalanceWs
- fetchMyTradesWs
- fetchPositionsWs
fetchTime
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of coinbaseinternational
Returns: int - the current integer timestamp in milliseconds from the exchange server
See
- https://docs.cdp.coinbase.com/api-reference/supporting/public-get_time
- https://docs.deribit.com/api-reference/supporting/public-get_time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchTime (params?)fetchMarkets
retrieves data on all markets for coinbaseinternational
Kind: instance method of coinbaseinternational
Returns: Array<object> - an array of objects representing market data
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-get_instruments
- https://docs.deribit.com/api-reference/market-data/public-get_instruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.currency | string | No | settlement currency filter, defaults to any on Deribit |
coinbaseinternational.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of coinbaseinternational
Returns: object - an associative dictionary of currencies
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-get_currencies
- https://docs.deribit.com/api-reference/market-data/public-get_currencies
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchCurrencies (params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of coinbaseinternational
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-get_tradingview_chart_data
- https://docs.deribit.com/api-reference/market-data/public-get_tradingview_chart_data
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| 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 |
coinbaseinternational.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of funding rate structures
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-get_funding_rate_history
- https://docs.deribit.com/api-reference/market-data/public-get_funding_rate_history
| 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 to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.until | int | No | timestamp in ms of the latest funding rate |
| params.paginate | boolean | No | native Deribit automatic pagination is not supported |
coinbaseinternational.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of ticker structures
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-ticker
- https://docs.deribit.com/api-reference/market-data/public-ticker
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchTickers (symbols, params?)fetchTicker
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
Returns: object - a ticker structure
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-ticker
- https://docs.deribit.com/api-reference/market-data/public-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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchTicker (symbol, params?)fetchOrderBook
fetches a market order book
Kind: instance method of coinbaseinternational
Returns: object - an order book structure
See
- https://docs.cdp.coinbase.com/api-reference/market-data/public-get_order_book
- https://docs.deribit.com/api-reference/market-data/public-get_order_book
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| limit | int | No | the maximum number of bids and asks to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchOrderBook (symbol, limit?, params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of coinbaseinternational
Returns: object - a balance structure
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_account_summaries
- https://docs.deribit.com/api-reference/account-management/private-get_account_summaries
- https://docs.deribit.com/api-reference/account-management/private-get_account_summary
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.code | string | No | unified currency code for a native Deribit single account summary |
coinbaseinternational.fetchBalance (params?)fetchTransfers
fetch a history of internal transfers made on an account
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of transfer structures
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_transaction_log
- https://docs.deribit.com/api-reference/account-management/private-get_transaction_log
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.until | int | No | timestamp in ms of the latest transfer to fetch |
| params.continuation | string | No | continuation token for pagination |
coinbaseinternational.fetchTransfers (code, since?, limit?, params?)fetchPosition
fetch data on an open position
Kind: instance method of coinbaseinternational
Returns: object - a position structure
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_position
- https://docs.deribit.com/api-reference/account-management/private-get_position
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchPosition (symbol, params?)fetchPositions
fetch all open positions
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of position structure
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_positions
- https://docs.deribit.com/api-reference/account-management/private-get_positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.currency | string | No | settlement currency filter |
| params.kind | string | No | instrument kind filter |
coinbaseinternational.fetchPositions (symbols?, params?)fetchDepositsWithdrawals
fetch history of deposits and withdrawals
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of transaction structures
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_transaction_log
- https://docs.deribit.com/api-reference/account-management/private-get_transaction_log
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| since | int | No | timestamp in ms of the earliest transaction to fetch |
| limit | int | No | the maximum number of transactions to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.until | int | No | timestamp in ms of the latest transaction to fetch |
| params.query | string | No | transaction-log query filter |
| params.continuation | string | No | continuation token for pagination |
coinbaseinternational.fetchDepositsWithdrawals (code, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of transaction structures
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_transaction_log
- https://docs.deribit.com/api-reference/account-management/private-get_transaction_log
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.until | int | No | timestamp in ms of the latest transaction to fetch |
| params.continuation | string | No | continuation token for pagination |
coinbaseinternational.fetchWithdrawals (code, since?, limit?, params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of transaction structures
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_transaction_log
- https://docs.deribit.com/api-reference/account-management/private-get_transaction_log
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.until | int | No | timestamp in ms of the latest transaction to fetch |
| params.continuation | string | No | continuation token for pagination |
coinbaseinternational.fetchDeposits (code, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-buy
- https://docs.cdp.coinbase.com/api-reference/trading/private-sell
- https://docs.deribit.com/api-reference/trading/private-buy
- https://docs.deribit.com/api-reference/trading/private-sell
| 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 | number of contracts for native Deribit derivatives, otherwise the exchange order amount (base currency for spot) |
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.stopPrice | float | No | alias for triggerPrice |
| 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. |
coinbaseinternational.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order
Kind: instance method of coinbaseinternational
Returns: object - An order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel
- https://docs.deribit.com/api-reference/trading/private-cancel
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | not used by cancelOrder() |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_instrument
- https://docs.deribit.com/api-reference/trading/private-cancel_all
- https://docs.deribit.com/api-reference/trading/private-cancel_all_by_instrument
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.cancelAllOrders (symbol?, params?)editOrder
edit a trade order
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-edit
- https://docs.deribit.com/api-reference/trading/private-edit
| 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 | number of contracts for native Deribit derivatives, otherwise the exchange order amount (base currency for spot) |
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.triggerPrice | float | No | price to trigger stop orders |
coinbaseinternational.editOrder (id, symbol, type, side, amount, price?, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of coinbaseinternational
Returns: object - An order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_state
- https://docs.deribit.com/api-reference/trading/private-get_order_state
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchOrder (id, symbol, params?)fetchOpenOrders
fetches information on all currently open orders
Kind: instance method of coinbaseinternational
Returns: Array<Order> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_open_orders_by_instrument
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.paginate | boolean | No | native Deribit pagination is not supported |
| 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 |
coinbaseinternational.fetchOpenOrders (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of coinbaseinternational
Returns: Array<Trade> - a list of trade structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by-instrument
- https://docs.deribit.com/api-reference/trading/private-get_user_trades_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_user_trades_by_instrument_and_time
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.historical | boolean | No | native Deribit indexed history, excludes recent trades |
| params.until | int | No | native Deribit latest time in ms to fetch trades for |
| params.paginate | boolean | No | native Deribit automatic pagination is not supported |
coinbaseinternational.fetchMyTrades (symbol, since?, limit?, params?)fetchLeverage
fetch the set leverage for a market
Kind: instance method of coinbaseinternational
Returns: object - a leverage structure
See: https://docs.cdp.coinbase.com/api-reference/account-management/private-get_leverage
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route; native route throws NotSupported; get_leverage is gateway-only |
| params.isolated | boolean | No | set to true for isolated margin |
| params.subaccount_id | int | No | The user id for the subaccount, available to retail broker callers, defaults to the authenticated account |
coinbaseinternational.fetchLeverage (symbol, params?)setLeverage
set the level of leverage for a market
Kind: instance method of coinbaseinternational
Returns: object - response from the exchange
See: https://docs.cdp.coinbase.com/api-reference/trading/private-set_leverage
| Param | Type | Required | Description |
|---|---|---|---|
| leverage | int | Yes | the rate of leverage |
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route; native route throws NotSupported; set_leverage is gateway-only |
| params.isolated | boolean | No | set to true for isolated margin |
| params.subaccount_id | int | No | The user id for the subaccount, available to retail broker callers, defaults to the authenticated account |
coinbaseinternational.setLeverage (leverage, symbol, params?)watchBalance
watch balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of coinbaseinternational
Returns: object - a balance structure
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userportfoliocurrency
- https://docs.deribit.com/subscriptions/user/userportfoliocurrency
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.currency | string | No | currency code to watch, default is any |
coinbaseinternational.watchBalance (params?)watchMyTrades
watches trades associated with the user
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of trade structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/usertradesinstrument_nameinterval
- https://docs.deribit.com/subscriptions/trades/tradesinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default raw |
coinbaseinternational.watchMyTrades (symbol?, since?, limit?, params?)unWatchMyTrades
stops watching user trades
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/private-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/private-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchMyTrades (symbol?, params?)watchOrders
watches information on orders made by the user
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameinterval
- https://docs.deribit.com/subscriptions/user/userordersinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| since | int | No | timestamp in ms of the earliest order to fetch |
| limit | int | No | the maximum number of orders to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default raw |
coinbaseinternational.watchOrders (symbol?, since?, limit?, params?)watchOrdersForSymbols
watches information on orders made by the user for multiple symbols
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameinterval
- https://docs.deribit.com/subscriptions/user/userordersinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified market symbols |
| since | int | No | timestamp in ms of the earliest order to fetch |
| limit | int | No | the maximum number of orders to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchOrdersForSymbols (symbols, since?, limit?, params?)unWatchOrders
stops watching user orders
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/private-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/private-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchOrders (symbol?, params?)watchPositions
watches all open positions
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of position structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userchangesinstrument_nameinterval
- https://docs.deribit.com/subscriptions/user/userchangesinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| since | int | No | timestamp in ms of the earliest position to fetch |
| limit | int | No | the maximum number of positions to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default raw |
coinbaseinternational.watchPositions (symbols?, since?, limit?, params?)unWatchPositions
stops watching open positions
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/private-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/private-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchPositions (symbols?, params?)watchFundingRate
watch the current funding rate
Kind: instance method of coinbaseinternational
Returns: object - a funding rate structure
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchFundingRate (symbol, params?)watchFundingRates
watch the funding rate for multiple markets
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of funding rates structures, indexe by market symbols
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | a list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchFundingRates (symbols, params?)unWatchFundingRate
stops watching the funding rate for a symbol
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchFundingRate (symbol, params?)unWatchFundingRates
stops watching funding rates for multiple symbols
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchFundingRates (symbols?, params?)watchTicker
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
Returns: object - a ticker structure
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default 100ms |
coinbaseinternational.watchTicker (symbol?, params?)unWatchTicker
stops watching a ticker
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchTicker (symbol, params?)watchTickers
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
Returns: object - a ticker structure
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default 100ms |
coinbaseinternational.watchTickers (symbols?, params?)unWatchTickers
stops watching tickers
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchTickers (symbols?, params?)watchMarkPrice
watches a mark price for a specific market
Kind: instance method of coinbaseinternational
Returns: object - a ticker structure
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default 100ms |
coinbaseinternational.watchMarkPrice (symbol, params?)watchMarkPrices
watches the mark price for multiple markets
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of ticker structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval
- https://docs.deribit.com/subscriptions/market-data/tickerinstrument_nameinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to watch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
| params.interval | string | No | notification interval, default 100ms |
coinbaseinternational.watchMarkPrices (symbols, params?)unWatchMarkPrice
stops watching the mark price for a symbol
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchMarkPrice (symbol, params?)unWatchMarkPrices
stops watching mark prices for multiple symbols
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchMarkPrices (symbols?, params?)watchBidsAsks
watches best bid & ask for symbols
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of ticker structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/quoteinstrument_name
- https://docs.deribit.com/subscriptions/market-data/quoteinstrument_name
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified symbols of the markets to watch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchBidsAsks (symbols?, params?)unWatchBidsAsks
stops watching best bid & ask for symbols
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchBidsAsks (symbols?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, close price, and the volume of a market
Kind: instance method of coinbaseinternational
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/charttradesinstrument_nameresolution
- https://docs.deribit.com/subscriptions/market-data/charttradesinstrument_nameresolution
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOHLCVForSymbols
watches historical candlestick data for multiple markets and timeframes
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of OHLCV arrays indexed by symbol and timeframe
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/charttradesinstrument_nameresolution
- https://docs.deribit.com/subscriptions/market-data/charttradesinstrument_nameresolution
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes |
| 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.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchOHLCVForSymbols (symbolsAndTimeframes, since?, limit?, params?)unWatchOHLCV
stops watching OHLCV data for a symbol
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| timeframe | string | Yes | the length of time each candle represents |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchOHLCV (symbol, timeframe, params?)unWatchOHLCVForSymbols
stops watching OHLCV data for multiple symbols and timeframes
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchOHLCVForSymbols (symbolsAndTimeframes, params?)watchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of trade structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/trades/tradesinstrument_nameinterval
- https://docs.deribit.com/subscriptions/trades/tradesinstrument_nameinterval
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchTrades (symbol, since?, limit?, params?)watchTradesForSymbols
get the list of most recent trades for a list of symbols
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of trade structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/trades/tradesinstrument_nameinterval
- https://docs.deribit.com/subscriptions/trades/tradesinstrument_nameinterval
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchTradesForSymbols (symbols, since?, limit?, params?)unWatchTrades
stops watching trades for a symbol
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchTrades (symbol, params?)unWatchTradesForSymbols
stops watching trades for multiple symbols
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchTradesForSymbols (symbols, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coinbaseinternational
Returns: object - A dictionary of order book structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_nameinterval
- https://docs.deribit.com/subscriptions/orderbook/bookinstrument_nameinterval
- https://docs.deribit.com/subscriptions/orderbook/bookinstrument_namegroupdepthinterval
| 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 |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchOrderBook (symbol, limit?, params?)watchOrderBookForSymbols
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of coinbaseinternational
Returns: object - A dictionary of order book structures
See
- https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_nameinterval
- https://docs.deribit.com/subscriptions/orderbook/bookinstrument_nameinterval
- https://docs.deribit.com/subscriptions/orderbook/bookinstrument_namegroupdepthinterval
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.watchOrderBookForSymbols (symbols, limit?, params?)unWatchOrderBook
stops watching an order book
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchOrderBook (symbol, params?)unWatchOrderBookForSymbols
stops watching order books for multiple symbols
Kind: instance method of coinbaseinternational
Returns: object - the exchange response
See
- https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe
- https://docs.deribit.com/api-reference/subscription-management/public-unsubscribe
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.unWatchOrderBookForSymbols (symbols, params?)createOrderWs
create a trade order over websocket
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-buy
- https://docs.cdp.coinbase.com/api-reference/trading/private-sell
- https://docs.deribit.com/api-reference/trading/private-buy
- https://docs.deribit.com/api-reference/trading/private-sell
| 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 | number of contracts for native Deribit derivatives, otherwise the exchange order amount (base currency for spot) |
| price | float | No | the price at which the order is to be fulfilled |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.createOrderWs (symbol, type, side, amount, price?, params?)editOrderWs
edit a trade order over websocket
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-edit
- https://docs.deribit.com/api-reference/trading/private-edit
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified market symbol |
| type | string | Yes | not used by coinbaseinternational editOrderWs |
| side | string | Yes | not used by coinbaseinternational editOrderWs |
| amount | float | No | new order amount, in contracts for native Deribit derivatives |
| price | float | No | new order price |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.editOrderWs (id, symbol, type, side, amount?, price?, params?)cancelOrderWs
cancels an open order over websocket
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel
- https://docs.deribit.com/api-reference/trading/private-cancel
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | No | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.cancelOrderWs (id, symbol?, params?)cancelAllOrdersWs
cancels all open orders over websocket
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all
- https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_instrument
- https://docs.deribit.com/api-reference/trading/private-cancel_all
- https://docs.deribit.com/api-reference/trading/private-cancel_all_by_instrument
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.cancelAllOrdersWs (symbol?, params?)fetchOrderWs
fetches an order over websocket
Kind: instance method of coinbaseinternational
Returns: object - an order structure
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_state
- https://docs.deribit.com/api-reference/trading/private-get_order_state
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | No | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchOrderWs (id, symbol?, params?)fetchOpenOrdersWs
fetches open orders over websocket
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_open_orders_by_instrument
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | timestamp in ms of the earliest order |
| limit | int | No | the maximum number of orders to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchOpenOrdersWs (symbol, since?, limit?, params?)fetchOrdersWs
fetches order history over websocket
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_history_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_order_history_by_instrument
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | timestamp in ms of the earliest order |
| limit | int | No | the maximum number of orders to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchOrdersWs (symbol, since?, limit?, params?)fetchBalanceWs
fetches the balance over websocket
Kind: instance method of coinbaseinternational
Returns: object - a balance structure
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_account_summaries
- https://docs.deribit.com/api-reference/account-management/private-get_account_summaries
- https://docs.deribit.com/api-reference/account-management/private-get_account_summary
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchBalanceWs (params?)fetchMyTradesWs
fetches user trades over websocket
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of trade structures
See
- https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_user_trades_by_instrument
- https://docs.deribit.com/api-reference/trading/private-get_user_trades_by_instrument_and_time
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | timestamp in ms of the earliest trade |
| limit | int | No | the maximum number of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchMyTradesWs (symbol, since?, limit?, params?)fetchPositionsWs
fetches open positions over websocket
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of position structures
See
- https://docs.cdp.coinbase.com/api-reference/account-management/private-get_positions
- https://docs.deribit.com/api-reference/account-management/private-get_positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.route | string | No | auto (default), deribit, or coinbase; overrides options.route |
coinbaseinternational.fetchPositionsWs (symbols?, params?)