Class: CBInternationalClient
Legacy REST client for api.international.coinbase.com. Coinbase migrated institutional INTX accounts to Deribit on 1 October 2026. The migrated INTX accounts are view-only and legacy endpoints no longer support trading. Coinbase promises historical trade and order data access for approximately 12 months after migration; this is not a guarantee for every retained method. See the institutional migration FAQ and legacy INTX guide.
Extends
BaseRestClient
Constructors
Constructor
new CBInternationalClient(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig): CBInternationalClient;Parameters
| Parameter | Type |
|---|---|
restClientOptions? | RestClientOptions |
requestOptions? | AxiosRequestConfig |
Returns
CBInternationalClient
Overrides
BaseRestClient.constructor
Methods
acquireOrRepayLoan()
acquireOrRepayLoan(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/{portfolio}/loans/{asset} on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { action: "ACQUIRE" | "REPAY"; amount: number; asset: string; portfolio: string; } |
params.action | "ACQUIRE" | "REPAY" |
params.amount | number |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
cancelOrder()
cancelOrder(params: object): Promise<any>;Legacy SDK wrapper for authenticated DELETE /api/v1/orders/{id} on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | { id: string; portfolio: string; } |
params.id | string |
params.portfolio | string |
Returns
Promise<any>
cancelOrders()
cancelOrders(params: CancelINTXOrdersRequest): Promise<any>;Legacy SDK wrapper for authenticated DELETE /api/v1/orders on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | CancelINTXOrdersRequest |
Returns
Promise<any>
createCounterpartyId()
createCounterpartyId(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/transfers/create-counterparty-id on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
createCryptoAddress()
createCryptoAddress(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/transfers/address on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; network_arn_id: string; portfolio: string; } |
params.asset | string |
params.network_arn_id | string |
params.portfolio | string |
Returns
Promise<any>
createPortfolio()
createPortfolio(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body. The SDK requires a name string; it does not enforce an account portfolio limit locally.
Parameters
| Parameter | Type |
|---|---|
params | { name: string; } |
params.name | string |
Returns
Promise<any>
deletePrivate()
deletePrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
generateNewOrderId()
generateNewOrderId(): string;Returns
string
Inherited from
BaseRestClient.generateNewOrderId
get()
get(endpoint: string, params?: object): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | object |
Returns
Promise<any>
Inherited from
BaseRestClient.get
getActiveLoansForPortfolio()
getActiveLoansForPortfolio(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/loans on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getAggregatedCandlesData()
getAggregatedCandlesData(params: GetINTXAggregatedCandlesData): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments/{instrument}/candles on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | GetINTXAggregatedCandlesData |
Returns
Promise<any>
getAssetDetails()
getAssetDetails(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/assets/{asset} on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; } |
params.asset | string |
Returns
Promise<any>
getAssets()
getAssets(): Promise<any>;Legacy SDK wrapper for GET /api/v1/assets on the International Exchange REST endpoint.
Returns
Promise<any>
getBalanceForPortfolioAsset()
getBalanceForPortfolioAsset(params: object): Promise<any>;Get balance for portfolio/asset
Retrieves the balance for a given portfolio and asset.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; portfolio: string; } |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getCounterpartyWithdrawalLimit()
getCounterpartyWithdrawalLimit(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/transfers/withdraw/{portfolio}/{asset}/counterparty-withdrawal-limit on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; portfolio: string; } |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
getDailyTradingVolumes()
getDailyTradingVolumes(params: GetINTXDailyTradingVolumes): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments/volumes/daily on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | GetINTXDailyTradingVolumes |
Returns
Promise<any>
getFeeRateTiers()
getFeeRateTiers(): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/fee-rate-tiers on the International Exchange REST endpoint.
Returns
Promise<any>
getFillsByPortfolios()
getFillsByPortfolios(params?: GetINTXFillsByPortfoliosRequest): Promise<any>;List fills by portfolios
Returns fills for specified portfolios or fills for all portfolios if none are provided.
Parameters
| Parameter | Type |
|---|---|
params? | GetINTXFillsByPortfoliosRequest |
Returns
Promise<any>
getFundTransferLimit()
getFundTransferLimit(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/transfer/{portfolio}/{asset}/transfer-limit on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; portfolio: string; } |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
getHistoricalFundingRates()
getHistoricalFundingRates(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments/{instrument}/funding on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | { instrument: string; result_limit?: number; result_offset?: number; } |
params.instrument | string |
params.result_limit? | number |
params.result_offset? | number |
Returns
Promise<any>
getIndexCandles()
getIndexCandles(params: GetINTXIndexCandlesRequest): Promise<any>;Legacy SDK wrapper for GET /api/v1/index/{index}/candles on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | GetINTXIndexCandlesRequest |
Returns
Promise<any>
getIndexComposition()
getIndexComposition(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/index/{index}/composition on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { index: string; } |
params.index | string |
Returns
Promise<any>
getIndexCompositionHistory()
getIndexCompositionHistory(params: GetINTXIndexCompositionHistory): Promise<any>;Legacy SDK wrapper for GET /api/v1/index/{index}/composition-history on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | GetINTXIndexCompositionHistory |
Returns
Promise<any>
getIndexPrice()
getIndexPrice(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/index/{index}/price on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { index: string; } |
params.index | string |
Returns
Promise<any>
getInstrumentDetails()
getInstrumentDetails(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments/{instrument} on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { instrument: string; } |
params.instrument | string |
Returns
Promise<any>
getInstruments()
getInstruments(): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments on the International Exchange REST endpoint.
Returns
Promise<any>
getLoanInfoForPortfolioAsset()
getLoanInfoForPortfolioAsset(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/loans/{asset} on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; portfolio: string; } |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
getMatchingTransfers()
getMatchingTransfers(params?: GetINTXMatchingTransfersRequest): Promise<any>;List matching transfers
List matching transfers.
Parameters
| Parameter | Type |
|---|---|
params? | GetINTXMatchingTransfersRequest |
Returns
Promise<any>
getMaxLoanAvailability()
getMaxLoanAvailability(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/loans/{asset}/availability on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; portfolio: string; } |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
getOpenOrders()
getOpenOrders(params?: GetINTXOpenOrdersRequest): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/orders on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params? | GetINTXOpenOrdersRequest |
Returns
Promise<any>
getOpenPositionLimitsForAllInstruments()
getOpenPositionLimitsForAllInstruments(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/position-limits/positions on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getOpenPositionLimitsForInstrument()
getOpenPositionLimitsForInstrument(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/position-limits/positions/{instrument} on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { instrument: string; portfolio: string; } |
params.instrument | string |
params.portfolio | string |
Returns
Promise<any>
getOrderDetails()
getOrderDetails(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/orders/{id} on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | { id: string; portfolio: string; } |
params.id | string |
params.portfolio | string |
Returns
Promise<any>
getPortfolioBalances()
getPortfolioBalances(params: object): Promise<any>;List portfolio balances
Returns all of the balances for a given portfolio.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getPortfolioDetails()
getPortfolioDetails(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/detail on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getPortfolioFeeRates()
getPortfolioFeeRates(): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/fee-rates on the International Exchange REST endpoint.
Returns
Promise<any>
getPortfolioFills()
getPortfolioFills(params: GetINTXPortfolioFillsRequest): Promise<any>;List portfolio fills
Returns all of the fills for a given portfolio.
Parameters
| Parameter | Type |
|---|---|
params | GetINTXPortfolioFillsRequest |
Returns
Promise<any>
getPortfolioPositions()
getPortfolioPositions(params: object): Promise<any>;List portfolio positions
Returns all of the positions for a given portfolio.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getPortfolioSummary()
getPortfolioSummary(params: object): Promise<any>;Get portfolio summary
Retrieves the high level overview of a portfolio.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getPositionForPortfolioInstrument()
getPositionForPortfolioInstrument(params: object): Promise<any>;Get position for portfolio/instrument
Retrieves the position for a given portfolio and symbol.
Parameters
| Parameter | Type |
|---|---|
params | { instrument: string; portfolio: string; } |
params.instrument | string |
params.portfolio | string |
Returns
Promise<any>
getPositionOffsets()
getPositionOffsets(): Promise<any>;Legacy SDK wrapper for GET /api/v1/position-offsets on the International Exchange REST endpoint.
Returns
Promise<any>
getPrivate()
getPrivate(endpoint: string, params?: object): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | object |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getQuotePerInstrument()
getQuotePerInstrument(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/instruments/{instrument}/quote on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { instrument: string; } |
params.instrument | string |
Returns
Promise<any>
getRankings()
getRankings(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/rankings/statistics on the International Exchange REST endpoint. Sends the remaining request fields as query parameters.
Parameters
| Parameter | Type |
|---|---|
params | { instrument_type: string; instruments?: string; period?: string; } |
params.instrument_type | string |
params.instruments? | string |
params.period? | string |
Returns
Promise<any>
getSignTimestampMs()
getSignTimestampMs(): number;Timestamp used to sign the request. Override this method to implement your own timestamp/sync mechanism
Returns
number
Inherited from
BaseRestClient.getSignTimestampMs
getSupportedNetworksPerAsset()
getSupportedNetworksPerAsset(params: object): Promise<any>;Legacy SDK wrapper for GET /api/v1/assets/{asset}/networks on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { asset: string; } |
params.asset | string |
Returns
Promise<any>
getTotalOpenPositionLimit()
getTotalOpenPositionLimit(params: object): Promise<any>;Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/position-limits on the International Exchange REST endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getTransfer()
getTransfer(params: object): Promise<any>;Get transfer
Get transfer.
Parameters
| Parameter | Type |
|---|---|
params | { transfer_uuid: string; } |
params.transfer_uuid | string |
Returns
Promise<any>
getUserPortfolio()
getUserPortfolio(params: object): Promise<any>;Get user portfolio
Returns the user's specified portfolio.
Parameters
| Parameter | Type |
|---|---|
params | { portfolio: string; } |
params.portfolio | string |
Returns
Promise<any>
getUserPortfolios()
getUserPortfolios(): Promise<any>;List all user portfolios
Returns all of the user's portfolios.
Returns
Promise<any>
patchPrivate()
patchPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.patchPrivate
post()
post(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
previewLoanUpdate()
previewLoanUpdate(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/{portfolio}/loans/{asset}/preview on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { action: "ACQUIRE" | "REPAY"; amount: string; asset: string; portfolio: string; } |
params.action | "ACQUIRE" | "REPAY" |
params.amount | string |
params.asset | string |
params.portfolio | string |
Returns
Promise<any>
putPrivate()
putPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.putPrivate
setAutoMargin()
setAutoMargin(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/{portfolio}/auto-margin-enabled on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { enabled: boolean; portfolio: string; } |
params.enabled | boolean |
params.portfolio | string |
Returns
Promise<any>
setCrossCollateral()
setCrossCollateral(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/{portfolio}/cross-collateral-enabled on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { enabled: boolean; portfolio: string; } |
params.enabled | boolean |
params.portfolio | string |
Returns
Promise<any>
setPortfolioMarginOverride()
setPortfolioMarginOverride(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/margin on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { margin_override: string; portfolio_id: string; } |
params.margin_override | string |
params.portfolio_id | string |
Returns
Promise<any>
submitOrder()
submitOrder(params: SubmitINTXOrderRequest): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/orders on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body. The SDK applies its client_order_id validation before sending.
Parameters
| Parameter | Type |
|---|---|
params | SubmitINTXOrderRequest |
Returns
Promise<any>
transferFundsBetweenPortfolios()
transferFundsBetweenPortfolios(params: TransferINTXFundsBetweenPortfoliosRequest): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/transfer on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | TransferINTXFundsBetweenPortfoliosRequest |
Returns
Promise<any>
transferPositionsBetweenPortfolios()
transferPositionsBetweenPortfolios(params: TransferINTXPositionsBetweenPortfoliosRequest): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/portfolios/transfer-position on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | TransferINTXPositionsBetweenPortfoliosRequest |
Returns
Promise<any>
updateOpenOrder()
updateOpenOrder(params: UpdateINTXOpenOrderRequest): Promise<any>;Legacy SDK wrapper for authenticated PUT /api/v1/orders/{id} on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | UpdateINTXOpenOrderRequest |
Returns
Promise<any>
updatePortfolio()
updatePortfolio(params: object): Promise<any>;Legacy SDK wrapper for authenticated PUT /api/v1/portfolios/{portfolio} on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { name: string; portfolio: string; } |
params.name | string |
params.portfolio | string |
Returns
Promise<any>
updatePortfolioParameters()
updatePortfolioParameters(params: UpdateINTXPortfolioParametersRequest): Promise<any>;Update legacy INTX portfolio parameters. Legacy INTX accounts are now view-only; see the migration guide.
Parameters
| Parameter | Type |
|---|---|
params | UpdateINTXPortfolioParametersRequest |
Returns
Promise<any>
validateCounterpartyId()
validateCounterpartyId(params: object): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/transfers/validate-counterparty-id on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | { counterparty_id: string; } |
params.counterparty_id | string |
Returns
Promise<any>
withdrawToCounterpartyId()
withdrawToCounterpartyId(params: INTXWithdrawToCounterpartyIdRequest): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/transfers/withdraw/counterparty on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | INTXWithdrawToCounterpartyIdRequest |
Returns
Promise<any>
withdrawToCryptoAddress()
withdrawToCryptoAddress(params: INTXWithdrawToCryptoAddressRequest): Promise<any>;Legacy SDK wrapper for authenticated POST /api/v1/transfers/withdraw on the International Exchange REST endpoint. Sends the request fields that are not part of the path in the JSON body.
Parameters
| Parameter | Type |
|---|---|
params | INTXWithdrawToCryptoAddressRequest |
Returns
Promise<any>