Skip to content

Class: CBAdvancedTradeClient ​

REST client for Coinbase's Advanced Trade API: https://docs.cdp.coinbase.com/advanced-trade/docs/api-overview/

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

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

Parameters ​

ParameterType
restClientOptions?RestClientOptions
requestOptions?AxiosRequestConfig

Returns ​

CBAdvancedTradeClient

Overrides ​

BaseRestClient.constructor

Methods ​

allocatePortfolio() ​

ts
allocatePortfolio(params: AllocateAdvTradePortfolioRequest): Promise<any>;

Legacy INTX allocation endpoint, retired on 1 October 2026. Use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
paramsAllocateAdvTradePortfolioRequest

Returns ​

Promise<any>


cancelOrders() ​

ts
cancelOrders(params: object): Promise<AdvTradeCancelOrdersResponse>;

Initiate cancel requests for one or more orders. Pass their IDs in order_ids. The SDK forwards the array to POST /api/v3/brokerage/orders/batch_cancel without enforcing a local batch-size limit.

Parameters ​

ParameterType
params{ order_ids: string[]; }
params.order_idsstring[]

Returns ​

Promise<AdvTradeCancelOrdersResponse>

See ​

Order management


cancelPendingFuturesSweep() ​

ts
cancelPendingFuturesSweep(): Promise<{
  success: boolean;
}>;

Cancel Pending Futures Sweep

Cancel the pending sweep of funds from your futures account to your USD spot account.

Returns ​

Promise<{ success: boolean; }>


closePosition() ​

ts
closePosition(params: CloseAdvTradePositionRequest): Promise<AdvTradeClosePositionResponse>;

Close Position

Places an order to close any open positions for a specified product_id.

Parameters ​

ParameterType
paramsCloseAdvTradePositionRequest

Returns ​

Promise<AdvTradeClosePositionResponse>


commitConvertTrade() ​

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

Commit Convert Trade

Commits a convert trade with a specified trade id, source account, and target account.

Parameters ​

ParameterType
params{ from_account: string; to_account: string; trade_id: string; }
params.from_accountstring
params.to_accountstring
params.trade_idstring

Returns ​

Promise<any>


createPortfolio() ​

ts
createPortfolio(params: object): Promise<{
  portfolio: AdvTradePortfolio;
}>;

Create Portfolio

Create a portfolio.

Parameters ​

ParameterType
params{ name: string; }
params.namestring

Returns ​

Promise<{ portfolio: AdvTradePortfolio; }>


deletePortfolio() ​

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

Delete Portfolio

Delete a portfolio.

Parameters ​

ParameterType
params{ portfolio_uuid: string; }
params.portfolio_uuidstring

Returns ​

Promise<any>


deletePrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


fetchLatencySummary() ​

ts
fetchLatencySummary(): Promise<any>;

Estimate request latency and the clock offset between the client and server. This SDK diagnostic is intended for internal testing and is not an exchange API endpoint. Values are estimates and can vary with network conditions. Suggestions and improvements are welcome as GitHub issues or pull requests.

Returns ​

Promise<any>


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


getAccount() ​

ts
getAccount(params: object): Promise<{
  account: AdvTradeAccount;
}>;

Get Account

Get an account by its UUID. Use getAccounts() to find account UUIDs.

Parameters ​

ParameterType
params{ account_id: string; }
params.account_idstring

Returns ​

Promise<{ account: AdvTradeAccount; }>


getAccounts() ​

ts
getAccounts(params?: object): Promise<AdvTradeAccountsList>;

List Accounts

Get a list of authenticated accounts for the current user.

Parameters ​

ParameterType
params?{ cursor?: string; limit?: number; retail_portfolio_id?: string; }
params.cursor?string
params.limit?number
params.retail_portfolio_id?string

Returns ​

Promise<AdvTradeAccountsList>

See ​

Read authenticated account balances


getApiKeyPermissions() ​

ts
getApiKeyPermissions(): Promise<AdvTradeApiKeyPermissions>;

Get API Key Permissions

Get information about your CDP API key permissions.

Returns ​

Promise<AdvTradeApiKeyPermissions>

See ​

Check API key permissions


getBestBidAsk() ​

ts
getBestBidAsk(params?: object): Promise<{
  pricebooks: AdvTradePricebook[];
}>;

Get Best Bid/Ask

Get the best bid/ask for all products. A subset of all products can be returned instead by using the product_ids input.

Parameters ​

ParameterType
params?{ product_ids?: string[]; }
params.product_ids?string[]

Returns ​

Promise<{ pricebooks: AdvTradePricebook[]; }>


getClientType() ​

ts
getClientType(): RestClientType;

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

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getConvertTrade() ​

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

Get Convert Trade

Get details of a conversion trade by trade ID, source account, and target account.

Parameters ​

ParameterType
params{ from_account: string; to_account: string; trade_id: string; }
params.from_accountstring
params.to_accountstring
params.trade_idstring

Returns ​

Promise<any>


getCurrentMarginWindow() ​

ts
getCurrentMarginWindow(params?: object): Promise<AdvTradeCurrentMarginWindow>;

Get Current Margin Window

Get the futures current margin window.

Parameters ​

ParameterType
params?{ margin_profile_type?: | "MARGIN_PROFILE_TYPE_UNSPECIFIED" | "MARGIN_PROFILE_TYPE_RETAIL_REGULAR" | "MARGIN_PROFILE_TYPE_RETAIL_INTRADAY_MARGIN_1"; }
params.margin_profile_type?| "MARGIN_PROFILE_TYPE_UNSPECIFIED" | "MARGIN_PROFILE_TYPE_RETAIL_REGULAR" | "MARGIN_PROFILE_TYPE_RETAIL_INTRADAY_MARGIN_1"

Returns ​

Promise<AdvTradeCurrentMarginWindow>


getFills() ​

ts
getFills(params?: GetAdvTradeFillsRequest): Promise<{
  cursor?: string;
  fills: AdvTradeFill[];
}>;

List fills using optional filters such as product_ids and order_ids. Pass the response cursor to request the next page.

Parameters ​

ParameterType
params?GetAdvTradeFillsRequest

Returns ​

Promise<{ cursor?: string; fills: AdvTradeFill[]; }>

See ​

Order management


getFuturesBalanceSummary() ​

ts
getFuturesBalanceSummary(): Promise<{
  balance_summary: AdvTradeFuturesBalance;
}>;

Get Futures Balance Summary

Get a summary of balances for CFM trading.

Futures vs Spot Accounts:

  • Futures and spot balances are held in different accounts.
  • Cash is always deposited into your Coinbase Inc. (CBI) spot account.
  • Cash is automatically transferred to your Coinbase Financial Markets (CFM) futures account to satisfy margin requirements.
  • You can transfer cash that isn't being used to margin or maintain futures positions into your CBI spot account.
  • Funds held in a CBI spot account do not receive the preferential treatment given to funds held in a regulated futures account.

Intraday vs. Overnight Margin Health:

  • If you are opted in to receive increased leverage on futures trades during the intraday window (from 8am-4pm ET), this endpoint will return your intraday and overnight margin health.

Returns ​

Promise<{ balance_summary: AdvTradeFuturesBalance; }>


getFuturesPosition() ​

ts
getFuturesPosition(params: object): Promise<{
  position: AdvTradeFuturesPosition;
}>;

Get Futures Position

Get positions for a specific CFM product.

Parameters ​

ParameterType
params{ product_id: string; }
params.product_idstring

Returns ​

Promise<{ position: AdvTradeFuturesPosition; }>


getFuturesPositions() ​

ts
getFuturesPositions(): Promise<{
  positions: AdvTradeFuturesPosition[];
}>;

List Futures Positions

Get a list of positions in CFM products.

Returns ​

Promise<{ positions: AdvTradeFuturesPosition[]; }>


getFuturesSweeps() ​

ts
getFuturesSweeps(): Promise<{
  sweeps: AdvTradeFuturesSweep[];
}>;

List Futures Sweeps

Get pending and processing sweeps of funds from your futures account to your USD spot account.

Pending vs. Processing Sweeps:

  • A pending sweep is a sweep that has not started processing and can be cancelled.
  • A processing sweep is a sweep that is currently being processed and cannot be cancelled.
  • Once a sweep is complete, it no longer appears in the list of sweeps.

Returns ​

Promise<{ sweeps: AdvTradeFuturesSweep[]; }>


getIntradayMarginSetting() ​

ts
getIntradayMarginSetting(): Promise<{
  setting:   | "INTRADAY_MARGIN_SETTING_UNSPECIFIED"
     | "INTRADAY_MARGIN_SETTING_STANDARD"
     | "INTRADAY_MARGIN_SETTING_INTRADAY";
}>;

Get Intraday Margin Setting

Get the futures intraday margin setting.

Returns ​

Promise<{ setting: | "INTRADAY_MARGIN_SETTING_UNSPECIFIED" | "INTRADAY_MARGIN_SETTING_STANDARD" | "INTRADAY_MARGIN_SETTING_INTRADAY"; }>


getMarketTrades() ​

ts
getMarketTrades(params: GetAdvTradeMarketTradesRequest): Promise<AdvTradeMarketTrades>;

Get Market Trades

Get snapshot information by product ID about the last trades (ticks) and best bid/ask.

Parameters ​

ParameterType
paramsGetAdvTradeMarketTradesRequest

Returns ​

Promise<AdvTradeMarketTrades>


getOrder() ​

ts
getOrder(params: object): Promise<{
  order: AdvTradeOrder;
}>;

Get Order

Get a single order by order ID.

Parameters ​

ParameterType
params{ client_order_id?: string; order_id: string; user_native_currency?: string; }
params.client_order_id?string
params.order_idstring
params.user_native_currency?string

Returns ​

Promise<{ order: AdvTradeOrder; }>

See ​

Order management


getOrders() ​

ts
getOrders(params?: GetAdvTradeOrdersRequest): Promise<{
  cursor?: string;
  has_next: boolean;
  orders: AdvTradeOrder[];
  sequence?: number;
}>;

List orders using optional filters. order_status filters statuses such as OPEN; order_types filters types such as LIMIT or MARKET. When has_next is true, pass the response cursor in the next request. See List Orders for current filter definitions.

Parameters ​

ParameterType
params?GetAdvTradeOrdersRequest

Returns ​

Promise<{ cursor?: string; has_next: boolean; orders: AdvTradeOrder[]; sequence?: number; }>

See ​

Order management


getPaymentMethod() ​

ts
getPaymentMethod(params: object): Promise<{
  payment_method: AdvTradePaymentMethod;
}>;

Get Payment Method

Get information about a payment method for the current user.

Parameters ​

ParameterType
params{ payment_method_id: string; }
params.payment_method_idstring

Returns ​

Promise<{ payment_method: AdvTradePaymentMethod; }>


getPaymentMethods() ​

ts
getPaymentMethods(): Promise<{
  payment_methods: AdvTradePaymentMethod[];
}>;

List Payment Methods

Get a list of payment methods for the current user.

Returns ​

Promise<{ payment_methods: AdvTradePaymentMethod[]; }>


getPerpetualsPortfolioSummary() ​

ts
getPerpetualsPortfolioSummary(params: object): Promise<AdvTradePerpetualsPortfolio>;

Read legacy INTX portfolio data. This retired endpoint retains pre-migration history temporarily; use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
params{ portfolio_uuid: string; }
params.portfolio_uuidstring

Returns ​

Promise<AdvTradePerpetualsPortfolio>


getPerpetualsPosition() ​

ts
getPerpetualsPosition(params: object): Promise<{
  position: AdvTradePerpetualsPosition;
}>;

Read a legacy INTX position. This retired endpoint retains pre-migration history temporarily; use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
params{ portfolio_uuid: string; symbol: string; }
params.portfolio_uuidstring
params.symbolstring

Returns ​

Promise<{ position: AdvTradePerpetualsPosition; }>


getPerpetualsPositions() ​

ts
getPerpetualsPositions(params: object): Promise<AdvTradePerpetualsPositionSummary>;

Read legacy INTX positions. This retired endpoint retains pre-migration history temporarily; use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
params{ portfolio_uuid: string; }
params.portfolio_uuidstring

Returns ​

Promise<AdvTradePerpetualsPositionSummary>


getPortfolioBreakdown() ​

ts
getPortfolioBreakdown(params: object): Promise<{
  breakdown: AdvTradePortfolioBreakdown;
}>;

Get Portfolio Breakdown

Get the breakdown of a portfolio.

Parameters ​

ParameterType
params{ currency?: string; portfolio_uuid: string; }
params.currency?string
params.portfolio_uuidstring

Returns ​

Promise<{ breakdown: AdvTradePortfolioBreakdown; }>


getPortfolios() ​

ts
getPortfolios(params?: object): Promise<{
  portfolios: AdvTradePortfolio[];
}>;

List Portfolios

Get all portfolios of a user.

Parameters ​

ParameterType
params?{ portfolio_type?: "INTX" | "UNDEFINED" | "DEFAULT" | "CONSUMER"; }
params.portfolio_type?"INTX" | "UNDEFINED" | "DEFAULT" | "CONSUMER"

Returns ​

Promise<{ portfolios: AdvTradePortfolio[]; }>


getPortfoliosBalances() ​

ts
getPortfoliosBalances(params: object): Promise<{
  portfolio_balances: AdvTradePortfolioBalance[];
}>;

Read legacy INTX balances. This retired endpoint retains pre-migration history temporarily; use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
params{ portfolio_uuid: string; }
params.portfolio_uuidstring

Returns ​

Promise<{ portfolio_balances: AdvTradePortfolioBalance[]; }>


getPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?object

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getProduct() ​

ts
getProduct(params: object): Promise<AdvTradeProduct>;

Get Product

Get information on a single product by product ID.

Parameters ​

ParameterType
params{ get_tradability_status?: boolean; product_id: string; }
params.get_tradability_status?boolean
params.product_idstring

Returns ​

Promise<AdvTradeProduct>


getProductBook() ​

ts
getProductBook(params: object): Promise<{
  pricebook: AdvTradePricebook;
}>;

Get Product Book

Get a list of bids/asks for a single product. The amount of detail shown can be customized with the limit parameter.

Parameters ​

ParameterType
params{ aggregation_price_increment?: string; limit?: number; product_id: string; }
params.aggregation_price_increment?string
params.limit?number
params.product_idstring

Returns ​

Promise<{ pricebook: AdvTradePricebook; }>


getProductCandles() ​

ts
getProductCandles(params: GetAdvTradeProductCandlesRequest): Promise<{
  candles: AdvTradeCandle[];
}>;

Get Product Candles

Get rates for a single product by product ID, grouped in buckets.

Parameters ​

ParameterType
paramsGetAdvTradeProductCandlesRequest

Returns ​

Promise<{ candles: AdvTradeCandle[]; }>


getProducts() ​

ts
getProducts(params?: GetAdvTradeProductsRequest): Promise<{
  num_products: number;
  products: AdvTradeProduct[];
}>;

List Products

Get a list of the available currency pairs for trading.

Parameters ​

ParameterType
params?GetAdvTradeProductsRequest

Returns ​

Promise<{ num_products: number; products: AdvTradeProduct[]; }>


getPublicMarketTrades() ​

ts
getPublicMarketTrades(params: GetAdvTradePublicMarketTradesRequest): Promise<AdvTradeMarketTrades>;

Get Public Market Trades

Get snapshot information by product ID about the last trades (ticks) and best bid/ask.

Parameters ​

ParameterType
paramsGetAdvTradePublicMarketTradesRequest

Returns ​

Promise<AdvTradeMarketTrades>


getPublicProduct() ​

ts
getPublicProduct(params: object): Promise<AdvTradePublicProduct>;

Get Public Product

Get information on a single product by product ID.

Parameters ​

ParameterType
params{ product_id: string; }
params.product_idstring

Returns ​

Promise<AdvTradePublicProduct>

See ​

Read an Advanced Trade public price


getPublicProductBook() ​

ts
getPublicProductBook(params: object): Promise<{
  pricebook: AdvTradePricebook;
}>;

Get Public Product Book

Get a list of bids/asks for a single product. The amount of detail shown can be customized with the limit parameter.

Parameters ​

ParameterType
params{ aggregation_price_increment?: string; limit?: number; product_id: string; }
params.aggregation_price_increment?string
params.limit?number
params.product_idstring

Returns ​

Promise<{ pricebook: AdvTradePricebook; }>

See ​

Read the public order book


getPublicProductCandles() ​

ts
getPublicProductCandles(params: GetAdvTradePublicProductCandlesRequest): Promise<{
  candles: AdvTradeCandle[];
}>;

Get Public Product Candles

Get rates for a single product by product ID, grouped in buckets.

Parameters ​

ParameterType
paramsGetAdvTradePublicProductCandlesRequest

Returns ​

Promise<{ candles: AdvTradeCandle[]; }>


getPublicProducts() ​

ts
getPublicProducts(params?: GetAdvTradePublicProductsRequest): Promise<{
  num_products: number;
  products: AdvTradePublicProduct[];
}>;

List Public Products

Get a list of the available currency pairs for trading.

Parameters ​

ParameterType
params?GetAdvTradePublicProductsRequest

Returns ​

Promise<{ num_products: number; products: AdvTradePublicProduct[]; }>


getServerTime() ​

ts
getServerTime(): Promise<{
  epochMillis: string;
  epochSeconds: string;
  iso: string;
}>;

Public Endpoints

Returns ​

Promise<{ epochMillis: string; epochSeconds: string; iso: string; }>


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


getTransactionSummary() ​

ts
getTransactionSummary(params?: GetAdvTradeTransactionSummaryRequest): Promise<AdvTradeTransactionSummary>;

Get Transaction Summary

Get a summary of transactions with fee tiers, total volume, and fees.

Parameters ​

ParameterType
params?GetAdvTradeTransactionSummaryRequest

Returns ​

Promise<AdvTradeTransactionSummary>


movePortfolioFunds() ​

ts
movePortfolioFunds(params: MoveAdvTradePortfolioFundsRequest): Promise<{
  source_portfolio_uuid: string;
  target_portfolio_uuid: string;
}>;

Move Portfolio Funds

Move funds between portfolios.

Parameters ​

ParameterType
paramsMoveAdvTradePortfolioFundsRequest

Returns ​

Promise<{ source_portfolio_uuid: string; target_portfolio_uuid: string; }>


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


previewOrder() ​

ts
previewOrder(params: PreviewAdvTradeOrderRequest): Promise<AdvTradeOrderPreview>;

Preview Order

Preview an order.

Parameters ​

ParameterType
paramsPreviewAdvTradeOrderRequest

Returns ​

Promise<AdvTradeOrderPreview>

See ​

Order management


putPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?ParamsInRequest

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.putPrivate


scheduleFuturesSweep() ​

ts
scheduleFuturesSweep(params?: object): Promise<{
  success: boolean;
}>;

Schedule Futures Sweep

Schedules a sweep of funds from your futures account to your USD spot account.

Futures Sweep Processing:

  • Sweep requests submitted before 5PM ET each day are processed the following business day.
  • Sweep requests submitted after 5PM ET each day are processed in 2 business days.
  • You can have at most one pending sweep request at a time.

Market movements related to your open positions may impact the final amount that is transferred into your spot account. The final funds transferred, up to your specified amount, depend on the available excess in your futures account.

Parameters ​

ParameterType
params?{ usd_amount?: string; }
params.usd_amount?string

Returns ​

Promise<{ success: boolean; }>


setIntradayMarginSetting() ​

ts
setIntradayMarginSetting(params?: object): Promise<any>;

Set Intraday Margin Setting

Set the futures intraday margin setting.

Parameters ​

ParameterType
params?{ setting?: | "INTRADAY_MARGIN_SETTING_UNSPECIFIED" | "INTRADAY_MARGIN_SETTING_STANDARD" | "INTRADAY_MARGIN_SETTING_INTRADAY"; }
params.setting?| "INTRADAY_MARGIN_SETTING_UNSPECIFIED" | "INTRADAY_MARGIN_SETTING_STANDARD" | "INTRADAY_MARGIN_SETTING_INTRADAY"

Returns ​

Promise<any>


submitConvertQuote() ​

ts
submitConvertQuote(params: SubmitAdvTradeConvertQuoteRequest): Promise<any>;

Create Convert Quote

Create a convert quote with a specified source account, target account, and amount. Convert is applicable for USDC-USD and EURC-EUR conversion.

Parameters ​

ParameterType
paramsSubmitAdvTradeConvertQuoteRequest

Returns ​

Promise<any>


submitOrder() ​

ts
submitOrder(params: SubmitAdvTradeOrderRequest): Promise<AdvTradeSubmitOrderResponse>;

Create Order

Create an order with a specified product_id (asset-pair), side (buy/sell), etc.

Parameters ​

ParameterType
paramsSubmitAdvTradeOrderRequest

Returns ​

Promise<AdvTradeSubmitOrderResponse>

See ​

Order management


updateMultiAssetCollateral() ​

ts
updateMultiAssetCollateral(params?: object): Promise<{
  multi_asset_collateral_enabled: boolean;
}>;

Legacy INTX collateral-setting endpoint, retired on 1 October 2026. Use CBAdvancedTradeGlobalClient for current international derivatives. See Advanced Trade endpoints.

Parameters ​

ParameterType
params?{ multi_asset_collateral_enabled?: boolean; portfolio_uuid?: string; }
params.multi_asset_collateral_enabled?boolean
params.portfolio_uuid?string

Returns ​

Promise<{ multi_asset_collateral_enabled: boolean; }>


updateOrder() ​

ts
updateOrder(params: UpdateAdvTradeOrderRequest): Promise<AdvTradeEditOrderResponse>;

Edit an order with a specified new size or price. Sends the request to POST /api/v3/brokerage/orders/edit.

Parameters ​

ParameterType
paramsUpdateAdvTradeOrderRequest

Returns ​

Promise<AdvTradeEditOrderResponse>


updateOrderPreview() ​

ts
updateOrderPreview(params: UpdateAdvTradeOrderRequest): Promise<AdvTradeEditOrderPreviewResponse>;

Edit Order Preview

Preview an edit order request with a specified new size, or new price.

Parameters ​

ParameterType
paramsUpdateAdvTradeOrderRequest

Returns ​

Promise<AdvTradeEditOrderPreviewResponse>


updatePortfolio() ​

ts
updatePortfolio(params: object): Promise<{
  portfolio: AdvTradePortfolio;
}>;

Edit Portfolio

Edit a portfolio.

Parameters ​

ParameterType
params{ name: string; portfolio_uuid: string; }
params.namestring
params.portfolio_uuidstring

Returns ​

Promise<{ portfolio: AdvTradePortfolio; }>

Built by Siebly. Open source SDKs for exchange APIs.