coinbaseinternational
coinbaseinternational cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
coinbaseinternational
Kind: global class
Extends: Exchange
- fetchAccounts
- fetchOHLCV
- fetchFundingRateHistory
- fetchFundingHistory
- fetchTransfers
- createDepositAddress
- setMargin
- fetchPosition
- fetchPositions
- fetchWithdrawals
- fetchDeposits
- fetchMarkets
- fetchCurrencies
- fetchTickers
- fetchTicker
- fetchBalance
- transfer
- createOrder
- cancelOrder
- cancelAllOrders
- editOrder
- fetchOrder
- fetchOpenOrders
- fetchMyTrades
- withdraw
fetchAccounts
fetch all the accounts associated with a profile
Kind: instance method of coinbaseinternational
Returns: object - a dictionary of account structures 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 |
coinbaseinternational.fetchAccounts (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/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 |
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.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 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 |
coinbaseinternational.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchFundingHistory
fetch the history of funding payments paid and received on this account
Kind: instance method of coinbaseinternational
Returns: object - a 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 |
coinbaseinternational.fetchFundingHistory (symbol?, since?, limit?, 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/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 |
coinbaseinternational.fetchTransfers (code, since?, limit?, params?)createDepositAddress
create a currency deposit address
Kind: instance method of coinbaseinternational
Returns: object - an 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 |
coinbaseinternational.createDepositAddress (code, params?)setMargin
Either adds or reduces margin in order to set the margin to a specific value
Kind: instance method of coinbaseinternational
Returns: object - A 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 |
coinbaseinternational.setMargin (symbol, amount, params?)fetchPosition
fetch data on an open position
Kind: instance method of coinbaseinternational
Returns: object - a 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 |
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.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 |
coinbaseinternational.fetchPositions (symbols?, 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.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 |
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
| 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 |
coinbaseinternational.fetchDeposits (code, since?, limit?, 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.cloud.coinbase.com/intx/reference/getinstruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
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.cloud.coinbase.com/intx/reference/getassets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
coinbaseinternational.fetchCurrencies (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.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 |
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.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 |
coinbaseinternational.fetchTicker (symbol, 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.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 |
coinbaseinternational.fetchBalance (params?)transfer
Transfer an amount of asset from one portfolio to another.
Kind: instance method of coinbaseinternational
Returns: object - a 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 |
coinbaseinternational.transfer (code, amount, fromAccount, toAccount, params?)createOrder
create a trade order
Kind: instance method of coinbaseinternational
Returns: object - an 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 | 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.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 |
coinbaseinternational.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of coinbaseinternational
Returns: Array<object> - a list of order structures
| 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 |
coinbaseinternational.cancelAllOrders (symbol, params?)editOrder
edit a trade order
Kind: instance method of coinbaseinternational
Returns: object - an 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 |
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.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 |
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.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 |
| 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.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 |
coinbaseinternational.fetchMyTrades (symbol, since?, limit?, params?)withdraw
make a withdrawal
Kind: instance method of coinbaseinternational
Returns: object - a 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 |
coinbaseinternational.withdraw (code, amount, address, tag?, params?)