Skip to content

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 ​

ts
new CBInternationalClient(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig): CBInternationalClient;

Parameters ​

ParameterType
restClientOptions?RestClientOptions
requestOptions?AxiosRequestConfig

Returns ​

CBInternationalClient

Overrides ​

BaseRestClient.constructor

Methods ​

acquireOrRepayLoan() ​

ts
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 ​

ParameterType
params{ action: "ACQUIRE" | "REPAY"; amount: number; asset: string; portfolio: string; }
params.action"ACQUIRE" | "REPAY"
params.amountnumber
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


cancelOrder() ​

ts
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 ​

ParameterType
params{ id: string; portfolio: string; }
params.idstring
params.portfoliostring

Returns ​

Promise<any>


cancelOrders() ​

ts
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 ​

ParameterType
paramsCancelINTXOrdersRequest

Returns ​

Promise<any>


createCounterpartyId() ​

ts
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 ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


createCryptoAddress() ​

ts
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 ​

ParameterType
params{ asset: string; network_arn_id: string; portfolio: string; }
params.assetstring
params.network_arn_idstring
params.portfoliostring

Returns ​

Promise<any>


createPortfolio() ​

ts
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 ​

ParameterType
params{ name: string; }
params.namestring

Returns ​

Promise<any>


deletePrivate() ​

ts
deletePrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


generateNewOrderId() ​

ts
generateNewOrderId(): string;

Returns ​

string

Inherited from ​

BaseRestClient.generateNewOrderId


get() ​

ts
get(endpoint: string, params?: object): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?object

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


getActiveLoansForPortfolio() ​

ts
getActiveLoansForPortfolio(params: object): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/loans on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getAggregatedCandlesData() ​

ts
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 ​

ParameterType
paramsGetINTXAggregatedCandlesData

Returns ​

Promise<any>


getAssetDetails() ​

ts
getAssetDetails(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/assets/{asset} on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ asset: string; }
params.assetstring

Returns ​

Promise<any>


getAssets() ​

ts
getAssets(): Promise<any>;

Legacy SDK wrapper for GET /api/v1/assets on the International Exchange REST endpoint.

Returns ​

Promise<any>


getBalanceForPortfolioAsset() ​

ts
getBalanceForPortfolioAsset(params: object): Promise<any>;

Get balance for portfolio/asset

Retrieves the balance for a given portfolio and asset.

Parameters ​

ParameterType
params{ asset: string; portfolio: string; }
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


getClientType() ​

ts
getClientType(): RestClientType;

Defines the client type (affecting how requests & signatures behave)

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getCounterpartyWithdrawalLimit() ​

ts
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 ​

ParameterType
params{ asset: string; portfolio: string; }
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


getDailyTradingVolumes() ​

ts
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 ​

ParameterType
paramsGetINTXDailyTradingVolumes

Returns ​

Promise<any>


getFeeRateTiers() ​

ts
getFeeRateTiers(): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/fee-rate-tiers on the International Exchange REST endpoint.

Returns ​

Promise<any>


getFillsByPortfolios() ​

ts
getFillsByPortfolios(params?: GetINTXFillsByPortfoliosRequest): Promise<any>;

List fills by portfolios

Returns fills for specified portfolios or fills for all portfolios if none are provided.

Parameters ​

ParameterType
params?GetINTXFillsByPortfoliosRequest

Returns ​

Promise<any>


getFundTransferLimit() ​

ts
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 ​

ParameterType
params{ asset: string; portfolio: string; }
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


getHistoricalFundingRates() ​

ts
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 ​

ParameterType
params{ instrument: string; result_limit?: number; result_offset?: number; }
params.instrumentstring
params.result_limit?number
params.result_offset?number

Returns ​

Promise<any>


getIndexCandles() ​

ts
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 ​

ParameterType
paramsGetINTXIndexCandlesRequest

Returns ​

Promise<any>


getIndexComposition() ​

ts
getIndexComposition(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/index/{index}/composition on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ index: string; }
params.indexstring

Returns ​

Promise<any>


getIndexCompositionHistory() ​

ts
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 ​

ParameterType
paramsGetINTXIndexCompositionHistory

Returns ​

Promise<any>


getIndexPrice() ​

ts
getIndexPrice(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/index/{index}/price on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ index: string; }
params.indexstring

Returns ​

Promise<any>


getInstrumentDetails() ​

ts
getInstrumentDetails(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/instruments/{instrument} on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ instrument: string; }
params.instrumentstring

Returns ​

Promise<any>


getInstruments() ​

ts
getInstruments(): Promise<any>;

Legacy SDK wrapper for GET /api/v1/instruments on the International Exchange REST endpoint.

Returns ​

Promise<any>


getLoanInfoForPortfolioAsset() ​

ts
getLoanInfoForPortfolioAsset(params: object): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/loans/{asset} on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ asset: string; portfolio: string; }
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


getMatchingTransfers() ​

ts
getMatchingTransfers(params?: GetINTXMatchingTransfersRequest): Promise<any>;

List matching transfers

List matching transfers.

Parameters ​

ParameterType
params?GetINTXMatchingTransfersRequest

Returns ​

Promise<any>


getMaxLoanAvailability() ​

ts
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 ​

ParameterType
params{ asset: string; portfolio: string; }
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


getOpenOrders() ​

ts
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 ​

ParameterType
params?GetINTXOpenOrdersRequest

Returns ​

Promise<any>


getOpenPositionLimitsForAllInstruments() ​

ts
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 ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getOpenPositionLimitsForInstrument() ​

ts
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 ​

ParameterType
params{ instrument: string; portfolio: string; }
params.instrumentstring
params.portfoliostring

Returns ​

Promise<any>


getOrderDetails() ​

ts
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 ​

ParameterType
params{ id: string; portfolio: string; }
params.idstring
params.portfoliostring

Returns ​

Promise<any>


getPortfolioBalances() ​

ts
getPortfolioBalances(params: object): Promise<any>;

List portfolio balances

Returns all of the balances for a given portfolio.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getPortfolioDetails() ​

ts
getPortfolioDetails(params: object): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/detail on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getPortfolioFeeRates() ​

ts
getPortfolioFeeRates(): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/portfolios/fee-rates on the International Exchange REST endpoint.

Returns ​

Promise<any>


getPortfolioFills() ​

ts
getPortfolioFills(params: GetINTXPortfolioFillsRequest): Promise<any>;

List portfolio fills

Returns all of the fills for a given portfolio.

Parameters ​

ParameterType
paramsGetINTXPortfolioFillsRequest

Returns ​

Promise<any>


getPortfolioPositions() ​

ts
getPortfolioPositions(params: object): Promise<any>;

List portfolio positions

Returns all of the positions for a given portfolio.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getPortfolioSummary() ​

ts
getPortfolioSummary(params: object): Promise<any>;

Get portfolio summary

Retrieves the high level overview of a portfolio.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getPositionForPortfolioInstrument() ​

ts
getPositionForPortfolioInstrument(params: object): Promise<any>;

Get position for portfolio/instrument

Retrieves the position for a given portfolio and symbol.

Parameters ​

ParameterType
params{ instrument: string; portfolio: string; }
params.instrumentstring
params.portfoliostring

Returns ​

Promise<any>


getPositionOffsets() ​

ts
getPositionOffsets(): Promise<any>;

Legacy SDK wrapper for GET /api/v1/position-offsets on the International Exchange REST endpoint.

Returns ​

Promise<any>


getPrivate() ​

ts
getPrivate(endpoint: string, params?: object): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?object

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getQuotePerInstrument() ​

ts
getQuotePerInstrument(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/instruments/{instrument}/quote on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ instrument: string; }
params.instrumentstring

Returns ​

Promise<any>


getRankings() ​

ts
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 ​

ParameterType
params{ instrument_type: string; instruments?: string; period?: string; }
params.instrument_typestring
params.instruments?string
params.period?string

Returns ​

Promise<any>


getSignTimestampMs() ​

ts
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() ​

ts
getSupportedNetworksPerAsset(params: object): Promise<any>;

Legacy SDK wrapper for GET /api/v1/assets/{asset}/networks on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ asset: string; }
params.assetstring

Returns ​

Promise<any>


getTotalOpenPositionLimit() ​

ts
getTotalOpenPositionLimit(params: object): Promise<any>;

Legacy SDK wrapper for authenticated GET /api/v1/portfolios/{portfolio}/position-limits on the International Exchange REST endpoint.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getTransfer() ​

ts
getTransfer(params: object): Promise<any>;

Get transfer

Get transfer.

Parameters ​

ParameterType
params{ transfer_uuid: string; }
params.transfer_uuidstring

Returns ​

Promise<any>


getUserPortfolio() ​

ts
getUserPortfolio(params: object): Promise<any>;

Get user portfolio

Returns the user's specified portfolio.

Parameters ​

ParameterType
params{ portfolio: string; }
params.portfoliostring

Returns ​

Promise<any>


getUserPortfolios() ​

ts
getUserPortfolios(): Promise<any>;

List all user portfolios

Returns all of the user's portfolios.

Returns ​

Promise<any>


patchPrivate() ​

ts
patchPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.patchPrivate


post() ​

ts
post(endpoint: string, params?: ParamsInRequest): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

ts
postPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


previewLoanUpdate() ​

ts
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 ​

ParameterType
params{ action: "ACQUIRE" | "REPAY"; amount: string; asset: string; portfolio: string; }
params.action"ACQUIRE" | "REPAY"
params.amountstring
params.assetstring
params.portfoliostring

Returns ​

Promise<any>


putPrivate() ​

ts
putPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.putPrivate


setAutoMargin() ​

ts
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 ​

ParameterType
params{ enabled: boolean; portfolio: string; }
params.enabledboolean
params.portfoliostring

Returns ​

Promise<any>


setCrossCollateral() ​

ts
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 ​

ParameterType
params{ enabled: boolean; portfolio: string; }
params.enabledboolean
params.portfoliostring

Returns ​

Promise<any>


setPortfolioMarginOverride() ​

ts
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 ​

ParameterType
params{ margin_override: string; portfolio_id: string; }
params.margin_overridestring
params.portfolio_idstring

Returns ​

Promise<any>


submitOrder() ​

ts
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 ​

ParameterType
paramsSubmitINTXOrderRequest

Returns ​

Promise<any>


transferFundsBetweenPortfolios() ​

ts
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 ​

ParameterType
paramsTransferINTXFundsBetweenPortfoliosRequest

Returns ​

Promise<any>


transferPositionsBetweenPortfolios() ​

ts
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 ​

ParameterType
paramsTransferINTXPositionsBetweenPortfoliosRequest

Returns ​

Promise<any>


updateOpenOrder() ​

ts
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 ​

ParameterType
paramsUpdateINTXOpenOrderRequest

Returns ​

Promise<any>


updatePortfolio() ​

ts
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 ​

ParameterType
params{ name: string; portfolio: string; }
params.namestring
params.portfoliostring

Returns ​

Promise<any>


updatePortfolioParameters() ​

ts
updatePortfolioParameters(params: UpdateINTXPortfolioParametersRequest): Promise<any>;

Update legacy INTX portfolio parameters. Legacy INTX accounts are now view-only; see the migration guide.

Parameters ​

ParameterType
paramsUpdateINTXPortfolioParametersRequest

Returns ​

Promise<any>


validateCounterpartyId() ​

ts
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 ​

ParameterType
params{ counterparty_id: string; }
params.counterparty_idstring

Returns ​

Promise<any>


withdrawToCounterpartyId() ​

ts
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 ​

ParameterType
paramsINTXWithdrawToCounterpartyIdRequest

Returns ​

Promise<any>


withdrawToCryptoAddress() ​

ts
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 ​

ParameterType
paramsINTXWithdrawToCryptoAddressRequest

Returns ​

Promise<any>

Built by Siebly. Open source SDKs for exchange APIs.