Class: PortfolioClient

REST client for Portfolio Margin APIs (papi)

https://developers.binance.com/docs/derivatives/portfolio-margin/general-info

Extends

default

Constructors

Constructor

new PortfolioClient(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig): PortfolioClient;

Parameters

Parameter	Type
`restClientOptions?`	`RestClientOptions`
`requestOptions?`	`AxiosRequestConfig`

Returns

PortfolioClient

Overrides

BaseRestClient.constructor

Properties

apiLimitLastUpdated

apiLimitLastUpdated: number;

Inherited from

BaseRestClient.apiLimitLastUpdated

apiLimitTrackers

apiLimitTrackers: Record<ApiLimitHeader, number>;

Inherited from

BaseRestClient.apiLimitTrackers

Methods

autoCollectFunds()

autoCollectFunds(): Promise<{
  msg: string;
}>;

Returns

Promise<{ msg: string; }>

cancelAllCMConditionalOrders()

cancelAllCMConditionalOrders(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ code: number; msg: string; }>

cancelAllCMOrders()

cancelAllCMOrders(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ code: number; msg: string; }>

cancelAllMarginOrders()

cancelAllMarginOrders(params: object): Promise<PortfolioMarginCancelAllOrdersResponse[]>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<PortfolioMarginCancelAllOrdersResponse[]>

cancelAllUMAlgoOpenOrders()

cancelAllUMAlgoOpenOrders(params: object): Promise<PortfolioUMCancelAllUMAlgoOpenOrdersResponse>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<PortfolioUMCancelAllUMAlgoOpenOrdersResponse>

cancelAllUMConditionalOrders()

cancelAllUMConditionalOrders(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ code: number; msg: string; }>

Deprecated

From 2026-04-28; replaced by PortfolioClient.cancelAllUMAlgoOpenOrders (DELETE /papi/v1/um/algo/allOpenOrders).

cancelAllUMOrders()

cancelAllUMOrders(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ code: number; msg: string; }>

cancelCMConditionalOrder()

cancelCMConditionalOrder(params: CancelPortfolioCMConditionalOrderReq): Promise<PortfolioCMCancelConditionalOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioCMConditionalOrderReq`

Returns

Promise<PortfolioCMCancelConditionalOrderResponse>

cancelCMOrder()

cancelCMOrder(params: CancelPortfolioCMOrderReq): Promise<PortfolioCMCancelOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioCMOrderReq`

Returns

Promise<PortfolioCMCancelOrderResponse>

cancelMarginOCO()

cancelMarginOCO(params: CancelPortfolioMarginOCOReq): Promise<PortfolioMarginOCOCancelResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioMarginOCOReq`

Returns

Promise<PortfolioMarginOCOCancelResponse>

cancelMarginOrder()

cancelMarginOrder(params: CancelPortfolioMarginOrderReq): Promise<PortfolioMarginCancelOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioMarginOrderReq`

Returns

Promise<PortfolioMarginCancelOrderResponse>

cancelUMAlgoOrder()

cancelUMAlgoOrder(params: CancelPortfolioUMAlgoOrderReq): Promise<PortfolioUMCancelAlgoOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioUMAlgoOrderReq`

Returns

Promise<PortfolioUMCancelAlgoOrderResponse>

cancelUMConditionalOrder()

cancelUMConditionalOrder(params: CancelPortfolioUMConditionalOrderReq): Promise<PortfolioUMCancelConditionalOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioUMConditionalOrderReq`

Returns

Promise<PortfolioUMCancelConditionalOrderResponse>

Deprecated

From 2026-04-28; replaced by PortfolioClient.cancelUMAlgoOrder (DELETE /papi/v1/um/algo/order).

cancelUMOrder()

cancelUMOrder(params: CancelPortfolioUMOrderReq): Promise<PortfolioUMCancelOrderResponse>;

Parameters

Parameter	Type
`params`	`CancelPortfolioUMOrderReq`

Returns

Promise<PortfolioUMCancelOrderResponse>

closePMUserDataListenKey()

closePMUserDataListenKey(): Promise<object>;

Returns

Promise<object>

delete()

delete(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.delete

deletePrivate()

deletePrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.deletePrivate

fetchTimeOffset()

fetchTimeOffset(): Promise<number>;

Estimate drift based on client<->server latency

Returns

Promise<number>

Inherited from

BaseRestClient.fetchTimeOffset

generateNewOrderId()

generateNewOrderId(): string;

Returns

string

A randomly generated custom order ID that can be used when sending an order to the API. Typically used with the custom order ID parameter, such as newClientOrderId.

Inherited from

BaseRestClient.generateNewOrderId

get()

get(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.get

getAccountInfo()

getAccountInfo(): Promise<PortfolioAccountInformation>;

Returns

Promise<PortfolioAccountInformation>

getAllCMConditionalOrders()

getAllCMConditionalOrders(params: QueryPortfolioAllCMConditionalOrdersReq): Promise<PortfolioCMConditionalOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioAllCMConditionalOrdersReq`

Returns

Promise<PortfolioCMConditionalOrder[]>

getAllCMOpenOrders()

getAllCMOpenOrders(params: object): Promise<PortfolioCMOrder[]>;

Parameters

Parameter	Type
`params`	{ `pair?`: `string`; `symbol?`: `string`; }
`params.pair?`	`string`
`params.symbol?`	`string`

Returns

Promise<PortfolioCMOrder[]>

getAllCMOrders()

getAllCMOrders(params: QueryPortfolioAllCMOrdersReq): Promise<PortfolioCMOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioAllCMOrdersReq`

Returns

Promise<PortfolioCMOrder[]>

getAllMarginOCO()

getAllMarginOCO(params: QueryPortfolioMarginAllOCOReq): Promise<PortfolioMarginOCO[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginAllOCOReq`

Returns

Promise<PortfolioMarginOCO[]>

getAllMarginOrders()

getAllMarginOrders(params: QueryPortfolioMarginAllOrdersReq): Promise<PortfolioMarginOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginAllOrdersReq`

Returns

Promise<PortfolioMarginOrder[]>

getAllUMAlgoOrders()

getAllUMAlgoOrders(params: QueryPortfolioAllUMAlgoOrdersReq): Promise<PortfolioUMAlgoOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioAllUMAlgoOrdersReq`

Returns

Promise<PortfolioUMAlgoOrder[]>

getAllUMConditionalOrders()

getAllUMConditionalOrders(params: QueryPortfolioAllUMConditionalOrdersReq): Promise<PortfolioUMConditionalOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioAllUMConditionalOrdersReq`

Returns

Promise<PortfolioUMConditionalOrder[]>

Deprecated

From 2026-04-28; replaced by PortfolioClient.getAllUMAlgoOrders (GET /papi/v1/um/algo/allAlgoOrders).

getAllUMOpenOrders()

getAllUMOpenOrders(params: object): Promise<PortfolioUMOrder[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioUMOrder[]>

getAllUMOrders()

getAllUMOrders(params: QueryPortfolioAllUMOrdersReq): Promise<PortfolioUMOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioAllUMOrdersReq`

Returns

Promise<PortfolioUMOrder[]>

getAutoRepayFuturesStatus()

getAutoRepayFuturesStatus(): Promise<{
  autoRepay: boolean;
}>;

Returns

Promise<{ autoRepay: boolean; }>

getBalance()

getBalance(params?: object): Promise<PortfolioBalance>;

DERIVATIVES - ACCOUNT endpoints

Parameters

Parameter	Type
`params?`	{ `asset?`: `string`; }
`params.asset?`	`string`

Returns

Promise<PortfolioBalance>

getBaseUrlKey()

getBaseUrlKey(): BinanceBaseUrlKey;

Returns

BinanceBaseUrlKey

Inherited from

BaseRestClient.getBaseUrlKey

getClientId()

getClientId(): BinanceBaseUrlKey;

Returns

BinanceBaseUrlKey

getCMAccount()

getCMAccount(): Promise<{
  assets: PortfolioCMAccountAsset[];
  positions: PortfolioCMAccountPosition[];
}>;

Returns

Promise<{ assets: PortfolioCMAccountAsset[]; positions: PortfolioCMAccountPosition[]; }>

getCMADLQuantile()

getCMADLQuantile(params: object): Promise<object[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<object[]>

getCMCommissionRate()

getCMCommissionRate(params: object): Promise<{
  makerCommissionRate: string;
  symbol: string;
  takerCommissionRate: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ makerCommissionRate: string; symbol: string; takerCommissionRate: string; }>

getCMConditionalOrderHistory()

getCMConditionalOrderHistory(params: QueryPortfolioCMConditionalOrderHistoryReq): Promise<PortfolioCMConditionalHistoryOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMConditionalOrderHistoryReq`

Returns

Promise<PortfolioCMConditionalHistoryOrder>

getCMForceOrders()

getCMForceOrders(params: QueryPortfolioCMForceOrdersReq): Promise<PortfolioCMForceOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMForceOrdersReq`

Returns

Promise<PortfolioCMForceOrder[]>

getCMIncomeHistory()

getCMIncomeHistory(params?: QueryPortfolioCMIncomeReq): Promise<PortfolioCMIncome[]>;

Query CM income history (GET /papi/v1/cm/income). Paginate with startTime and endTime. page is not accepted.

Parameters

Parameter	Type
`params?`	`QueryPortfolioCMIncomeReq`

Returns

Promise<PortfolioCMIncome[]>

getCMLeverageBrackets()

getCMLeverageBrackets(params?: object): Promise<object[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<object[]>

getCMOpenConditionalOrder()

getCMOpenConditionalOrder(params: object): Promise<PortfolioCMConditionalOrder>;

Parameters

Parameter	Type
`params`	{ `newClientStrategyId?`: `string`; `strategyId?`: `number`; `symbol`: `string`; }
`params.newClientStrategyId?`	`string`
`params.strategyId?`	`number`
`params.symbol`	`string`

Returns

Promise<PortfolioCMConditionalOrder>

getCMOpenConditionalOrders()

getCMOpenConditionalOrders(params: object): Promise<PortfolioCMConditionalOrder[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioCMConditionalOrder[]>

getCMOpenOrder()

getCMOpenOrder(params: QueryPortfolioCMOpenOrderReq): Promise<PortfolioCMOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMOpenOrderReq`

Returns

Promise<PortfolioCMOrder>

getCMOrder()

getCMOrder(params: QueryPortfolioCMOrderReq): Promise<PortfolioCMOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMOrderReq`

Returns

Promise<PortfolioCMOrder>

getCMOrderModificationHistory()

getCMOrderModificationHistory(params: QueryPortfolioCMOrderAmendmentReq): Promise<PortfolioCMOrderModificationHistory[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMOrderAmendmentReq`

Returns

Promise<PortfolioCMOrderModificationHistory[]>

getCMPosition()

getCMPosition(params?: object): Promise<PortfolioCMPosition[]>;

Parameters

Parameter	Type
`params?`	{ `marginAsset?`: `string`; `pair?`: `string`; }
`params.marginAsset?`	`string`
`params.pair?`	`string`

Returns

Promise<PortfolioCMPosition[]>

getCMPositionMode()

getCMPositionMode(): Promise<{
  dualSidePosition: boolean;
}>;

Returns

Promise<{ dualSidePosition: boolean; }>

getCMTrades()

getCMTrades(params: QueryPortfolioCMTradesReq): Promise<PortfolioCMTrade[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioCMTradesReq`

Returns

Promise<PortfolioCMTrade[]>

getForBaseUrl()

getForBaseUrl(
   endpoint: string, 
   baseUrlKey: BinanceBaseUrlKey, 
   params?: any
): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`baseUrlKey`	`BinanceBaseUrlKey`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getForBaseUrl

getMarginForceOrders()

getMarginForceOrders(params: QueryPortfolioMarginForceOrdersReq): Promise<{
  rows: PortfolioMarginForceOrder[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginForceOrdersReq`

Returns

Promise<{ rows: PortfolioMarginForceOrder[]; total: number; }>

getMarginInterestHistory()

getMarginInterestHistory(params?: GetMarginInterestHistoryReq): Promise<{
  rows: PortfolioMarginInterestRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`GetMarginInterestHistoryReq`

Returns

Promise<{ rows: PortfolioMarginInterestRecord[]; total: number; }>

getMarginLoanRecords()

getMarginLoanRecords(params: GetMarginLoanRecordsReq): Promise<{
  rows: PortfolioMarginLoanRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetMarginLoanRecordsReq`

Returns

Promise<{ rows: PortfolioMarginLoanRecord[]; total: number; }>

getMarginMaxBorrow()

getMarginMaxBorrow(params: object): Promise<{
  amount: string;
  borrowLimit: string;
}>;

Parameters

Parameter	Type
`params`	{ `asset`: `string`; }
`params.asset`	`string`

Returns

Promise<{ amount: string; borrowLimit: string; }>

getMarginMaxWithdraw()

getMarginMaxWithdraw(params: object): Promise<{
  amount: string;
}>;

Parameters

Parameter	Type
`params`	{ `asset`: `string`; }
`params.asset`	`string`

Returns

Promise<{ amount: string; }>

getMarginOCO()

getMarginOCO(params: QueryPortfolioMarginOCOReq): Promise<PortfolioMarginOCO>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginOCOReq`

Returns

Promise<PortfolioMarginOCO>

getMarginOpenOCO()

getMarginOpenOCO(): Promise<PortfolioMarginOCO[]>;

Returns

Promise<PortfolioMarginOCO[]>

getMarginOpenOrders()

getMarginOpenOrders(params: object): Promise<PortfolioMarginOrder>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<PortfolioMarginOrder>

getMarginOrder()

getMarginOrder(params: QueryPortfolioMarginOrderReq): Promise<PortfolioMarginOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginOrderReq`

Returns

Promise<PortfolioMarginOrder>

getMarginRepayRecords()

getMarginRepayRecords(params: GetMarginRepayRecordsReq): Promise<{
  rows: PortfolioMarginRepayRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetMarginRepayRecordsReq`

Returns

Promise<{ rows: PortfolioMarginRepayRecord[]; total: number; }>

getMarginTrades()

getMarginTrades(params: QueryPortfolioMarginTradesReq): Promise<PortfolioMarginTrade[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioMarginTradesReq`

Returns

Promise<PortfolioMarginTrade[]>

getOrderIdPrefix()

getOrderIdPrefix(): string;

Get the correct prefix for this product group (e.g. spot, margin, futures) to be used when generating a custom order ID (e.g. newClientOrderId).

Returns

string

The prefix that should be used when any custom order ID is included with an order (e.g. newClientOrderId). The prefix will always be 10 characters long.

Inherited from

BaseRestClient.getOrderIdPrefix

getPMUserDataListenKey()

getPMUserDataListenKey(): Promise<{
  listenKey: string;
}>;

User Data Stream Endpoints

Returns

Promise<{ listenKey: string; }>

getPortfolioNegativeBalanceInterestHistory()

getPortfolioNegativeBalanceInterestHistory(params?: GetPortfolioInterestHistoryReq): Promise<PortfolioNegativeBalanceInterestRecord[]>;

Parameters

Parameter	Type
`params?`	`GetPortfolioInterestHistoryReq`

Returns

Promise<PortfolioNegativeBalanceInterestRecord[]>

getPrivate()

getPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getPrivate

getRateLimitStates()

getRateLimitStates(): object;

Returns

object

lastUpdated

lastUpdated: number;

x-mbx-order-count-10s

"x-mbx-order-count-10s": number;

x-mbx-order-count-1d

"x-mbx-order-count-1d": number;

x-mbx-order-count-1h

"x-mbx-order-count-1h": number;

x-mbx-order-count-1m

"x-mbx-order-count-1m": number;

x-mbx-order-count-1s

"x-mbx-order-count-1s": number;

x-mbx-used-weight

"x-mbx-used-weight": number;

x-mbx-used-weight-1m

"x-mbx-used-weight-1m": number;

x-sapi-used-ip-weight-1m

"x-sapi-used-ip-weight-1m": number;

Inherited from

BaseRestClient.getRateLimitStates

getServerTime()

getServerTime(): Promise<number>;

Abstraction required by each client to aid with time sync / drift handling

Returns

Promise<number>

Overrides

BaseRestClient.getServerTime

getTimeOffset()

getTimeOffset(): number;

Return time sync offset, automatically set if time sync is enabled. A higher offset means system clock is behind server time.

Returns

number

Inherited from

BaseRestClient.getTimeOffset

getUMAccount()

getUMAccount(): Promise<{
  assets: PortfolioUMAccountAsset[];
  positions: PortfolioUMAccountPosition[];
}>;

Returns

Promise<{ assets: PortfolioUMAccountAsset[]; positions: PortfolioUMAccountPosition[]; }>

getUMAccountConfig()

getUMAccountConfig(): Promise<PortfolioUMAccountConfig>;

Returns

Promise<PortfolioUMAccountConfig>

getUMAccountV2()

getUMAccountV2(): Promise<{
  assets: PortfolioUMAccountAssetV2[];
  positions: PortfolioUMAccountPositionV2[];
}>;

Returns

Promise<{ assets: PortfolioUMAccountAssetV2[]; positions: PortfolioUMAccountPositionV2[]; }>

getUMADLQuantile()

getUMADLQuantile(params: object): Promise<object[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<object[]>

getUMAlgoOpenOrders()

getUMAlgoOpenOrders(params?: object): Promise<PortfolioUMAlgoOrder[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioUMAlgoOrder[]>

getUMAlgoOrder()

getUMAlgoOrder(params: QueryPortfolioUMAlgoOrderReq): Promise<PortfolioUMAlgoOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMAlgoOrderReq`

Returns

Promise<PortfolioUMAlgoOrder>

getUMCommissionRate()

getUMCommissionRate(params: object): Promise<{
  makerCommissionRate: string;
  symbol: string;
  takerCommissionRate: string;
}>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<{ makerCommissionRate: string; symbol: string; takerCommissionRate: string; }>

getUMConditionalOrderHistory()

getUMConditionalOrderHistory(params: QueryPortfolioUMConditionalOrderHistoryReq): Promise<PortfolioUMConditionalOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMConditionalOrderHistoryReq`

Returns

Promise<PortfolioUMConditionalOrder>

Deprecated

From 2026-04-28; use PortfolioClient.getUMAlgoOrder or PortfolioClient.getAllUMAlgoOrders instead of .../conditional/orderHistory.

getUMFeeBurnStatus()

getUMFeeBurnStatus(): Promise<{
  feeBurn: boolean;
}>;

Returns

Promise<{ feeBurn: boolean; }>

getUMForceOrders()

getUMForceOrders(params: QueryPortfolioUMForceOrdersReq): Promise<PortfolioUMForceOrder[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMForceOrdersReq`

Returns

Promise<PortfolioUMForceOrder[]>

getUMIncomeHistory()

getUMIncomeHistory(params?: QueryPortfolioUMIncomeReq): Promise<PortfolioUMIncome[]>;

Query UM income history (GET /papi/v1/um/income). Paginate with startTime and endTime. page is not accepted.

Parameters

Parameter	Type
`params?`	`QueryPortfolioUMIncomeReq`

Returns

Promise<PortfolioUMIncome[]>

getUMLeverageBrackets()

getUMLeverageBrackets(params?: object): Promise<object[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<object[]>

getUMOpenConditionalOrder()

getUMOpenConditionalOrder(params: QueryPortfolioUMOpenConditionalOrderReq): Promise<PortfolioUMConditionalOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMOpenConditionalOrderReq`

Returns

Promise<PortfolioUMConditionalOrder>

Deprecated

From 2026-04-28; replaced by PortfolioClient.getUMAlgoOrder (GET /papi/v1/um/algo/algoOrder).

getUMOpenConditionalOrders()

getUMOpenConditionalOrders(params: object): Promise<PortfolioUMConditionalOrder[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioUMConditionalOrder[]>

Deprecated

From 2026-04-28; replaced by PortfolioClient.getUMAlgoOpenOrders (GET /papi/v1/um/algo/openAlgoOrders).

getUMOpenOrder()

getUMOpenOrder(params: QueryPortfolioUMOpenOrderReq): Promise<PortfolioUMOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMOpenOrderReq`

Returns

Promise<PortfolioUMOrder>

getUMOrder()

getUMOrder(params: QueryPortfolioUMOrderReq): Promise<PortfolioUMOrder>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMOrderReq`

Returns

Promise<PortfolioUMOrder>

getUMOrderDownloadLink()

getUMOrderDownloadLink(params: object): Promise<DownloadLinkResponse>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<DownloadLinkResponse>

getUMOrderHistoryDownloadId()

getUMOrderHistoryDownloadId(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

getUMOrderModificationHistory()

getUMOrderModificationHistory(params: QueryPortfolioUMOrderAmendmentReq): Promise<PortfolioUMOrderModificationHistory[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMOrderAmendmentReq`

Returns

Promise<PortfolioUMOrderModificationHistory[]>

getUMPosition()

getUMPosition(params?: object): Promise<PortfolioUMPosition[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioUMPosition[]>

getUMPositionMode()

getUMPositionMode(): Promise<{
  dualSidePosition: boolean;
}>;

Returns

Promise<{ dualSidePosition: boolean; }>

getUMSymbolConfig()

getUMSymbolConfig(params?: object): Promise<PortfolioUMSymbolConfig[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioUMSymbolConfig[]>

getUMTradeDownloadLink()

getUMTradeDownloadLink(params: object): Promise<DownloadLinkResponse>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<DownloadLinkResponse>

getUMTradeHistoryDownloadId()

getUMTradeHistoryDownloadId(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

getUMTrades()

getUMTrades(params: QueryPortfolioUMTradesReq): Promise<PortfolioUMTrade[]>;

Parameters

Parameter	Type
`params`	`QueryPortfolioUMTradesReq`

Returns

Promise<PortfolioUMTrade[]>

getUMTradingStatus()

getUMTradingStatus(params?: object): Promise<PortfolioTradingStatus>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<PortfolioTradingStatus>

getUMTransactionDownloadLink()

getUMTransactionDownloadLink(params: object): Promise<DownloadLinkResponse>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<DownloadLinkResponse>

getUMTransactionHistoryDownloadId()

getUMTransactionHistoryDownloadId(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

keepAlivePMUserDataListenKey()

keepAlivePMUserDataListenKey(): Promise<object>;

Returns

Promise<object>

modifyCMOrder()

modifyCMOrder(params: ModifyPortfolioCMOrderReq): Promise<PortfolioCMModifyOrderResponse>;

Parameters

Parameter	Type
`params`	`ModifyPortfolioCMOrderReq`

Returns

Promise<PortfolioCMModifyOrderResponse>

modifyUMOrder()

modifyUMOrder(params: ModifyPortfolioUMOrderReq): Promise<PortfolioUMModifyOrderResponse>;

Parameters

Parameter	Type
`params`	`ModifyPortfolioUMOrderReq`

Returns

Promise<PortfolioUMModifyOrderResponse>

post()

post(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.post

postPrivate()

postPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.postPrivate

put()

put(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.put

putPrivate()

putPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.putPrivate

repayFuturesNegativeBalance()

repayFuturesNegativeBalance(): Promise<{
  msg: string;
}>;

Returns

Promise<{ msg: string; }>

repayMarginDebt()

repayMarginDebt(params: PortfolioMarginRepayDebtReq): Promise<PortfolioMarginRepayDebtResponse>;

Parameters

Parameter	Type
`params`	`PortfolioMarginRepayDebtReq`

Returns

Promise<PortfolioMarginRepayDebtResponse>

setTimeOffset()

setTimeOffset(value: number): void;

Parameters

Parameter	Type
`value`	`number`

Returns

void

Inherited from

BaseRestClient.setTimeOffset

signTradFiPerpsContract()

signTradFiPerpsContract(): Promise<PortfolioTradFiPerpsContractSignResponse>;

Returns

Promise<PortfolioTradFiPerpsContractSignResponse>

submitMarginLoan()

submitMarginLoan(params: object): Promise<{
  tranId: number;
}>;

Parameters

Parameter	Type
`params`	{ `amount`: `string`; `asset`: `string`; }
`params.amount`	`string`
`params.asset`	`string`

Returns

Promise<{ tranId: number; }>

submitMarginRepay()

submitMarginRepay(params: object): Promise<{
  tranId: number;
}>;

Parameters

Parameter	Type
`params`	{ `amount`: `string`; `asset`: `string`; }
`params.amount`	`string`
`params.asset`	`string`

Returns

Promise<{ tranId: number; }>

submitNewCMConditionalOrder()

submitNewCMConditionalOrder(params: NewPortfolioCMConditionalOrderReq): Promise<NewPortfolioCMConditionalOrderResponse>;

Parameters

Parameter	Type
`params`	`NewPortfolioCMConditionalOrderReq`

Returns

Promise<NewPortfolioCMConditionalOrderResponse>

submitNewCMOrder()

submitNewCMOrder(params: NewPortfolioCMOrderReq): Promise<NewPortfolioCMOrderResponse>;

Parameters

Parameter	Type
`params`	`NewPortfolioCMOrderReq`

Returns

Promise<NewPortfolioCMOrderResponse>

submitNewMarginOCO()

submitNewMarginOCO(params: NewPortfolioMarginOCOReq): Promise<NewPortfolioMarginOCOResponse>;

Parameters

Parameter	Type
`params`	`NewPortfolioMarginOCOReq`

Returns

Promise<NewPortfolioMarginOCOResponse>

submitNewMarginOrder()

submitNewMarginOrder(params: NewPortfolioMarginOrderReq): Promise<NewPortfolioMarginOrderResponse>;

Parameters

Parameter	Type
`params`	`NewPortfolioMarginOrderReq`

Returns

Promise<NewPortfolioMarginOrderResponse>

submitNewUMAlgoOrder()

submitNewUMAlgoOrder(params: NewPortfolioUMAlgoOrderReq): Promise<PortfolioUMAlgoOrder>;

Parameters

Parameter	Type
`params`	`NewPortfolioUMAlgoOrderReq`

Returns

Promise<PortfolioUMAlgoOrder>

submitNewUMConditionalOrder()

submitNewUMConditionalOrder(params: NewPortfolioUMConditionalOrderReq): Promise<NewPortfolioConditionalOrderResponse>;

Parameters

Parameter	Type
`params`	`NewPortfolioUMConditionalOrderReq`

Returns

Promise<NewPortfolioConditionalOrderResponse>

Deprecated

From 2026-04-28; replaced by PortfolioClient.submitNewUMAlgoOrder (POST /papi/v1/um/algo/order).

submitNewUMOrder()

submitNewUMOrder(params: NewPortfolioUMOrderReq): Promise<NewPortfolioUMOrderResponse>;

DERIVATIVES -TRADE endpoints

Parameters

Parameter	Type
`params`	`NewPortfolioUMOrderReq`

Returns

Promise<NewPortfolioUMOrderResponse>

syncTime()

syncTime(): Promise<void>;

Trigger time sync and store promise

Returns

Promise<void>

Inherited from

BaseRestClient.syncTime

testConnectivity()

testConnectivity(): Promise<object>;

Misc Endpoints

Returns

Promise<object>

toggleUMFeeBurn()

toggleUMFeeBurn(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `feeBurn`: `"true"` \| `"false"`; }
`params.feeBurn`	`"true"` \| `"false"`

Returns

Promise<{ code: number; msg: string; }>

transferAssetFuturesMargin()

transferAssetFuturesMargin(params: object): Promise<{
  msg: string;
}>;

Fund collection by asset (POST /papi/v1/asset-collection).

Optional amount and futureType must be sent together. futureType is the target wallet (UM, CM, or OPTION; OPTION is SPAN only). If neither is sent, collection behavior is unchanged.

Parameters

Parameter	Type
`params`	{ `amount?`: `number`; `asset`: `string`; `futureType?`: `"UM"` \| `"OPTION"` \| `"CM"`; }
`params.amount?`	`number`
`params.asset`	`string`
`params.futureType?`	`"UM"` \| `"OPTION"` \| `"CM"`

Returns

Promise<{ msg: string; }>

transferBNB()

transferBNB(params: object): Promise<{
  tranId: number;
}>;

Parameters

Parameter	Type
`params`	{ `amount`: `string`; `transferSide`: `"TO_UM"` \| `"FROM_UM"`; }
`params.amount`	`string`
`params.transferSide`	`"TO_UM"` \| `"FROM_UM"`

Returns

Promise<{ tranId: number; }>

updateAutoRepayFuturesStatus()

updateAutoRepayFuturesStatus(params: object): Promise<{
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `autoRepay`: `"true"` \| `"false"`; }
`params.autoRepay`	`"true"` \| `"false"`

Returns

Promise<{ msg: string; }>

updateCMLeverage()

updateCMLeverage(params: object): Promise<{
  leverage: number;
  maxQty: string;
  symbol: string;
}>;

Parameters

Parameter	Type
`params`	{ `leverage`: `number`; `symbol`: `string`; }
`params.leverage`	`number`
`params.symbol`	`string`

Returns

Promise<{ leverage: number; maxQty: string; symbol: string; }>

updateCMPositionMode()

updateCMPositionMode(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `dualSidePosition`: `"true"` \| `"false"`; }
`params.dualSidePosition`	`"true"` \| `"false"`

Returns

Promise<{ code: number; msg: string; }>

updateUMLeverage()

updateUMLeverage(params: object): Promise<{
  leverage: number;
  maxNotionalValue: string;
  symbol: string;
}>;

Change UM initial leverage (POST /papi/v1/um/leverage). leverage is an unbounded number here. The maximum is symbol-specific: bracket 1 initialLeverage from GET /papi/v1/um/leverageBracket (Binance derivatives changelog 2026-10-09).

Parameters

Parameter	Type
`params`	{ `leverage`: `number`; `symbol`: `string`; }
`params.leverage`	`number`
`params.symbol`	`string`

Returns

Promise<{ leverage: number; maxNotionalValue: string; symbol: string; }>

updateUMPositionMode()

updateUMPositionMode(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `dualSidePosition`: `"true"` \| `"false"`; }
`params.dualSidePosition`	`"true"` \| `"false"`

Returns

Promise<{ code: number; msg: string; }>

Class: PortfolioClient ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

apiLimitLastUpdated ​

Inherited from ​

apiLimitTrackers ​

Inherited from ​

Methods ​

autoCollectFunds() ​

Returns ​

cancelAllCMConditionalOrders() ​

Parameters ​

Returns ​

cancelAllCMOrders() ​

Parameters ​

Returns ​

cancelAllMarginOrders() ​

Parameters ​

Returns ​

cancelAllUMAlgoOpenOrders() ​

Parameters ​

Returns ​

cancelAllUMConditionalOrders() ​

Parameters ​

Returns ​

Deprecated ​

cancelAllUMOrders() ​

Parameters ​

Returns ​

cancelCMConditionalOrder() ​

Parameters ​

Returns ​

cancelCMOrder() ​

Parameters ​

Returns ​

cancelMarginOCO() ​

Parameters ​

Returns ​

cancelMarginOrder() ​

Parameters ​

Returns ​

cancelUMAlgoOrder() ​

Parameters ​

Returns ​

cancelUMConditionalOrder() ​

Parameters ​

Returns ​

Deprecated ​

cancelUMOrder() ​

Parameters ​

Returns ​

closePMUserDataListenKey() ​

Returns ​

delete() ​

Parameters ​

Returns ​

Inherited from ​

deletePrivate() ​

Parameters ​

Returns ​

Inherited from ​

fetchTimeOffset() ​

Returns ​

Inherited from ​

generateNewOrderId() ​

Returns ​

Inherited from ​

get() ​

Parameters ​

Returns ​

Inherited from ​

getAccountInfo() ​

Returns ​

getAllCMConditionalOrders() ​

Parameters ​

Class: PortfolioClient

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

apiLimitLastUpdated

Inherited from

apiLimitTrackers

Inherited from

Methods

autoCollectFunds()

Returns

cancelAllCMConditionalOrders()

Parameters

Returns

cancelAllCMOrders()

Parameters

Returns

cancelAllMarginOrders()

Parameters

Returns

cancelAllUMAlgoOpenOrders()

Parameters

Returns

cancelAllUMConditionalOrders()

Parameters

Returns

Deprecated

cancelAllUMOrders()

Parameters

Returns

cancelCMConditionalOrder()

Parameters

Returns

cancelCMOrder()

Parameters

Returns

cancelMarginOCO()

Parameters

Returns

cancelMarginOrder()

Parameters

Returns

cancelUMAlgoOrder()

Parameters

Returns

cancelUMConditionalOrder()

Parameters

Returns

Deprecated

cancelUMOrder()

Parameters

Returns

closePMUserDataListenKey()

Returns

delete()

Parameters

Returns

Inherited from

deletePrivate()

Parameters

Returns

Inherited from

fetchTimeOffset()

Returns

Inherited from

generateNewOrderId()

Returns

Inherited from

get()

Parameters

Returns

Inherited from

getAccountInfo()

Returns

getAllCMConditionalOrders()

Parameters