Class: MainClient

Extends

default

Constructors

Constructor

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

Parameters

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

Returns

MainClient

Overrides

BaseRestClient.constructor

Properties

apiLimitLastUpdated

apiLimitLastUpdated: number;

Inherited from

BaseRestClient.apiLimitLastUpdated

apiLimitTrackers

apiLimitTrackers: Record<ApiLimitHeader, number>;

Inherited from

BaseRestClient.apiLimitTrackers

Methods

acceptQuoteRequest()

acceptQuoteRequest(params: AcceptQuoteRequestParams): Promise<any>;

Parameters

Parameter	Type
`params`	`AcceptQuoteRequestParams`

Returns

Promise<any>

addBSwapLiquidity()

addBSwapLiquidity(params: AddBSwapLiquidityParams): Promise<{
  operationId: number;
}>;

Parameters

Parameter	Type
`params`	`AddBSwapLiquidityParams`

Returns

Promise<{ operationId: number; }>

Deprecated

as of 2024-01-19

addInstLoanCollateralAccount()

addInstLoanCollateralAccount(params: AddInstitutionalLoanCollateralAccountParams): Promise<object>;

Parameters

Parameter	Type
`params`	`AddInstitutionalLoanCollateralAccountParams`

Returns

Promise<object>

adjustCryptoLoanFlexibleLTV()

adjustCryptoLoanFlexibleLTV(params: AdjustFlexibleCryptoLoanLTVParams): Promise<AdjustFlexibleCryptoLoanLTVResponse>;

Parameters

Parameter	Type
`params`	`AdjustFlexibleCryptoLoanLTVParams`

Returns

Promise<AdjustFlexibleCryptoLoanLTVResponse>

adjustCryptoLoanLTV()

adjustCryptoLoanLTV(params: AdjustCryptoLoanLTVParams): Promise<AdjustCryptoLoanLTVResponse>;

Parameters

Parameter	Type
`params`	`AdjustCryptoLoanLTVParams`

Returns

Promise<AdjustCryptoLoanLTVResponse>

Deprecated

amendOrderKeepPriority()

amendOrderKeepPriority(params: AmendKeepPriorityParams): Promise<SpotAmendKeepPriorityResult>;

Reduce the quantity of an existing open order while keeping its priority in the order book. The new quantity must be less than the current quantity. https://binance-docs.github.io/apidocs/futures/en/#order-amend-keep-priority-trade

Parameters

Parameter	Type
`params`	`AmendKeepPriorityParams`

Returns

Promise<SpotAmendKeepPriorityResult>

bnbTransfer()

bnbTransfer(params: BnbTransferParams): Promise<{
  tranId: number;
}>;

Parameters

Parameter	Type
`params`	`BnbTransferParams`

Returns

Promise<{ tranId: number; }>

borrowCryptoLoan()

borrowCryptoLoan(params: BorrowCryptoLoanParams): Promise<BorrowCryptoLoanResponse>;

Parameters

Parameter	Type
`params`	`BorrowCryptoLoanParams`

Returns

Promise<BorrowCryptoLoanResponse>

Deprecated

borrowCryptoLoanFlexible()

borrowCryptoLoanFlexible(params: BorrowFlexibleLoanParams): Promise<BorrowFlexibleLoanResponse>;

CRYPTO LOAN Endpoints - Flexible rate - Trade

Parameters

Parameter	Type
`params`	`BorrowFlexibleLoanParams`

Returns

Promise<BorrowFlexibleLoanResponse>

borrowInstitutionalLoan()

borrowInstitutionalLoan(params: InstitutionalLoanBorrowParams): Promise<InstitutionalLoanBorrowResponse>;

Parameters

Parameter	Type
`params`	`InstitutionalLoanBorrowParams`

Returns

Promise<InstitutionalLoanBorrowResponse>

borrowVipLoan()

borrowVipLoan(params: VipLoanBorrowParams): Promise<VipLoanBorrowResponse>;

Parameters

Parameter	Type
`params`	`VipLoanBorrowParams`

Returns

Promise<VipLoanBorrowResponse>

borrowVipLoanFixedRate()

borrowVipLoanFixedRate(params: VipLoanFixedRateBorrowParams): Promise<VipLoanFixedRateBorrowResponse>;

Parameters

Parameter	Type
`params`	`VipLoanFixedRateBorrowParams`

Returns

Promise<VipLoanFixedRateBorrowResponse>

cancelAlgoOrder()

cancelAlgoOrder(params: 
  | {
  algoId: number;
  clientAlgoId?: string;
}
  | {
  algoId?: number;
  clientAlgoId: string;
}): Promise<CancelAlgoOrderResponse>;

Parameters

Parameter	Type
`params`	\| { `algoId`: `number`; `clientAlgoId?`: `string`; } \| { `algoId?`: `number`; `clientAlgoId`: `string`; }

Returns

Promise<CancelAlgoOrderResponse>

cancelAllSymbolOrders()

cancelAllSymbolOrders(params: object): Promise<CancelSpotOrderResult[]>;

Parameters

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

Returns

Promise<CancelSpotOrderResult[]>

cancelConvertLimitOrder()

cancelConvertLimitOrder(params: object): Promise<any>;

Parameters

Parameter	Type
`params`	{ `orderId`: `number`; }
`params.orderId`	`number`

Returns

Promise<any>

cancelHashrateResaleConfig()

cancelHashrateResaleConfig(params: CancelHashrateResaleConfigParams): Promise<boolean>;

Parameters

Parameter	Type
`params`	`CancelHashrateResaleConfigParams`

Returns

Promise<boolean>

cancelOCO()

cancelOCO(params: CancelOCOParams): Promise<CancelOrderListResult>;

Parameters

Parameter	Type
`params`	`CancelOCOParams`

Returns

Promise<CancelOrderListResult>

cancelOrder()

cancelOrder(params: CancelOrderParams): Promise<CancelSpotOrderResult>;

Parameters

Parameter	Type
`params`	`CancelOrderParams`

Returns

Promise<CancelSpotOrderResult>

cancelSpotAlgoOrder()

cancelSpotAlgoOrder(params: 
  | {
  algoId: number;
  clientAlgoId?: string;
}
  | {
  algoId?: number;
  clientAlgoId: string;
}): Promise<CancelSpotAlgoOrderResponse>;

Parameters

Parameter	Type
`params`	\| { `algoId`: `number`; `clientAlgoId?`: `string`; } \| { `algoId?`: `number`; `clientAlgoId`: `string`; }

Returns

Promise<CancelSpotAlgoOrderResponse>

changeComissionBrokerSubAccount()

changeComissionBrokerSubAccount(params: ChangePermissionApiKeyBrokerSubAccountParams): Promise<ChangePermissionApiKeyBrokerSubAccountResponse>;

Parameters

Parameter	Type
`params`	`ChangePermissionApiKeyBrokerSubAccountParams`

Returns

Promise<ChangePermissionApiKeyBrokerSubAccountResponse>

changeFixedAndActivityPositionToDailyPosition()

changeFixedAndActivityPositionToDailyPosition(params: object): Promise<PurchaseFlexibleProductResponse>;

Parameters

Parameter	Type
`params`	{ `lot`: `number`; `positionId?`: `number`; `projectId`: `string`; }
`params.lot`	`number`
`params.positionId?`	`number`
`params.projectId`	`string`

Returns

Promise<PurchaseFlexibleProductResponse>

Deprecated

as of 2023-06-22, now Simple Earn

changePermissionApiKeyBrokerSubAccount()

changePermissionApiKeyBrokerSubAccount(params: ChangePermissionApiKeyBrokerSubAccountParams): Promise<ChangePermissionApiKeyBrokerSubAccountResponse>;

Parameters

Parameter	Type
`params`	`ChangePermissionApiKeyBrokerSubAccountParams`

Returns

Promise<ChangePermissionApiKeyBrokerSubAccountResponse>

checkVipCollateralAccount()

checkVipCollateralAccount(params: CheckVipCollateralAccountParams): Promise<{
  rows: VipCollateralAccount[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`CheckVipCollateralAccountParams`

Returns

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

claimSolBoostRewards()

claimSolBoostRewards(): Promise<{
  success: boolean;
}>;

Returns

Promise<{ success: boolean; }>

closeInstLoanRiskUnit()

closeInstLoanRiskUnit(): Promise<CloseInstitutionalLoanRiskUnitResponse>;

Returns

Promise<CloseInstitutionalLoanRiskUnitResponse>

closeIsolatedMarginUserDataListenKey()

closeIsolatedMarginUserDataListenKey(params: object): Promise<object>;

Parameters

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

Returns

Promise<object>

closeMarginRiskUserDataListenKey()

closeMarginRiskUserDataListenKey(): Promise<object>;

Returns

Promise<object>

closeMarginUserDataListenKey()

closeMarginUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

closeMarginUserDataListenKeyV2()

closeMarginUserDataListenKeyV2(): Promise<object>;

Close a Margin user data stream (DELETE /sapi/v2/margin/listen-key). Weight(IP): 1. USER_STREAM. The listen key is not a parameter.

Returns

Promise<object>

closeMarginUtaUserDataListenKey()

closeMarginUtaUserDataListenKey(): Promise<object>;

Returns

Promise<object>

closeSpotUserDataListenKey()

closeSpotUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

convertBUSD()

convertBUSD(params: ConvertTransfer): Promise<ConvertTransferResponse>;

Parameters

Parameter	Type
`params`	`ConvertTransfer`

Returns

Promise<ConvertTransferResponse>

Deprecated

deleted as of 2024-11-21

convertDustAssets()

convertDustAssets(params: DustConvertParams): Promise<DustConversion>;

Convert dust assets to a target asset (e.g. BNB, USDT).

Parameters

Parameter	Type
`params`	`DustConvertParams`

Returns

Promise<DustConversion>

convertDustToBnb()

convertDustToBnb(params: ConvertDustParams): Promise<DustConversion>;

Parameters

Parameter	Type
`params`	`ConvertDustParams`

Returns

Promise<DustConversion>

convertQuoteRequest()

convertQuoteRequest(params: ConvertQuoteRequestParams): Promise<any>;

CONVERT Endpoints - Trade

Parameters

Parameter	Type
`params`	`ConvertQuoteRequestParams`

Returns

Promise<any>

createApiKeyBrokerSubAccount()

createApiKeyBrokerSubAccount(params: CreateApiKeyBrokerSubAccountParams): Promise<CreateApiKeyBrokerSubAccountResponse>;

Parameters

Parameter	Type
`params`	`CreateApiKeyBrokerSubAccountParams`

Returns

Promise<CreateApiKeyBrokerSubAccountResponse>

createBrokerSubAccount()

createBrokerSubAccount(params: CreateBrokerSubAccountParams): Promise<BrokerSubAccount>;

EXCHANGE LINK - Account Endpoints https://developers.binance.com/docs/binance_link

Parameters

Parameter	Type
`params`	`CreateBrokerSubAccountParams`

Returns

Promise<BrokerSubAccount>

createDualTokenGiftCard()

createDualTokenGiftCard(params: CreateDualTokenGiftCardParams): Promise<any>;

Parameters

Parameter	Type
`params`	`CreateDualTokenGiftCardParams`

Returns

Promise<any>

createGiftCard()

createGiftCard(params: CreateGiftCardParams): Promise<any>;

GIFT CARD Endpoints - Market Data

Parameters

Parameter	Type
`params`	`CreateGiftCardParams`

Returns

Promise<any>

createMarginSpecialLowLatencyKey()

createMarginSpecialLowLatencyKey(params: CreateSpecialLowLatencyKeyParams): Promise<SpecialLowLatencyKeyResponse>;

Create a special key for low-latency trading (VIP 4+ only)

Parameters

Parameter	Type
`params`	`CreateSpecialLowLatencyKeyParams`

Returns

Promise<SpecialLowLatencyKeyResponse>

createVirtualSubAccount()

createVirtualSubAccount(params: CreateSubAccountParams): Promise<VirtualSubAccount>;

SUB ACCOUNT Endpoints - Account management

Parameters

Parameter	Type
`params`	`CreateSubAccountParams`

Returns

Promise<VirtualSubAccount>

customizeCryptoLoanMarginCall()

customizeCryptoLoanMarginCall(params: CustomizeMarginCallParams): Promise<{
  rows: CustomizeMarginCall[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`CustomizeMarginCallParams`

Returns

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

Deprecated

delete()

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

Parameters

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

Returns

GenericAPIResponse

Inherited from

BaseRestClient.delete

deleteApiKeyBrokerSubAccount()

deleteApiKeyBrokerSubAccount(params: DeleteApiKeyBrokerSubAccountParams): Promise<object>;

Parameters

Parameter	Type
`params`	`DeleteApiKeyBrokerSubAccountParams`

Returns

Promise<object>

deleteBrokerSubAccount()

deleteBrokerSubAccount(params: object): Promise<any>;

Caution: The operation will delete a sub account under your brokerage master account. Please transfer out all funds from the sub account and delete API key of the sub account before deleting it. The deleted sub account CANNOT be reverted. The daily deletion limit for a broker Master is 20 sub accounts. You need to enable "trade" option for the api key which requests this endpoint.

Parameters

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

Returns

Promise<any>

deleteIPRestrictionForSubAccountApiKey()

deleteIPRestrictionForSubAccountApiKey(params: object): Promise<{
  apikey: string;
  ipList: string[];
  subaccountId: string;
  updateTime: number;
}>;

Parameters

Parameter	Type
`params`	{ `ipAddress?`: `string`; `subAccountApiKey`: `string`; `subAccountId`: `string`; }
`params.ipAddress?`	`string`
`params.subAccountApiKey`	`string`
`params.subAccountId`	`string`

Returns

Promise<{ apikey: string; ipList: string[]; subaccountId: string; updateTime: number; }>

deleteMarginSpecialLowLatencyKey()

deleteMarginSpecialLowLatencyKey(params?: object): Promise<any>;

Parameters

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

Returns

Promise<any>

deletePortfolioMarginMarginCallLevel()

deletePortfolioMarginMarginCallLevel(): Promise<PortfolioMarginMarginCallLevelDeleteResponse>;

Returns

Promise<PortfolioMarginMarginCallLevelDeleteResponse>

deletePrivate()

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

Parameters

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

Returns

GenericAPIResponse

Inherited from

BaseRestClient.deletePrivate

depositAssetsIntoManagedSubAccount()

depositAssetsIntoManagedSubAccount(params: SubAccountTransferToSameMasterParams): Promise<MarginTransactionResponse>;

SUB ACCOUNT Endpoints - Managed Sub Account

Parameters

Parameter	Type
`params`	`SubAccountTransferToSameMasterParams`

Returns

Promise<MarginTransactionResponse>

disableFastWithdrawSwitch()

disableFastWithdrawSwitch(): Promise<object>;

Returns

Promise<object>

disableIsolatedMarginAccount()

disableIsolatedMarginAccount(params: object): Promise<{
  success: boolean;
  symbol: string;
}>;

Parameters

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

Returns

Promise<{ success: boolean; symbol: string; }>

enableConvertSubAccount()

enableConvertSubAccount(params: EnableConvertSubAccountParams): Promise<any>;

Parameters

Parameter	Type
`params`	`EnableConvertSubAccountParams`

Returns

Promise<any>

Deprecated

enableFastWithdrawSwitch()

enableFastWithdrawSwitch(): Promise<object>;

Returns

Promise<object>

enableFuturesBrokerSubAccount()

enableFuturesBrokerSubAccount(params: EnableFuturesBrokerSubAccountParams): Promise<EnableFuturesBrokerSubAccountResponse>;

@deprecated, found only in old docs Use EXCHANGE LINK endpoints instead

Parameters

Parameter	Type
`params`	`EnableFuturesBrokerSubAccountParams`

Returns

Promise<EnableFuturesBrokerSubAccountResponse>

enableIsolatedMarginAccount()

enableIsolatedMarginAccount(params: object): Promise<{
  success: boolean;
  symbol: string;
}>;

Parameters

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

Returns

Promise<{ success: boolean; symbol: string; }>

enableMarginApiKeyBrokerSubAccount()

enableMarginApiKeyBrokerSubAccount(params: EnableMarginApiKeyBrokerSubAccountParams): Promise<BrokerSubAccount>;

@deprecated, found only in old docs Use EXCHANGE LINK endpoints instead

Parameters

Parameter	Type
`params`	`EnableMarginApiKeyBrokerSubAccountParams`

Returns

Promise<BrokerSubAccount>

enableMarginBrokerSubAccount()

enableMarginBrokerSubAccount(params: EnableMarginBrokerSubAccountParams): Promise<EnableMarginBrokerSubAccountResponse>;

Parameters

Parameter	Type
`params`	`EnableMarginBrokerSubAccountParams`

Returns

Promise<EnableMarginBrokerSubAccountResponse>

enableOptionsForSubAccount()

enableOptionsForSubAccount(params: object): Promise<EnableOptionsForSubAccountResponse>;

Parameters

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

Returns

Promise<EnableOptionsForSubAccountResponse>

enableUniversalTransferApiKeyBrokerSubAccount()

enableUniversalTransferApiKeyBrokerSubAccount(params: EnableUniversalTransferApiKeyBrokerSubAccountParams): Promise<EnableUniversalTransferApiKeyBrokerSubAccountResponse>;

Parameters

Parameter	Type
`params`	`EnableUniversalTransferApiKeyBrokerSubAccountParams`

Returns

Promise<EnableUniversalTransferApiKeyBrokerSubAccountResponse>

exitMarginSpecialKeyMode()

exitMarginSpecialKeyMode(): Promise<object>;

Exit Margin Special Key mode for Cross Margin Classic accounts.

Returns

Promise<object>

fetchLatencySummary()

fetchLatencySummary(): Promise<any>;

This method is used to get the latency and time sync between the client and the server. This is not official API endpoint and is only used for internal testing purposes. Use this method to check the latency and time sync between the client and the server. Final values might vary slightly, but it should be within few ms difference. If you have any suggestions or improvements to this measurement, please create an issue or pull request on GitHub.

Returns

Promise<any>

fetchTimeOffset()

fetchTimeOffset(): Promise<number>;

Estimate drift based on client<->server latency

Returns

Promise<number>

Inherited from

BaseRestClient.fetchTimeOffset

fiatDeposit()

fiatDeposit(params: FiatDepositParams): Promise<FiatDepositResponse>;

Parameters

Parameter	Type
`params`	`FiatDepositParams`

Returns

Promise<FiatDepositResponse>

fiatWithdraw()

fiatWithdraw(params: WithdrawFiatParams): Promise<{
  id: string;
}>;

Parameters

Parameter	Type
`params`	`WithdrawFiatParams`

Returns

Promise<{ id: string; }>

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

get24hrChangeStatistics()

Call Signature

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

Parameters

Parameter	Type
`params?`	{ `symbols?`: `string`[]; `symbolStatus?`: `string`; `type?`: `"FULL"` \| `"MINI"`; }
`params.symbols?`	`string`[]
`params.symbolStatus?`	`string`
`params.type?`	`"FULL"` \| `"MINI"`

Returns

Promise<Ticker24hrResponse[]>

Call Signature

get24hrChangeStatistics(params: object): Promise<Ticker24hrResponse>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; `symbolStatus?`: `string`; `type?`: `"FULL"` \| `"MINI"`; }
`params.symbol`	`string`
`params.symbolStatus?`	`string`
`params.type?`	`"FULL"` \| `"MINI"`

Returns

Promise<Ticker24hrResponse>

getAccountInfo()

getAccountInfo(): Promise<AccountInfo>;

WALLET Endpoints - Account endpoints

Returns

Promise<AccountInfo>

getAccountInformation()

getAccountInformation(params?: object): Promise<AccountInformation>;

Get current account information

Parameters

Parameter	Type
`params?`	{ `omitZeroBalances?`: `boolean`; }
`params.omitZeroBalances?`	`boolean`

Returns

Promise<AccountInformation>

getAccountStatus()

getAccountStatus(): Promise<{
  data: string;
}>;

Returns

Promise<{ data: string; }>

getAccountTradeList()

getAccountTradeList(params: SymbolFromPaginatedRequestFromId & object): Promise<RawAccountTrade[]>;

Parameters

Parameter	Type
`params`	`SymbolFromPaginatedRequestFromId` & `object`

Returns

Promise<RawAccountTrade[]>

getActiveInstLoanRiskUnits()

getActiveInstLoanRiskUnits(): Promise<ActiveInstitutionalLoanRiskUnit[]>;

Returns

Promise<ActiveInstitutionalLoanRiskUnit[]>

getAdjustCrossCollateralLTVHistory()

getAdjustCrossCollateralLTVHistory(params?: GetLoanCoinPaginatedHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params?`	`GetLoanCoinPaginatedHistoryParams`

Returns

Promise<any>

Deprecated

as of 2023-09-25

getAggregateTrades()

getAggregateTrades(params: SymbolFromPaginatedRequestFromId): Promise<AggregateTrade[]>;

Parameters

Parameter	Type
`params`	`SymbolFromPaginatedRequestFromId`

Returns

Promise<AggregateTrade[]>

getAlgoHistoricalOrders()

getAlgoHistoricalOrders(params: GetAlgoHistoricalOrdersParams): Promise<{
  orders: HistoricalAlgoOrder[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetAlgoHistoricalOrdersParams`

Returns

Promise<{ orders: HistoricalAlgoOrder[]; total: number; }>

getAlgoOpenOrders()

getAlgoOpenOrders(): Promise<{
  orders: AlgoOrder[];
  total: number;
}>;

Returns

Promise<{ orders: AlgoOrder[]; total: number; }>

getAlgoSubOrders()

getAlgoSubOrders(params: GetAlgoSubOrdersParams): Promise<GetAlgoSubOrdersResponse>;

Parameters

Parameter	Type
`params`	`GetAlgoSubOrdersParams`

Returns

Promise<GetAlgoSubOrdersResponse>

getAllCrossMarginPairs()

getAllCrossMarginPairs(): Promise<QueryCrossMarginPairResponse[]>;

Returns

Promise<QueryCrossMarginPairResponse[]>

getAllMarginAssets()

getAllMarginAssets(): Promise<QueryMarginAssetResponse[]>;

Returns

Promise<QueryMarginAssetResponse[]>

getAllocations()

getAllocations(params: AllocationsParams): Promise<Allocation[]>;

Parameters

Parameter	Type
`params`	`AllocationsParams`

Returns

Promise<Allocation[]>

getAllOCO()

getAllOCO(params?: BasicFromPaginatedParams): Promise<OrderList[]>;

Parameters

Parameter	Type
`params?`	`BasicFromPaginatedParams`

Returns

Promise<OrderList[]>

getAllOpenOCO()

getAllOpenOCO(): Promise<OrderList[]>;

Query open OCO

Returns

Promise<OrderList[]>

getAllOrders()

getAllOrders(params: GetAllOrdersParams): Promise<SpotOrder[]>;

Parameters

Parameter	Type
`params`	`GetAllOrdersParams`

Returns

Promise<SpotOrder[]>

getAlphaAggTrades()

getAlphaAggTrades(params: AlphaAggTradesParams): Promise<AlphaAggTrade[]>;

Parameters

Parameter	Type
`params`	`AlphaAggTradesParams`

Returns

Promise<AlphaAggTrade[]>

getAlphaExchangeInfo()

getAlphaExchangeInfo(): Promise<AlphaExchangeInfo>;

Returns

Promise<AlphaExchangeInfo>

getAlphaFullDepth()

getAlphaFullDepth(params: AlphaFullDepthParams): Promise<AlphaFullDepthResponse>;

Parameters

Parameter	Type
`params`	`AlphaFullDepthParams`

Returns

Promise<AlphaFullDepthResponse>

getAlphaKlines()

getAlphaKlines(params: AlphaKlinesParams): Promise<AlphaKline[]>;

Parameters

Parameter	Type
`params`	`AlphaKlinesParams`

Returns

Promise<AlphaKline[]>

getAlphaTicker()

getAlphaTicker(params: object): Promise<AlphaTicker>;

Parameters

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

Returns

Promise<AlphaTicker>

getAlphaTokenList()

getAlphaTokenList(): Promise<AlphaToken[]>;

ALPHA TRADING - Market Data https://developers.binance.com/docs/alpha

Returns

Promise<AlphaToken[]>

getApiKeyBrokerSubAccount()

getApiKeyBrokerSubAccount(params: GetApiKeyBrokerSubAccountParams): Promise<ApiKeyBrokerSubAccount[]>;

Parameters

Parameter	Type
`params`	`GetApiKeyBrokerSubAccountParams`

Returns

Promise<ApiKeyBrokerSubAccount[]>

getApiKeyPermissions()

getApiKeyPermissions(): Promise<APIPermissions>;

Returns

Promise<APIPermissions>

getApiTradingStatus()

getApiTradingStatus(): Promise<APITradingStatus>;

Returns

Promise<APITradingStatus>

getAssetDetail()

getAssetDetail(params?: Partial<BasicAssetParam>): Promise<Record<string, AssetDetail>>;

WALLET Endpoints - Asset endpoints

Parameters

Parameter	Type
`params?`	`Partial`<`BasicAssetParam`>

Returns

Promise<Record<string, AssetDetail>>

getAssetDividendRecord()

getAssetDividendRecord(params?: BasicAssetPaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params?`	`BasicAssetPaginatedParams`

Returns

Promise<any>

getAutoConvertStablecoins()

getAutoConvertStablecoins(): Promise<ConvertibleCoinsResponse>;

Returns

Promise<ConvertibleCoinsResponse>

Deprecated

deleted as of 2024-11-21

getAutoInvestAssets()

getAutoInvestAssets(): Promise<{
  sourceAssets: string[];
  targetAssets: string[];
}>;

AUTO INVEST Endpoints - Market data

Returns

Promise<{ sourceAssets: string[]; targetAssets: string[]; }>

getAutoInvestIndex()

getAutoInvestIndex(params: object): Promise<GetIndexDetailsResponse>;

Parameters

Parameter	Type
`params`	{ `indexId`: `number`; }
`params.indexId`	`number`

Returns

Promise<GetIndexDetailsResponse>

getAutoInvestPlan()

getAutoInvestPlan(params: GetPlanDetailsParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetPlanDetailsParams`

Returns

Promise<any>

getAutoInvestPlans()

getAutoInvestPlans(params: object): Promise<any>;

Parameters

Parameter	Type
`params`	{ `planType`: `"INDEX"` \| `"SINGLE"` \| `"PORTFOLIO"`; }
`params.planType`	`"INDEX"` \| `"SINGLE"` \| `"PORTFOLIO"`

Returns

Promise<any>

getAutoInvestRebalanceHistory()

getAutoInvestRebalanceHistory(params: GetIndexLinkedPlanRebalanceHistoryParams): Promise<GetIndexLinkedPlanRebalanceHistoryParams[]>;

Parameters

Parameter	Type
`params`	`GetIndexLinkedPlanRebalanceHistoryParams`

Returns

Promise<GetIndexLinkedPlanRebalanceHistoryParams[]>

getAutoInvestRedemptionHistory()

getAutoInvestRedemptionHistory(params: GetIndexLinkedPlanRedemptionHistoryParams): Promise<IndexLinkedPlanRedemptionRecord[]>;

Parameters

Parameter	Type
`params`	`GetIndexLinkedPlanRedemptionHistoryParams`

Returns

Promise<IndexLinkedPlanRedemptionRecord[]>

getAutoInvestSourceAssets()

getAutoInvestSourceAssets(params: GetSourceAssetListParams): Promise<GetSourceAssetListResponse>;

Parameters

Parameter	Type
`params`	`GetSourceAssetListParams`

Returns

Promise<GetSourceAssetListResponse>

getAutoInvestSubscriptionTransactions()

getAutoInvestSubscriptionTransactions(params: GetSubscriptionTransactionHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetSubscriptionTransactionHistoryParams`

Returns

Promise<any>

getAutoInvestTargetAssets()

getAutoInvestTargetAssets(params: GetTargetAssetListParams): Promise<GetTargetAssetListResponse>;

Parameters

Parameter	Type
`params`	`GetTargetAssetListParams`

Returns

Promise<GetTargetAssetListResponse>

getAutoInvestTargetAssetsROI()

getAutoInvestTargetAssetsROI(params: GetTargetAssetROIParams): Promise<TargetAssetROI[]>;

Parameters

Parameter	Type
`params`	`GetTargetAssetROIParams`

Returns

Promise<TargetAssetROI[]>

getAutoInvestUserIndex()

getAutoInvestUserIndex(params: object): Promise<GetIndexLinkedPlanPositionDetailsResponse>;

Parameters

Parameter	Type
`params`	{ `indexId`: `number`; }
`params.indexId`	`number`

Returns

Promise<GetIndexLinkedPlanPositionDetailsResponse>

getAutoRepayFuturesStatus()

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

Returns

Promise<{ autoRepay: boolean; }>

getAvgPrice()

getAvgPrice(params: object): Promise<CurrentAvgPrice>;

Parameters

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

Returns

Promise<CurrentAvgPrice>

getBalances()

getBalances(): Promise<AllCoinsInformationResponse[]>;

WALLET Endpoints - Capital endpoints

Returns

Promise<AllCoinsInformationResponse[]>

getBaseUrlKey()

getBaseUrlKey(): BinanceBaseUrlKey;

Returns

BinanceBaseUrlKey

Inherited from

BaseRestClient.getBaseUrlKey

getBethRewardsHistory()

getBethRewardsHistory(params: GetBethRewardsHistoryParams): Promise<{
  rows: BethRewardsHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetBethRewardsHistoryParams`

Returns

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

getBethUnwrapHistory()

getBethUnwrapHistory(params: GetWrapHistoryParams): Promise<{
  rows: WrapHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetWrapHistoryParams`

Returns

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

getBethWrapHistory()

getBethWrapHistory(params: GetWrapHistoryParams): Promise<{
  rows: WrapHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetWrapHistoryParams`

Returns

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

getBfusdAccount()

getBfusdAccount(): Promise<BfusdAccountResponse>;

BFUSD (sapi/v1/bfusd)

Returns

Promise<BfusdAccountResponse>

getBfusdQuota()

getBfusdQuota(): Promise<BfusdQuotaResponse>;

Returns

Promise<BfusdQuotaResponse>

getBfusdRateHistory()

getBfusdRateHistory(params: GetBfusdRateHistoryParams): Promise<{
  rows: BfusdRateHistoryRow[];
  total: string;
}>;

Parameters

Parameter	Type
`params`	`GetBfusdRateHistoryParams`

Returns

Promise<{ rows: BfusdRateHistoryRow[]; total: string; }>

getBfusdRedemptionHistory()

getBfusdRedemptionHistory(params: GetBfusdRedemptionHistoryParams): Promise<{
  rows: BfusdRedemptionHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetBfusdRedemptionHistoryParams`

Returns

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

getBfusdRewardsHistory()

getBfusdRewardsHistory(params: GetBfusdRewardsHistoryParams): Promise<{
  rows: BfusdRewardsHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetBfusdRewardsHistoryParams`

Returns

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

getBfusdSubscriptionHistory()

getBfusdSubscriptionHistory(params: GetBfusdSubscriptionHistoryParams): Promise<{
  rows: BfusdSubscriptionHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetBfusdSubscriptionHistoryParams`

Returns

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

getBlvtInfo()

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

BLVT Endpoints BLVT category is possibly @deprecated, found only in old docs

Parameters

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

Returns

Promise<any[]>

getBlvtRedemptionRecord()

getBlvtRedemptionRecord(params: GetBlvtRedemptionRecordParams): Promise<BlvtRedemptionRecord[]>;

Parameters

Parameter	Type
`params`	`GetBlvtRedemptionRecordParams`

Returns

Promise<BlvtRedemptionRecord[]>

getBlvtSubscriptionRecord()

getBlvtSubscriptionRecord(params: GetBlvtSubscriptionRecordParams): Promise<BlvtSubscriptionRecord[]>;

Parameters

Parameter	Type
`params`	`GetBlvtSubscriptionRecordParams`

Returns

Promise<BlvtSubscriptionRecord[]>

getBlvtUserLimitInfo()

getBlvtUserLimitInfo(params: object): Promise<BlvtUserLimitInfo[]>;

Parameters

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

Returns

Promise<BlvtUserLimitInfo[]>

getBNBBurn()

getBNBBurn(): Promise<BNBBurnResponse>;

Returns

Promise<BNBBurnResponse>

getBnsolRateHistory()

getBnsolRateHistory(params?: GetBnsolRateHistoryReq): Promise<{
  rows: BnsolRateHistoryRecord[];
  total: string;
}>;

Parameters

Parameter	Type
`params?`	`GetBnsolRateHistoryReq`

Returns

Promise<{ rows: BnsolRateHistoryRecord[]; total: string; }>

getBnsolRewardsHistory()

getBnsolRewardsHistory(params?: GetBnsolRewardsHistoryReq): Promise<{
  estRewardsInSOL: string;
  rows: BnsolRewardHistoryRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`GetBnsolRewardsHistoryReq`

Returns

Promise<{ estRewardsInSOL: string; rows: BnsolRewardHistoryRecord[]; total: number; }>

getBrokerFuturesCommissionRebate()

getBrokerFuturesCommissionRebate(params: QueryBrokerFuturesCommissionRebateParams): Promise<BrokerCommissionRebate[]>;

Parameters

Parameter	Type
`params`	`QueryBrokerFuturesCommissionRebateParams`

Returns

Promise<BrokerCommissionRebate[]>

getBrokerIfNewSpotUser()

getBrokerIfNewSpotUser(): Promise<{
  ifNewUser: boolean;
  rebateWorking: boolean;
}>;

@deprecated, found only in old docs Use EXCHANGE LINK endpoints instead

Returns

Promise<{ ifNewUser: boolean; rebateWorking: boolean; }>

getBrokerInfo()

getBrokerInfo(): Promise<GetBrokerInfoResponse>;

Returns

Promise<GetBrokerInfoResponse>

getBrokerSpotCommissionRebate()

getBrokerSpotCommissionRebate(params: QueryBrokerSpotCommissionRebateParams): Promise<BrokerCommissionRebate[]>;

Parameters

Parameter	Type
`params`	`QueryBrokerSpotCommissionRebateParams`

Returns

Promise<BrokerCommissionRebate[]>

getBrokerSpotRebateHistory()

getBrokerSpotRebateHistory(days: 7 | 30, customerId?: string): 
  | GenericAPIResponse
  | undefined;

Parameters

Parameter	Type
`days`	`7` \| `30`
`customerId?`	`string`

Returns

| GenericAPIResponse | undefined

Deprecated

getBrokerSubAccount()

getBrokerSubAccount(params: GetBrokerSubAccountParams): Promise<BrokerSubAccount[]>;

Parameters

Parameter	Type
`params`	`GetBrokerSubAccountParams`

Returns

Promise<BrokerSubAccount[]>

getBrokerSubAccountCoinFuturesCommission()

getBrokerSubAccountCoinFuturesCommission(params: QuerySubAccountCoinFuturesCommissionParams): Promise<BrokerSubAccountCoinFuturesCommission[]>;

Parameters

Parameter	Type
`params`	`QuerySubAccountCoinFuturesCommissionParams`

Returns

Promise<BrokerSubAccountCoinFuturesCommission[]>

getBrokerSubAccountDepositHistory()

getBrokerSubAccountDepositHistory(params?: GetBrokerSubAccountDepositHistoryParams): Promise<SubAccountDepositHistoryList[]>;

@deprecated, found only in old docs Use EXCHANGE LINK endpoints instead

Parameters

Parameter	Type
`params?`	`GetBrokerSubAccountDepositHistoryParams`

Returns

Promise<SubAccountDepositHistoryList[]>

getBrokerSubAccountFuturesCommission()

getBrokerSubAccountFuturesCommission(params: QuerySubAccountFuturesCommissionParams): Promise<BrokerSubAccountFuturesCommission[]>;

Parameters

Parameter	Type
`params`	`QuerySubAccountFuturesCommissionParams`

Returns

Promise<BrokerSubAccountFuturesCommission[]>

getBrokerSubAccountHistory()

getBrokerSubAccountHistory(params: GetBrokerSubAccountHistoryParams): Promise<BrokerSubAccountHistory[]>;

Parameters

Parameter	Type
`params`	`GetBrokerSubAccountHistoryParams`

Returns

Promise<BrokerSubAccountHistory[]>

getBrokerSubAccountSpotAssets()

getBrokerSubAccountSpotAssets(params: QuerySubAccountSpotMarginAssetInfoParams): Promise<{
  data: SubaccountBrokerSpotAsset[];
  timestamp: number;
}>;

Parameters

Parameter	Type
`params`	`QuerySubAccountSpotMarginAssetInfoParams`

Returns

Promise<{ data: SubaccountBrokerSpotAsset[]; timestamp: number; }>

getBrokerSubDepositHistory()

getBrokerSubDepositHistory(params: GetSubAccountDepositHistoryParams): Promise<SubAccountDeposit[]>;

Parameters

Parameter	Type
`params`	`GetSubAccountDepositHistoryParams`

Returns

Promise<SubAccountDeposit[]>

getBrokerUserCustomisedId()

getBrokerUserCustomisedId(market: "spot" | "futures"): GenericAPIResponse;

@deprecated, found only in old docs Use EXCHANGE LINK endpoints instead

Parameters

Parameter	Type
`market`	`"spot"` \| `"futures"`

Returns

GenericAPIResponse

getBSwapLiquidity()

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

Parameters

Parameter	Type
`params?`	{ `poolId`: `number`; }
`params.poolId`	`number`

Returns

Promise<BSwapLiquidity[]>

Deprecated

as of 2024-01-19

getBSwapOperations()

getBSwapOperations(params?: BSwapOperationsParams): Promise<BSwapOperations[]>;

Parameters

Parameter	Type
`params?`	`BSwapOperationsParams`

Returns

Promise<BSwapOperations[]>

Deprecated

as of 2024-01-19

getC2CTradeHistory()

getC2CTradeHistory(params: GetC2CTradeHistoryParams): Promise<GetC2CTradeHistoryResponse>;

C2C Endpoints

Parameters

Parameter	Type
`params`	`GetC2CTradeHistoryParams`

Returns

Promise<GetC2CTradeHistoryResponse>

getClosedInstLoanRiskUnits()

getClosedInstLoanRiskUnits(params?: GetClosedInstitutionalLoanRiskUnitsParams): Promise<GetClosedInstitutionalLoanRiskUnitsResponse>;

Parameters

Parameter	Type
`params?`	`GetClosedInstitutionalLoanRiskUnitsParams`

Returns

Promise<GetClosedInstitutionalLoanRiskUnitsResponse>

getCloudMiningHistory()

getCloudMiningHistory(params: CloudMiningHistoryParams): Promise<{
  rows: CloudMining[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`CloudMiningHistoryParams`

Returns

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

getCollateralRecord()

getCollateralRecord(params: GetCollateralRecordParams): Promise<{
  rows: CollateralRecord[];
  total: string;
}>;

Parameters

Parameter	Type
`params`	`GetCollateralRecordParams`

Returns

Promise<{ rows: CollateralRecord[]; total: string; }>

getCommissionRates()

getCommissionRates(params: object): Promise<CommissionRates>;

Parameters

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

Returns

Promise<CommissionRates>

getConvertAssetInfo()

getConvertAssetInfo(): Promise<any>;

Returns

Promise<any>

getConvertBUSDHistory()

getConvertBUSDHistory(params: GetConvertBUSDHistoryParams): Promise<{
  rows: BUSDConversionRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetConvertBUSDHistoryParams`

Returns

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

Deprecated

getConvertLimitOpenOrders()

getConvertLimitOpenOrders(): Promise<{
  list: ConvertLimitOpenOrder[];
}>;

Returns

Promise<{ list: ConvertLimitOpenOrder[]; }>

getConvertPairs()

getConvertPairs(params: GetAllConvertPairsParams): Promise<any>;

CONVERT Endpoints - Market Data

Parameters

Parameter	Type
`params`	`GetAllConvertPairsParams`

Returns

Promise<any>

getConvertTradeHistory()

getConvertTradeHistory(params: GetConvertTradeHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetConvertTradeHistoryParams`

Returns

Promise<any>

getCrossCollateralBorrowHistory()

getCrossCollateralBorrowHistory(params?: CoinStartEndLimit): Promise<any>;

Parameters

Parameter	Type
`params?`	`CoinStartEndLimit`

Returns

Promise<any>

Deprecated

as of 2023-09-25

getCrossCollateralInterestHistory()

getCrossCollateralInterestHistory(params?: GetLoanCoinPaginatedHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params?`	`GetLoanCoinPaginatedHistoryParams`

Returns

Promise<any>

Deprecated

as of 2023-09-25

getCrossCollateralLiquidationHistory()

getCrossCollateralLiquidationHistory(params?: GetLoanCoinPaginatedHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params?`	`GetLoanCoinPaginatedHistoryParams`

Returns

Promise<any>

Deprecated

as of 2023-09-25

getCrossCollateralRepaymentHistory()

getCrossCollateralRepaymentHistory(params?: CoinStartEndLimit): Promise<any>;

Parameters

Parameter	Type
`params?`	`CoinStartEndLimit`

Returns

Promise<any>

Deprecated

as of 2023-09-25

getCrossCollateralWalletV2()

getCrossCollateralWalletV2(): Promise<any>;

Returns

Promise<any>

Deprecated

as of 2023-09-25

getCrossMarginCollateralRatio()

getCrossMarginCollateralRatio(): Promise<object[]>;

MARGIN TRADING Endpoints - Market Data endpoints

Returns

Promise<object[]>

getCrossMarginFeeData()

getCrossMarginFeeData(params: QueryCrossMarginFeeDataParams): Promise<CrossMarginFeeData[]>;

Parameters

Parameter	Type
`params`	`QueryCrossMarginFeeDataParams`

Returns

Promise<CrossMarginFeeData[]>

getCrossMarginTransferHistory()

getCrossMarginTransferHistory(params: GetCrossMarginTransferHistoryParams): Promise<RowsWithTotal<CrossMarginTransferHistory>>;

MARGIN TRADING Endpoints - Transfer endpoints

Parameters

Parameter	Type
`params`	`GetCrossMarginTransferHistoryParams`

Returns

Promise<RowsWithTotal<CrossMarginTransferHistory>>

getCryptoLoanBorrowHistory()

getCryptoLoanBorrowHistory(params: GetLoanBorrowHistoryParams): Promise<{
  rows: LoanBorrowHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanBorrowHistoryParams`

Returns

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

Deprecated

Stable Rate history was retired on 2026-10-16. GET /sapi/v1/loan/borrow/history returns HTTP 404. Flexible Rate v2 is unaffected.

getCryptoLoanCollateralAssetsData()

getCryptoLoanCollateralAssetsData(params: GetCollateralAssetDataParams): Promise<{
  rows: CollateralAssetData[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetCollateralAssetDataParams`

Returns

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

Deprecated

getCryptoLoanCollateralRepayRate()

getCryptoLoanCollateralRepayRate(params: CheckCollateralRepayRateParams): Promise<CheckCollateralRepayRateResponse>;

Parameters

Parameter	Type
`params`	`CheckCollateralRepayRateParams`

Returns

Promise<CheckCollateralRepayRateResponse>

getCryptoLoanFlexibleAssets()

getCryptoLoanFlexibleAssets(params: object): Promise<{
  rows: FlexibleLoanAssetData[];
  total: number;
}>;

Parameters

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

Returns

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

getCryptoLoanFlexibleCollateralAssets()

getCryptoLoanFlexibleCollateralAssets(params: object): Promise<{
  rows: FlexibleLoanCollateralAssetData[];
  total: number;
}>;

CRYPTO LOAN Endpoints - Flexible rate - Market data

Parameters

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

Returns

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

getCryptoLoanFlexibleLTVAdjustmentHistory()

getCryptoLoanFlexibleLTVAdjustmentHistory(params: GetFlexibleLoanLTVAdjustmentHistoryParams): Promise<{
  rows: FlexibleLoanLTVAdjustmentHistory[];
  total: number;
}>;

CRYPTO LOAN Endpoints - Flexible rate - User info

Parameters

Parameter	Type
`params`	`GetFlexibleLoanLTVAdjustmentHistoryParams`

Returns

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

getCryptoLoanFlexibleOngoingOrders()

getCryptoLoanFlexibleOngoingOrders(params: GetFlexibleLoanOngoingOrdersParams): Promise<{
  rows: FlexibleLoanOngoingOrder[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetFlexibleLoanOngoingOrdersParams`

Returns

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

getCryptoLoanLoanableAssets()

getCryptoLoanLoanableAssets(params: GetLoanableAssetsDataParams): Promise<{
  rows: LoanableAssetData[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanableAssetsDataParams`

Returns

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

Deprecated

getCryptoLoanLTVAdjustmentHistory()

getCryptoLoanLTVAdjustmentHistory(params: GetLoanLTVAdjustmentHistoryParams): Promise<{
  rows: LoanLTVAdjustmentHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanLTVAdjustmentHistoryParams`

Returns

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

Deprecated

Stable Rate history was retired on 2026-10-16. GET /sapi/v1/loan/ltv/adjustment/history returns HTTP 404. Flexible Rate v2 is unaffected.

getCryptoLoanOngoingOrders()

getCryptoLoanOngoingOrders(params: GetLoanOngoingOrdersParams): Promise<{
  rows: LoanOngoingOrder[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanOngoingOrdersParams`

Returns

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

Deprecated

getCryptoLoanRepaymentHistory()

getCryptoLoanRepaymentHistory(params: GetLoanRepaymentHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetLoanRepaymentHistoryParams`

Returns

Promise<any>

Deprecated

Stable Rate history was retired on 2026-10-16. GET /sapi/v1/loan/repay/history returns HTTP 404. Flexible Rate v2 is unaffected.

getCryptoLoansIncomeHistory()

getCryptoLoansIncomeHistory(params: GetCryptoLoansIncomeHistoryParams): Promise<GetCryptoLoansIncomeHistoryResponse[]>;

Parameters

Parameter	Type
`params`	`GetCryptoLoansIncomeHistoryParams`

Returns

Promise<GetCryptoLoansIncomeHistoryResponse[]>

Deprecated

Stable Rate history was retired on 2026-10-16. GET /sapi/v1/loan/income returns HTTP 404. Flexible Rate v2 is unaffected.

getDailyAccountSnapshot()

getDailyAccountSnapshot(params: DailyAccountSnapshotParams): Promise<DailyAccountSnapshot>;

Parameters

Parameter	Type
`params`	`DailyAccountSnapshotParams`

Returns

Promise<DailyAccountSnapshot>

getDelegationHistory()

getDelegationHistory(params: DelegationHistoryParams): Promise<RowsWithTotal<DelegationHistory>>;

Parameters

Parameter	Type
`params`	`DelegationHistoryParams`

Returns

Promise<RowsWithTotal<DelegationHistory>>

getDelistSchedule()

getDelistSchedule(): Promise<DelistScheduleResponse[]>;

Returns

Promise<DelistScheduleResponse[]>

getDepositAddress()

getDepositAddress(params: DepositAddressParams): Promise<DepositAddressResponse>;

Parameters

Parameter	Type
`params`	`DepositAddressParams`

Returns

Promise<DepositAddressResponse>

getDepositAddresses()

getDepositAddresses(params: DepositAddressListParams): Promise<DepositAddress[]>;

Parameters

Parameter	Type
`params`	`DepositAddressListParams`

Returns

Promise<DepositAddress[]>

getDepositHistory()

getDepositHistory(params?: DepositHistoryParams): Promise<DepositHistory[]>;

Parameters

Parameter	Type
`params?`	`DepositHistoryParams`

Returns

Promise<DepositHistory[]>

getDualInvestmentAccounts()

getDualInvestmentAccounts(): Promise<CheckDualInvestmentAccountsResponse>;

Returns

Promise<CheckDualInvestmentAccountsResponse>

getDualInvestmentPositions()

getDualInvestmentPositions(params: GetDualInvestmentPositionsParams): Promise<{
  list: DualInvestmentPosition[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetDualInvestmentPositionsParams`

Returns

Promise<{ list: DualInvestmentPosition[]; total: number; }>

getDualInvestmentProducts()

getDualInvestmentProducts(params: GetDualInvestmentProductListParams): Promise<{
  list: DualInvestmentProduct[];
  total: number;
}>;

DUAL INVESTMENT Endpoints - Market Data

Parameters

Parameter	Type
`params`	`GetDualInvestmentProductListParams`

Returns

Promise<{ list: DualInvestmentProduct[]; total: number; }>

getDust()

getDust(params: object): Promise<DustInfo>;

Parameters

Parameter	Type
`params`	{ `accountType?`: `"SPOT"` \| `"MARGIN"`; }
`params.accountType?`	`"SPOT"` \| `"MARGIN"`

Returns

Promise<DustInfo>

getDustLog()

getDustLog(params?: BasicTimeRangeParam): Promise<DustLog>;

Parameters

Parameter	Type
`params?`	`BasicTimeRangeParam`

Returns

Promise<DustLog>

getEthRateHistory()

getEthRateHistory(params: GetETHRateHistoryParams): Promise<{
  rows: ETHRateHistory[];
  total: string;
}>;

Parameters

Parameter	Type
`params`	`GetETHRateHistoryParams`

Returns

Promise<{ rows: ETHRateHistory[]; total: string; }>

getEthRedemptionHistory()

getEthRedemptionHistory(params: GetEthRedemptionHistoryParams): Promise<{
  rows: EthRedemptionHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetEthRedemptionHistoryParams`

Returns

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

getEthStakingAccount()

getEthStakingAccount(): Promise<GetEthStakingAccountResponse>;

Returns

Promise<GetEthStakingAccountResponse>

Deprecated

use getEthStakingAccountV2 instead

getEthStakingAccountV2()

getEthStakingAccountV2(): Promise<GetEthStakingAccountV2Response>;

Returns

Promise<GetEthStakingAccountV2Response>

getEthStakingHistory()

getEthStakingHistory(params: GetEthStakingHistoryParams): Promise<{
  rows: EthStakingHistory[];
  total: number;
}>;

STAKING Endpoints - ETH Staking - History

Parameters

Parameter	Type
`params`	`GetEthStakingHistoryParams`

Returns

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

getEthStakingQuota()

getEthStakingQuota(): Promise<GetEthStakingQuotaResponse>;

Returns

Promise<GetEthStakingQuotaResponse>

getExchangeInfo()

getExchangeInfo(params?: ExchangeInfoParams): Promise<ExchangeInfo>;

Parameters

Parameter	Type
`params?`	`ExchangeInfoParams`

Returns

Promise<ExchangeInfo>

getExecutionRules()

getExecutionRules(params?: SpotExecutionRulesParams): Promise<SpotExecutionRulesResponse>;

Parameters

Parameter	Type
`params?`	`SpotExecutionRulesParams`

Returns

Promise<SpotExecutionRulesResponse>

getExtraBonuses()

getExtraBonuses(params: GetExtraBonusListParams): Promise<GetExtraBonusListResponse>;

Parameters

Parameter	Type
`params`	`GetExtraBonusListParams`

Returns

Promise<GetExtraBonusListResponse>

getFiatOrderDetail()

getFiatOrderDetail(params: GetFiatOrderDetailParams): Promise<GetFiatOrderDetailResponse>;

Parameters

Parameter	Type
`params`	`GetFiatOrderDetailParams`

Returns

Promise<GetFiatOrderDetailResponse>

getFiatOrderHistory()

getFiatOrderHistory(params: GetFiatOrderHistoryParams): Promise<GetFiatOrderHistoryResponse>;

FIAT Endpoints - REST api

Parameters

Parameter	Type
`params`	`GetFiatOrderHistoryParams`

Returns

Promise<GetFiatOrderHistoryResponse>

getFiatPaymentsHistory()

getFiatPaymentsHistory(params: GetFiatOrderHistoryParams): Promise<GetFiatPaymentsHistoryResponse>;

Parameters

Parameter	Type
`params`	`GetFiatOrderHistoryParams`

Returns

Promise<GetFiatPaymentsHistoryResponse>

getFixedAndActivityProductPosition()

getFixedAndActivityProductPosition(params: FixedAndActivityProjectPositionParams): Promise<any[]>;

Parameters

Parameter	Type
`params`	`FixedAndActivityProjectPositionParams`

Returns

Promise<any[]>

Deprecated

as of 2023-06-22, now Simple Earn

getFixedAndActivityProjects()

getFixedAndActivityProjects(params: FixedAndActivityProjectParams): Promise<any[]>;

Parameters

Parameter	Type
`params`	`FixedAndActivityProjectParams`

Returns

Promise<any[]>

Deprecated

as of 2023-06-22, now Simple Earn

getFlexibleLoanCollateralRepayRate()

getFlexibleLoanCollateralRepayRate(params: object): Promise<{
  collateralCoin: string;
  loanCoin: string;
  rate: string;
}>;

Parameters

Parameter	Type
`params`	{ `collateralCoin`: `string`; `loanCoin`: `string`; }
`params.collateralCoin`	`string`
`params.loanCoin`	`string`

Returns

Promise<{ collateralCoin: string; loanCoin: string; rate: string; }>

getFlexibleLoanLiquidationHistory()

getFlexibleLoanLiquidationHistory(params?: GetFlexibleLoanLiquidationHistoryParams): Promise<{
  rows: FlexibleLoanLiquidationHistoryRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`GetFlexibleLoanLiquidationHistoryParams`

Returns

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

getFlexiblePersonalLeftQuota()

getFlexiblePersonalLeftQuota(params: object): Promise<{
  leftPersonalQuota: string;
}>;

Parameters

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

Returns

Promise<{ leftPersonalQuota: string; }>

getFlexibleProductPosition()

getFlexibleProductPosition(params?: SimpleEarnFlexibleProductPositionParams): Promise<{
  rows: any[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`SimpleEarnFlexibleProductPositionParams`

Returns

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

getFlexibleRedemptionRecord()

getFlexibleRedemptionRecord(params: GetFlexibleRedemptionRecordParams): Promise<{
  rows: FlexibleRedemptionRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetFlexibleRedemptionRecordParams`

Returns

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

getFlexibleRewardsHistory()

getFlexibleRewardsHistory(params: GetFlexibleRewardsHistoryParams): Promise<{
  rows: FlexibleRewardsHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetFlexibleRewardsHistoryParams`

Returns

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

getFlexibleSavingProducts()

getFlexibleSavingProducts(params?: SimpleEarnProductListParams): Promise<{
  rows: SimpleEarnFlexibleProduct[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`SimpleEarnProductListParams`

Returns

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

getFlexibleSubscriptionPreview()

getFlexibleSubscriptionPreview(params: GetFlexibleSubscriptionPreviewParams): Promise<FlexibleSubscriptionPreview>;

Parameters

Parameter	Type
`params`	`GetFlexibleSubscriptionPreviewParams`

Returns

Promise<FlexibleSubscriptionPreview>

getFlexibleSubscriptionRecord()

getFlexibleSubscriptionRecord(params: GetFlexibleSubscriptionRecordParams): Promise<{
  rows: GetFlexibleSubscriptionRecordResponse[];
  total: number;
}>;

SIMPLE EARN Endpoints - History

Parameters

Parameter	Type
`params`	`GetFlexibleSubscriptionRecordParams`

Returns

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

getForBaseUrl()

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

Parameters

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

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getForBaseUrl

getFundingAsset()

getFundingAsset(params: GetAssetParams): Promise<FundingAsset[]>;

Parameters

Parameter	Type
`params`	`GetAssetParams`

Returns

Promise<FundingAsset[]>

getFutureAccountTransferHistory()

getFutureAccountTransferHistory(params: GetFutureAccountTransferHistoryParams): Promise<RowsWithTotal<FutureAccountTransfer>>;

Possibly @deprecated, found only in old docs only Use sapi/v1/asset/transfer instead

Parameters

Parameter	Type
`params`	`GetFutureAccountTransferHistoryParams`

Returns

Promise<RowsWithTotal<FutureAccountTransfer>>

getFuturesLeadTraderStatus()

getFuturesLeadTraderStatus(): Promise<GetFuturesLeadTraderStatusResponse>;

COPY TRADING Endpoints - Future copy trading

Returns

Promise<GetFuturesLeadTraderStatusResponse>

getFuturesLeadTradingSymbolWhitelist()

getFuturesLeadTradingSymbolWhitelist(): Promise<GetFuturesLeadTradingSymbolWhitelistResponse[]>;

Returns

Promise<GetFuturesLeadTradingSymbolWhitelistResponse[]>

getFuturesTickLevelOrderbookDataLink()

getFuturesTickLevelOrderbookDataLink(params: GetFutureTickLevelOrderbookDataLinkParams): Promise<{
  data: HistoricalDataLink[];
}>;

DERIVATIVES - Futures Data - Market This is in mainclient because it shares the same base url

Parameters

Parameter	Type
`params`	`GetFutureTickLevelOrderbookDataLinkParams`

Returns

Promise<{ data: HistoricalDataLink[]; }>

getHashrateResale()

getHashrateResale(params: GetHashrateResaleDetailParams): Promise<GetHashrateResaleDetailResponse>;

Parameters

Parameter	Type
`params`	`GetHashrateResaleDetailParams`

Returns

Promise<GetHashrateResaleDetailResponse>

getHashrateResales()

getHashrateResales(params: GetHashrateResaleListParams): Promise<GetHashrateResaleListResponse>;

Parameters

Parameter	Type
`params`	`GetHashrateResaleListParams`

Returns

Promise<GetHashrateResaleListResponse>

getHistoricalBlockTrades()

getHistoricalBlockTrades(params: HistoricalBlockTradesParams): Promise<BlockTrade[]>;

Parameters

Parameter	Type
`params`	`HistoricalBlockTradesParams`

Returns

Promise<BlockTrade[]>

getHistoricalTrades()

getHistoricalTrades(params: HistoricalTradesParams): Promise<RawTrade[]>;

Parameters

Parameter	Type
`params`	`HistoricalTradesParams`

Returns

Promise<RawTrade[]>

getInstitutionalLoanMaxBorrowable()

getInstitutionalLoanMaxBorrowable(params: GetInstitutionalLoanMaxBorrowableParams): Promise<InstitutionalLoanMaxBorrowableResponse>;

INSTITUTIONAL LOAN - Borrow/Repay Endpoints

Parameters

Parameter	Type
`params`	`GetInstitutionalLoanMaxBorrowableParams`

Returns

Promise<InstitutionalLoanMaxBorrowableResponse>

getInstLoanBorrowRepayRecords()

getInstLoanBorrowRepayRecords(params: GetInstitutionalLoanBorrowRepayRecordsParams): Promise<GetInstitutionalLoanBorrowRepayRecordsResponse>;

Parameters

Parameter	Type
`params`	`GetInstitutionalLoanBorrowRepayRecordsParams`

Returns

Promise<GetInstitutionalLoanBorrowRepayRecordsResponse>

getInstLoanForceLiquidationRecord()

getInstLoanForceLiquidationRecord(params: GetInstitutionalLoanForceLiquidationParams): Promise<GetInstitutionalLoanForceLiquidationResponse>;

INSTITUTIONAL LOAN - Trade Endpoints

Parameters

Parameter	Type
`params`	`GetInstitutionalLoanForceLiquidationParams`

Returns

Promise<GetInstitutionalLoanForceLiquidationResponse>

getInstLoanInterestHistory()

getInstLoanInterestHistory(params?: GetInstitutionalLoanInterestHistoryParams): Promise<InstitutionalLoanInterestHistoryResponse>;

Parameters

Parameter	Type
`params?`	`GetInstitutionalLoanInterestHistoryParams`

Returns

Promise<InstitutionalLoanInterestHistoryResponse>

getInstLoanRiskUnit()

getInstLoanRiskUnit(params?: GetInstitutionalLoanRiskUnitDetailsParams): Promise<InstitutionalLoanRiskUnitDetails[]>;

INSTITUTIONAL LOAN - Account Endpoints

Parameters

Parameter	Type
`params?`	`GetInstitutionalLoanRiskUnitDetailsParams`

Returns

Promise<InstitutionalLoanRiskUnitDetails[]>

getInterestHistory()

getInterestHistory(params: PurchaseRecordParams): Promise<any[]>;

Parameters

Parameter	Type
`params`	`PurchaseRecordParams`

Returns

Promise<any[]>

Deprecated

as of 2023-06-22, now Simple Earn

getIsolatedMarginAccountInfo()

getIsolatedMarginAccountInfo(params?: object): Promise<IsolatedMarginAccountInfo>;

Parameters

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

Returns

Promise<IsolatedMarginAccountInfo>

getIsolatedMarginAccountLimit()

getIsolatedMarginAccountLimit(): Promise<{
  enabledAccount: number;
  maxAccount: number;
}>;

Returns

Promise<{ enabledAccount: number; maxAccount: number; }>

getIsolatedMarginAllSymbols()

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

Parameters

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

Returns

Promise<IsolatedMarginSymbol[]>

getIsolatedMarginFeeData()

getIsolatedMarginFeeData(params: QueryCrossMarginFeeDataParams): Promise<IsolatedMarginFeeData[]>;

Parameters

Parameter	Type
`params`	`QueryCrossMarginFeeDataParams`

Returns

Promise<IsolatedMarginFeeData[]>

getIsolatedMarginTierData()

getIsolatedMarginTierData(params: QueryIsolatedMarginTierDataParams): Promise<IsolatedMarginTierData[]>;

Parameters

Parameter	Type
`params`	`QueryIsolatedMarginTierDataParams`

Returns

Promise<IsolatedMarginTierData[]>

getIsolatedMarginUserDataListenKey()

getIsolatedMarginUserDataListenKey(params: object): Promise<{
  listenKey: string;
}>;

Parameters

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

Returns

Promise<{ listenKey: string; }>

getKlines()

getKlines(params: KlinesParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`KlinesParams`

Returns

Promise<Kline[]>

getLeftDailyPurchaseQuotaFlexibleProduct()

getLeftDailyPurchaseQuotaFlexibleProduct(params: object): Promise<LeftDailyPurchaseQuotaFlexibleProductResponse>;

Parameters

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

Returns

Promise<LeftDailyPurchaseQuotaFlexibleProductResponse>

Deprecated

as of 2023-06-22, now Simple Earn

getLeftDailyRedemptionQuotaFlexibleProduct()

getLeftDailyRedemptionQuotaFlexibleProduct(params: object): Promise<LeftDailyPurchaseQuotaFlexibleProductResponse & object>;

Parameters

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

Returns

Promise<LeftDailyPurchaseQuotaFlexibleProductResponse & object>

Deprecated

as of 2023-06-22, now Simple Earn

getLendingAccount()

getLendingAccount(): Promise<StakingProduct[]>;

Returns

Promise<StakingProduct[]>

Deprecated

as of 2023-06-22, now Simple Earn

getLeverageBracket()

getLeverageBracket(): Promise<LiabilityCoinLeverageBracket[]>;

Returns

Promise<LiabilityCoinLeverageBracket[]>

getLoanFlexibleBorrowHistory()

getLoanFlexibleBorrowHistory(params: GetFlexibleCryptoLoanBorrowHistoryParams): Promise<{
  rows: FlexibleCryptoLoanBorrowHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetFlexibleCryptoLoanBorrowHistoryParams`

Returns

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

getLoanFlexibleRepaymentHistory()

getLoanFlexibleRepaymentHistory(params: GetLoanRepaymentHistoryParams): Promise<{
  rows: LoanRepaymentHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanRepaymentHistoryParams`

Returns

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

getLockedPersonalLeftQuota()

getLockedPersonalLeftQuota(params: object): Promise<{
  leftPersonalQuota: string;
}>;

Parameters

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

Returns

Promise<{ leftPersonalQuota: string; }>

getLockedProductPosition()

getLockedProductPosition(params?: SimpleEarnLockedProductPositionParams): Promise<{
  rows: SimpleEarnLockedProductPosition[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`SimpleEarnLockedProductPositionParams`

Returns

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

getLockedRedemptionRecord()

getLockedRedemptionRecord(params: GetLockedRedemptionRecordParams): Promise<{
  rows: LockedRedemptionRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLockedRedemptionRecordParams`

Returns

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

getLockedRewardsHistory()

getLockedRewardsHistory(params: GetLockedRewardsHistoryParams): Promise<{
  rows: GetLockedRewardsHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLockedRewardsHistoryParams`

Returns

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

getLockedSubscriptionPreview()

getLockedSubscriptionPreview(params: GetLockedSubscriptionPreviewParams): Promise<LockedSubscriptionPreview[]>;

Parameters

Parameter	Type
`params`	`GetLockedSubscriptionPreviewParams`

Returns

Promise<LockedSubscriptionPreview[]>

getLockedSubscriptionRecord()

getLockedSubscriptionRecord(params: GetLockedSubscriptionRecordParams): Promise<{
  rows: LockedSubscriptionRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLockedSubscriptionRecordParams`

Returns

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

getManagedSubAccountAssetDetails()

getManagedSubAccountAssetDetails(email: string): Promise<SubAccountAssetDetails[]>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<SubAccountAssetDetails[]>

getManagedSubAccountDepositAddress()

getManagedSubAccountDepositAddress(params: ManagedSubAccountDepositAddressParams): Promise<ManagedSubAccountDepositAddress>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountDepositAddressParams`

Returns

Promise<ManagedSubAccountDepositAddress>

getManagedSubAccountFuturesAssets()

getManagedSubAccountFuturesAssets(params: object): Promise<ManagedSubAccountFuturesAssetsResponse>;

Parameters

Parameter	Type
`params`	{ `accountType?`: `string`; `email`: `string`; }
`params.accountType?`	`string`
`params.email`	`string`

Returns

Promise<ManagedSubAccountFuturesAssetsResponse>

getManagedSubAccountMarginAssets()

getManagedSubAccountMarginAssets(params: object): Promise<ManagedSubAccountMarginAssetsResponse>;

Parameters

Parameter	Type
`params`	{ `accountType?`: `string`; `email`: `string`; }
`params.accountType?`	`string`
`params.email`	`string`

Returns

Promise<ManagedSubAccountMarginAssetsResponse>

getManagedSubAccounts()

getManagedSubAccounts(params: ManagedSubAccountListParams): Promise<{
  managerSubUserInfoVoList: ManagerSubUserInfoVo[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountListParams`

Returns

Promise<{ managerSubUserInfoVoList: ManagerSubUserInfoVo[]; total: number; }>

getManagedSubAccountSnapshot()

getManagedSubAccountSnapshot(params: ManagedSubAccountSnapshotParams): Promise<ManagedSubAccountSnapshot>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountSnapshotParams`

Returns

Promise<ManagedSubAccountSnapshot>

getManagedSubAccountTransferLog()

getManagedSubAccountTransferLog(params: ManagedSubAccountTransferTTLogParams): Promise<{
  count: number;
  managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[];
}>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountTransferTTLogParams`

Returns

Promise<{ count: number; managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[]; }>

getManagedSubAccountTransfersInvestor()

getManagedSubAccountTransfersInvestor(params: ManagedSubAccountTransferLogParams): Promise<{
  count: number;
  managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[];
}>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountTransferLogParams`

Returns

Promise<{ count: number; managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[]; }>

getManagedSubAccountTransfersParent()

getManagedSubAccountTransfersParent(params: ManagedSubAccountTransferLogParams): Promise<{
  count: number;
  managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[];
}>;

Parameters

Parameter	Type
`params`	`ManagedSubAccountTransferLogParams`

Returns

Promise<{ count: number; managerSubTransferHistoryVos: ManagerSubTransferHistoryVos[]; }>

getMarginAccountBorrowRepayRecords()

getMarginAccountBorrowRepayRecords(params: GetMarginAccountBorrowRepayRecordsParams): Promise<{
  rows: MarginAccountRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetMarginAccountBorrowRepayRecordsParams`

Returns

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

getMarginAvailableInventory()

getMarginAvailableInventory(params: object): Promise<MarginAvailableInventoryResponse>;

Parameters

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

Returns

Promise<MarginAvailableInventoryResponse>

getMarginCapitalFlow()

getMarginCapitalFlow(params: GetMarginCapitalFlowParams): Promise<MarginCapitalFlow[]>;

Possibly

Parameters

Parameter	Type
`params`	`GetMarginCapitalFlowParams`

Returns

Promise<MarginCapitalFlow[]>

Deprecated

Only existing in old documentation, not in new documentation

getMarginDelistSchedule()

getMarginDelistSchedule(): Promise<MarginDelistSchedule[]>;

Returns

Promise<MarginDelistSchedule[]>

getMarginForceLiquidationRecord()

getMarginForceLiquidationRecord(params: GetForceLiquidationRecordParams): Promise<{
  rows: ForceLiquidationRecord[];
  total: number;
}>;

MARGIN TRADING Endpoints - Trade endpoints

Parameters

Parameter	Type
`params`	`GetForceLiquidationRecordParams`

Returns

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

getMarginInterestHistory()

getMarginInterestHistory(params: GetMarginInterestHistoryParams): Promise<{
  rows: MarginInterestHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetMarginInterestHistoryParams`

Returns

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

getMarginInterestRateHistory()

getMarginInterestRateHistory(params: QueryMarginInterestRateHistoryParams): Promise<MarginInterestRateHistory[]>;

Parameters

Parameter	Type
`params`	`QueryMarginInterestRateHistoryParams`

Returns

Promise<MarginInterestRateHistory[]>

getMarginInterestRebateBalance()

getMarginInterestRebateBalance(): Promise<MarginInterestRebateBalanceResponse>;

Returns

Promise<MarginInterestRebateBalanceResponse>

getMarginInterestRebateBalanceRecords()

getMarginInterestRebateBalanceRecords(params?: GetMarginInterestRebateBalanceRecordsParams): Promise<MarginInterestRebateBalanceRecordsResponse>;

Parameters

Parameter	Type
`params?`	`GetMarginInterestRebateBalanceRecordsParams`

Returns

Promise<MarginInterestRebateBalanceRecordsResponse>

getMarginLiquidationLoan()

getMarginLiquidationLoan(): Promise<MarginLiquidationLoan>;

Query the current cross-margin liquidation loan status (bankruptcy deficit).

Returns

Promise<MarginLiquidationLoan>

getMarginLiquidationLoanRepayHistory()

getMarginLiquidationLoanRepayHistory(params?: GetMarginLiquidationLoanRepayHistoryParams): Promise<MarginLiquidationLoanRepayHistoryResponse>;

Query cross-margin liquidation loan repayment history.

Parameters

Parameter	Type
`params?`	`GetMarginLiquidationLoanRepayHistoryParams`

Returns

Promise<MarginLiquidationLoanRepayHistoryResponse>

getMarginListenToken()

getMarginListenToken(params?: object): Promise<{
  expirationTime: number;
  token: string;
}>;

Get/create margin account listenToken for the user data stream https://developers.binance.com/docs/margin_trading/trade-data-stream

Parameters

Parameter	Type
`params?`	{ `isIsolated?`: `boolean`; `symbol?`: `string`; `validity?`: `number`; }
`params.isIsolated?`	`boolean`
`params.symbol?`	`string`
`params.validity?`	`number`

Returns

Promise<{ expirationTime: number; token: string; }>

getMarginOrderCountUsage()

getMarginOrderCountUsage(params: GetMarginOrderCountUsageParams): Promise<MarginOrderCountUsageResponse[]>;

Parameters

Parameter	Type
`params`	`GetMarginOrderCountUsageParams`

Returns

Promise<MarginOrderCountUsageResponse[]>

getMarginRiskUserDataListenKey()

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

Get a cross margin risk data listen key

Returns

Promise<{ listenKey: string; }>

getMarginSpecialLowLatencyKey()

getMarginSpecialLowLatencyKey(params: object): Promise<SpecialLowLatencyKeyInfo>;

Query information for a specific special key used in low-latency trading

Parameters

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

Returns

Promise<SpecialLowLatencyKeyInfo>

getMarginSpecialLowLatencyKeys()

getMarginSpecialLowLatencyKeys(params: object): Promise<SpecialLowLatencyKeyInfo[]>;

Query the list of special keys for low-latency trading

Parameters

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

Returns

Promise<SpecialLowLatencyKeyInfo[]>

getMarginSummary()

getMarginSummary(): Promise<any>;

Returns

Promise<any>

getMarginUserDataListenKey()

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

Get a cross margin user data listen key

Returns

Promise<{ listenKey: string; }>

getMarginUserDataListenKeyV2()

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

Start a Margin user data stream (POST /sapi/v2/margin/listen-key). Weight(IP): 1. USER_STREAM.

New and migrated accounts receive -3086 from POST /sapi/v1/margin/listen-key and POST /sapi/v1/userListenToken. Connect with wss://fstream.binance.com/private/ws/<listenKey>.

Returns

Promise<{ listenKey: string; }>

getMarginUtaUserDataListenKey()

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

Returns

Promise<{ listenKey: string; }>

getMinerDetails()

getMinerDetails(params: GetMinerDetailsParams): Promise<GetMinerDetailsResponse[]>;

Parameters

Parameter	Type
`params`	`GetMinerDetailsParams`

Returns

Promise<GetMinerDetailsResponse[]>

getMiners()

getMiners(params: GetMinerListParams): Promise<GetMinerListResponse>;

Parameters

Parameter	Type
`params`	`GetMinerListParams`

Returns

Promise<GetMinerListResponse>

getMiningAccountEarnings()

getMiningAccountEarnings(params: GetMiningAccountEarningParams): Promise<GetMiningAccountEarningResponse>;

Parameters

Parameter	Type
`params`	`GetMiningAccountEarningParams`

Returns

Promise<GetMiningAccountEarningResponse>

getMiningAccounts()

getMiningAccounts(params: getMiningAccountsListParams): Promise<getMiningAccountsListResponse>;

Parameters

Parameter	Type
`params`	`getMiningAccountsListParams`

Returns

Promise<getMiningAccountsListResponse>

getMiningAlgos()

getMiningAlgos(): Promise<GetMiningAlgoListResponse[]>;

MINING Endpoints - rest api

Returns

Promise<GetMiningAlgoListResponse[]>

getMiningCoins()

getMiningCoins(): Promise<GetMiningCoinListResponse[]>;

Returns

Promise<GetMiningCoinListResponse[]>

getMiningEarnings()

getMiningEarnings(params: GetEarningsListParams): Promise<GetEarningsListResponse>;

Parameters

Parameter	Type
`params`	`GetEarningsListParams`

Returns

Promise<GetEarningsListResponse>

getMiningStatistics()

getMiningStatistics(params: GetStatisticListParams): Promise<GetStatisticListResponse>;

Parameters

Parameter	Type
`params`	`GetStatisticListParams`

Returns

Promise<GetStatisticListResponse>

getNextHourlyInterestRate()

getNextHourlyInterestRate(params: GetNextHourlyInterestRateParams): Promise<NextHourlyInterestRate[]>;

MARGIN TRADING Endpoints - Borrow and Repay endpoints

Parameters

Parameter	Type
`params`	`GetNextHourlyInterestRateParams`

Returns

Promise<NextHourlyInterestRate[]>

getNftAsset()

getNftAsset(params: GetNftAssetParams): Promise<{
  list: NftAsset[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetNftAssetParams`

Returns

Promise<{ list: NftAsset[]; total: number; }>

getNftDepositHistory()

getNftDepositHistory(params: GetNftDepositHistoryParams): Promise<{
  list: NftDeposit[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetNftDepositHistoryParams`

Returns

Promise<{ list: NftDeposit[]; total: number; }>

getNftTransactionHistory()

getNftTransactionHistory(params: GetNftTransactionHistoryParams): Promise<{
  list: NftTransaction[];
  total: number;
}>;

NFT Endpoints - REST api

Parameters

Parameter	Type
`params`	`GetNftTransactionHistoryParams`

Returns

Promise<{ list: NftTransaction[]; total: number; }>

getNftWithdrawHistory()

getNftWithdrawHistory(params: GetNftWithdrawHistoryParams): Promise<{
  list: NftWithdraw[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetNftWithdrawHistoryParams`

Returns

Promise<{ list: NftWithdraw[]; total: number; }>

getOCO()

getOCO(params?: GetOCOParams): Promise<OrderList>;

Parameters

Parameter	Type
`params?`	`GetOCOParams`

Returns

Promise<OrderList>

getOnboardedVASPList()

getOnboardedVASPList(): Promise<VASPInfo[]>;

Fetch the onboarded VASP list for local entities that require travel rule. Use the identifier field (not vaspCode) for the vasp param in deposit/withdrawal questionnaires. Both vaspCode and identifier accepted until 28 May 2026.

Returns

Promise<VASPInfo[]>

getOnchainYieldsAccount()

getOnchainYieldsAccount(): Promise<OnchainYieldsAccountResponse>;

Returns

Promise<OnchainYieldsAccountResponse>

getOnchainYieldsLockedPersonalLeftQuota()

getOnchainYieldsLockedPersonalLeftQuota(params: OnchainYieldsLockedPersonalLeftQuotaParams): Promise<OnchainYieldsLockedPersonalLeftQuotaResponse>;

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedPersonalLeftQuotaParams`

Returns

Promise<OnchainYieldsLockedPersonalLeftQuotaResponse>

getOnchainYieldsLockedPosition()

getOnchainYieldsLockedPosition(params?: OnchainYieldsLockedPositionParams): Promise<OnchainYieldsLockedPositionResponse>;

Parameters

Parameter	Type
`params?`	`OnchainYieldsLockedPositionParams`

Returns

Promise<OnchainYieldsLockedPositionResponse>

getOnchainYieldsLockedProducts()

getOnchainYieldsLockedProducts(params?: OnchainYieldsLockedProductListParams): Promise<OnchainYieldsLockedProductListResponse>;

STAKING - Onchain Yields - Account

Parameters

Parameter	Type
`params?`	`OnchainYieldsLockedProductListParams`

Returns

Promise<OnchainYieldsLockedProductListResponse>

getOnchainYieldsLockedRedemptionRecord()

getOnchainYieldsLockedRedemptionRecord(params?: OnchainYieldsLockedRedemptionRecordParams): Promise<OnchainYieldsLockedRedemptionRecordResponse>;

Parameters

Parameter	Type
`params?`	`OnchainYieldsLockedRedemptionRecordParams`

Returns

Promise<OnchainYieldsLockedRedemptionRecordResponse>

getOnchainYieldsLockedRewardsHistory()

getOnchainYieldsLockedRewardsHistory(params?: OnchainYieldsLockedRewardsHistoryParams): Promise<OnchainYieldsLockedRewardsHistoryResponse>;

Parameters

Parameter	Type
`params?`	`OnchainYieldsLockedRewardsHistoryParams`

Returns

Promise<OnchainYieldsLockedRewardsHistoryResponse>

getOnchainYieldsLockedSubscriptionPreview()

getOnchainYieldsLockedSubscriptionPreview(params: OnchainYieldsLockedSubscriptionPreviewParams): Promise<OnchainYieldsLockedSubscriptionPreviewResponse>;

STAKING - Onchain Yields - Earn

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedSubscriptionPreviewParams`

Returns

Promise<OnchainYieldsLockedSubscriptionPreviewResponse>

getOnchainYieldsLockedSubscriptionRecord()

getOnchainYieldsLockedSubscriptionRecord(params?: OnchainYieldsLockedSubscriptionRecordParams): Promise<OnchainYieldsLockedSubscriptionRecordResponse>;

STAKING - Onchain Yields - History

Parameters

Parameter	Type
`params?`	`OnchainYieldsLockedSubscriptionRecordParams`

Returns

Promise<OnchainYieldsLockedSubscriptionRecordResponse>

getOneTimeTransactionStatus()

getOneTimeTransactionStatus(params: GetOneTimeTransactionStatusParams): Promise<GetOneTimeTransactionStatusResponse>;

Parameters

Parameter	Type
`params`	`GetOneTimeTransactionStatusParams`

Returns

Promise<GetOneTimeTransactionStatusResponse>

getOpenOrders()

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

Parameters

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

Returns

Promise<SpotOrder[]>

getOrder()

getOrder(params: GetOrderParams): Promise<SpotOrder>;

Parameters

Parameter	Type
`params`	`GetOrderParams`

Returns

Promise<SpotOrder>

getOrderBook()

getOrderBook(params: OrderBookParams): Promise<OrderBookResponse>;

SPOT TRADING Endpoints - Market endpoints

Parameters

Parameter	Type
`params`	`OrderBookParams`

Returns

Promise<OrderBookResponse>

Example

import { MainClient } from 'binance';

async function main() {
  const client = new MainClient();
  const book = await client.getOrderBook({ symbol: 'BTCUSDT', limit: 5 });
  console.log('Best bid [price, quantity]:', book.bids[0]);
  console.log('Best ask [price, quantity]:', book.asks[0]);
}
main().catch((error) => {
  console.error(error instanceof Error ? error.message : 'Request failed. See the troubleshooting guide.');
  process.exitCode = 1;
});

See

Read an order book

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

getOrderRateLimit()

getOrderRateLimit(): Promise<OrderRateLimitUsage[]>;

Returns

Promise<OrderRateLimitUsage[]>

getOrderStatus()

getOrderStatus(params: GetOrderStatusParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetOrderStatusParams`

Returns

Promise<any>

getPayTransactions()

getPayTransactions(params: GetPayTradeHistoryParams): Promise<any>;

Pay endpoints Found only in old docs, possibly

Parameters

Parameter	Type
`params`	`GetPayTradeHistoryParams`

Returns

Promise<any>

Deprecated

getPersonalLeftQuotaOfStakingProduct()

getPersonalLeftQuotaOfStakingProduct(params: object): Promise<StakingPersonalLeftQuota>;

Parameters

Parameter	Type
`params`	{ `product`: `StakingProductType`; `productId`: `string`; }
`params.product`	`StakingProductType`
`params.productId`	`string`

Returns

Promise<StakingPersonalLeftQuota>

Deprecated

as of 2024-01-19

getPortfolioDeltaMode()

getPortfolioDeltaMode(): Promise<PortfolioDeltaModeStatus>;

Returns

Promise<PortfolioDeltaModeStatus>

getPortfolioMarginAssetLeverage()

getPortfolioMarginAssetLeverage(): Promise<GetPortfolioMarginAssetLeverageResponse[]>;

Returns

Promise<GetPortfolioMarginAssetLeverageResponse[]>

getPortfolioMarginBankruptcyLoanRepayHistory()

getPortfolioMarginBankruptcyLoanRepayHistory(params?: object): Promise<{
  rows: PMProBankruptcyLoanRepaymentHistory[];
  total: number;
}>;

Parameters

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

Returns

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

getPortfolioMarginIndexPrice()

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

DERIVATIVES - Portfolio Margin Pro - Market Data This is in mainclient because it shares the same base url

Parameters

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

Returns

Promise<GetPortfolioMarginAssetIndexPriceResponse[]>

getPortfolioMarginMarginCallLevel()

getPortfolioMarginMarginCallLevel(): Promise<PortfolioMarginMarginCallLevelGetResponse>;

Returns

Promise<PortfolioMarginMarginCallLevelGetResponse>

getPortfolioMarginProAccountBalance()

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

Parameters

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

Returns

Promise<PortfolioMarginProAccountBalance[]>

getPortfolioMarginProAccountInfo()

getPortfolioMarginProAccountInfo(): Promise<GetPortfolioMarginProAccountInfoResponse>;

DERIVATIVES - Portfolio Margin Pro - Account This is in mainclient because it shares the same base url

Returns

Promise<GetPortfolioMarginProAccountInfoResponse>

getPortfolioMarginProBankruptcyLoanAmount()

getPortfolioMarginProBankruptcyLoanAmount(): Promise<GetPortfolioMarginProBankruptcyLoanAmountResponse>;

Returns

Promise<GetPortfolioMarginProBankruptcyLoanAmountResponse>

getPortfolioMarginProCollateralRate()

getPortfolioMarginProCollateralRate(): Promise<GetPortfolioMarginProCollateralRateResponse[]>;

Returns

Promise<GetPortfolioMarginProCollateralRateResponse[]>

getPortfolioMarginProInterestHistory()

getPortfolioMarginProInterestHistory(params: GetPortfolioMarginProInterestHistoryParams): Promise<GetPortfolioMarginProInterestHistoryResponse[]>;

Parameters

Parameter	Type
`params`	`GetPortfolioMarginProInterestHistoryParams`

Returns

Promise<GetPortfolioMarginProInterestHistoryResponse[]>

getPortfolioMarginProSpanAccountInfo()

getPortfolioMarginProSpanAccountInfo(): Promise<PortfolioMarginProSpanAccountInfo>;

Returns

Promise<PortfolioMarginProSpanAccountInfo>

getPortfolioMarginProTieredCollateralRate()

getPortfolioMarginProTieredCollateralRate(): Promise<any[]>;

Returns

Promise<any[]>

getPreventedMatches()

getPreventedMatches(params: PreventedMatchesParams): Promise<PreventedMatch[]>;

Parameters

Parameter	Type
`params`	`PreventedMatchesParams`

Returns

Promise<PreventedMatch[]>

getPrivate()

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

Parameters

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

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getPrivate

getPurchaseRecord()

getPurchaseRecord(params: PurchaseRecordParams): Promise<any[]>;

Parameters

Parameter	Type
`params`	`PurchaseRecordParams`

Returns

Promise<any[]>

Deprecated

as of 2023-06-22, now Simple Earn

getRateHistory()

getRateHistory(params: GetRateHistoryParams): Promise<{
  rows: GetRateHistory[];
  total: string;
}>;

Parameters

Parameter	Type
`params`	`GetRateHistoryParams`

Returns

Promise<{ rows: GetRateHistory[]; total: string; }>

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

getRecentTrades()

getRecentTrades(params: RecentTradesParams): Promise<RawTrade[]>;

Parameters

Parameter	Type
`params`	`RecentTradesParams`

Returns

Promise<RawTrade[]>

getRedemptionRecord()

getRedemptionRecord(params: PurchaseRecordParams): Promise<any[]>;

Parameters

Parameter	Type
`params`	`PurchaseRecordParams`

Returns

Promise<any[]>

Deprecated

as of 2023-06-22, now Simple Earn

getReferencePrice()

getReferencePrice(params: object): Promise<SpotReferencePriceResult>;

Parameters

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

Returns

Promise<SpotReferencePriceResult>

getReferencePriceCalculation()

getReferencePriceCalculation(params: object): Promise<SpotReferencePriceCalculationResponse>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; `symbolStatus?`: `"TRADING"` \| `"HALT"` \| `"BREAK"`; }
`params.symbol`	`string`
`params.symbolStatus?`	`"TRADING"` \| `"HALT"` \| `"BREAK"`

Returns

Promise<SpotReferencePriceCalculationResponse>

getRollingWindowTicker()

getRollingWindowTicker(params: RollingWindowTickerParams): Promise<
  | TradingDayTickerFull[]
| TradingDayTickerMini[]>;

Parameters

Parameter	Type
`params`	`RollingWindowTickerParams`

Returns

Promise< | TradingDayTickerFull[] | TradingDayTickerMini[]>

getRsaPublicKey()

getRsaPublicKey(): Promise<any>;

Returns

Promise<any>

getRwusdAccount()

getRwusdAccount(): Promise<RwusdAccountResponse>;

RWUSD (sapi/v1/rwusd)

Returns

Promise<RwusdAccountResponse>

getRwusdQuota()

getRwusdQuota(): Promise<RwusdQuotaResponse>;

Returns

Promise<RwusdQuotaResponse>

getRwusdRateHistory()

getRwusdRateHistory(params: GetRwusdRateHistoryParams): Promise<{
  rows: RwusdRateHistoryRow[];
  total: string;
}>;

Parameters

Parameter	Type
`params`	`GetRwusdRateHistoryParams`

Returns

Promise<{ rows: RwusdRateHistoryRow[]; total: string; }>

getRwusdRedemptionHistory()

getRwusdRedemptionHistory(params: GetRwusdRedemptionHistoryParams): Promise<{
  rows: RwusdRedemptionHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetRwusdRedemptionHistoryParams`

Returns

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

getRwusdRewardsHistory()

getRwusdRewardsHistory(params: GetRwusdRewardsHistoryParams): Promise<{
  rows: RwusdRewardsHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetRwusdRewardsHistoryParams`

Returns

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

getRwusdSubscriptionHistory()

getRwusdSubscriptionHistory(params: GetRwusdSubscriptionHistoryParams): Promise<{
  rows: RwusdSubscriptionHistoryRow[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetRwusdSubscriptionHistoryParams`

Returns

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

getServerTime()

getServerTime(baseUrlKeyOverride?: BinanceBaseUrlKey): Promise<number>;

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

Parameters

Parameter	Type
`baseUrlKeyOverride?`	`BinanceBaseUrlKey`

Returns

Promise<number>

Overrides

BaseRestClient.getServerTime

getSimpleEarnAccount()

getSimpleEarnAccount(): Promise<SimpleEarnAccountResponse>;

SIMPLE EARN Endpoints - Account

Returns

Promise<SimpleEarnAccountResponse>

getSimpleEarnLockedProductList()

getSimpleEarnLockedProductList(params?: SimpleEarnProductListParams): Promise<{
  rows: SimpleEarnLockedProduct[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`SimpleEarnProductListParams`

Returns

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

getSmallLiabilityExchangeCoins()

getSmallLiabilityExchangeCoins(): Promise<SmallLiabilityExchangeCoin[]>;

Returns

Promise<SmallLiabilityExchangeCoin[]>

getSmallLiabilityExchangeHistory()

getSmallLiabilityExchangeHistory(params: GetSmallLiabilityExchangeHistoryParams): Promise<{
  rows: SmallLiabilityExchangeHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetSmallLiabilityExchangeHistoryParams`

Returns

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

getSoftStakingProductList()

getSoftStakingProductList(params?: GetSoftStakingProductListParams): Promise<GetSoftStakingProductListResponse>;

STAKING - Soft staking

Parameters

Parameter	Type
`params?`	`GetSoftStakingProductListParams`

Returns

Promise<GetSoftStakingProductListResponse>

getSoftStakingRewardsHistory()

getSoftStakingRewardsHistory(params?: GetSoftStakingRewardsHistoryParams): Promise<GetSoftStakingRewardsHistoryResponse>;

Parameters

Parameter	Type
`params?`	`GetSoftStakingRewardsHistoryParams`

Returns

Promise<GetSoftStakingRewardsHistoryResponse>

getSolBoostRewardsHistory()

getSolBoostRewardsHistory(params?: SolBoostRewardsHistoryReq): Promise<{
  rows: SolBoostRewardsHistoryRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`SolBoostRewardsHistoryReq`

Returns

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

getSolRedemptionHistory()

getSolRedemptionHistory(params?: object): Promise<SolRedemptionHistoryRecord>;

Parameters

Parameter	Type
`params?`	{ `rows`: `SolRedemptionHistoryRecord`[]; `total`: `number`; }
`params.rows`	`SolRedemptionHistoryRecord`[]
`params.total`	`number`

Returns

Promise<SolRedemptionHistoryRecord>

getSolStakingAccount()

getSolStakingAccount(): Promise<SolStakingAccount>;

STAKING Endpoints - SOL Staking- Account

Returns

Promise<SolStakingAccount>

getSolStakingHistory()

getSolStakingHistory(params?: GetSolStakingHistoryReq): Promise<{
  rows: SolStakingHistoryRecord[];
  total: number;
}>;

STAKING Endpoints - SOL Staking- History

Parameters

Parameter	Type
`params?`	`GetSolStakingHistoryReq`

Returns

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

getSolStakingQuota()

getSolStakingQuota(): Promise<SolStakingQuota>;

Returns

Promise<SolStakingQuota>

getSolUnclaimedRewards()

getSolUnclaimedRewards(): Promise<object[]>;

Returns

Promise<object[]>

getSpotAlgoHistoricalOrders()

getSpotAlgoHistoricalOrders(params: GetSpotAlgoHistoricalOrdersParams): Promise<{
  orders: HistoricalSpotAlgoOrder[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetSpotAlgoHistoricalOrdersParams`

Returns

Promise<{ orders: HistoricalSpotAlgoOrder[]; total: number; }>

getSpotAlgoOpenOrders()

getSpotAlgoOpenOrders(): Promise<{
  orders: SpotAlgoOrder[];
  total: number;
}>;

Returns

Promise<{ orders: SpotAlgoOrder[]; total: number; }>

getSpotAlgoSubOrders()

getSpotAlgoSubOrders(params: GetSpotAlgoSubOrdersParams): Promise<GetSpotAlgoSubOrdersResponse>;

Parameters

Parameter	Type
`params`	`GetSpotAlgoSubOrdersParams`

Returns

Promise<GetSpotAlgoSubOrdersResponse>

getSpotAssetTags()

getSpotAssetTags(params?: SpotAssetTagsParams): Promise<SpotAssetTag[]>;

Parameters

Parameter	Type
`params?`	`SpotAssetTagsParams`

Returns

Promise<SpotAssetTag[]>

getSpotRebateHistoryRecords()

getSpotRebateHistoryRecords(params: GetSpotRebateHistoryRecordsParams): Promise<GetSpotRebateHistoryRecordsResponse>;

Rebate Endpoints

Parameters

Parameter	Type
`params`	`GetSpotRebateHistoryRecordsParams`

Returns

Promise<GetSpotRebateHistoryRecordsResponse>

getSpotUserDataListenKey()

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

User Data Stream Endpoints

Returns

Promise<{ listenKey: string; }>

getStakingHistory()

getStakingHistory(params: StakingHistoryParams): Promise<StakingHistory[]>;

Parameters

Parameter	Type
`params`	`StakingHistoryParams`

Returns

Promise<StakingHistory[]>

Deprecated

as of 2024-01-19

getStakingProductPosition()

getStakingProductPosition(params: StakingBasicParams & object): Promise<StakingProductPosition[]>;

Parameters

Parameter	Type
`params`	`StakingBasicParams` & `object`

Returns

Promise<StakingProductPosition[]>

Deprecated

as of 2024-01-19

getStakingProducts()

getStakingProducts(params: StakingBasicParams & object): Promise<StakingProduct[]>;

Parameters

Parameter	Type
`params`	`StakingBasicParams` & `object`

Returns

Promise<StakingProduct[]>

Deprecated

as of 2024-01-19

getSubAccountAssets()

getSubAccountAssets(params: SubAccountAssetsParams): Promise<SubAccountAssets>;

Parameters

Parameter	Type
`params`	`SubAccountAssetsParams`

Returns

Promise<SubAccountAssets>

getSubAccountAssetsMaster()

getSubAccountAssetsMaster(params: object): Promise<{
  balances: SubaccountBalances[];
}>;

Parameters

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

Returns

Promise<{ balances: SubaccountBalances[]; }>

getSubAccountBNBBurnStatus()

getSubAccountBNBBurnStatus(params: object): Promise<{
  interestBNBBurn: boolean;
  spotBNBBurn: boolean;
  subAccountId: string;
}>;

Parameters

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

Returns

Promise<{ interestBNBBurn: boolean; spotBNBBurn: boolean; subAccountId: string; }>

getSubAccountBrokerIpRestriction()

getSubAccountBrokerIpRestriction(params: object): Promise<{
  apikey: string;
  ipList: string[];
  ipRestrict: boolean;
  subaccountId: string;
  updateTime: number;
}>;

Parameters

Parameter	Type
`params`	{ `subAccountApiKey`: `string`; `subAccountId`: `string`; }
`params.subAccountApiKey`	`string`
`params.subAccountId`	`string`

Returns

Promise<{ apikey: string; ipList: string[]; ipRestrict: boolean; subaccountId: string; updateTime: number; }>

getSubAccountDepositAddress()

getSubAccountDepositAddress(params: SubAccountDepositAddressParams): Promise<SubAccountDepositAddress>;

Parameters

Parameter	Type
`params`	`SubAccountDepositAddressParams`

Returns

Promise<SubAccountDepositAddress>

getSubAccountDepositHistory()

getSubAccountDepositHistory(params: SubAccountDepositHistoryParams): Promise<DepositHistory[]>;

Parameters

Parameter	Type
`params`	`SubAccountDepositHistoryParams`

Returns

Promise<DepositHistory[]>

getSubAccountDetailOnFuturesAccountV2()

getSubAccountDetailOnFuturesAccountV2(params: BasicFuturesSubAccountParams): Promise<
  | SubAccountUSDMDetail
| SubAccountCOINMDetail>;

Parameters

Parameter	Type
`params`	`BasicFuturesSubAccountParams`

Returns

Promise< | SubAccountUSDMDetail | SubAccountCOINMDetail>

getSubAccountDetailOnMarginAccount()

getSubAccountDetailOnMarginAccount(email: string): Promise<SubAccountMarginAccountDetail>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<SubAccountMarginAccountDetail>

getSubAccountFuturesAccountDetail()

getSubAccountFuturesAccountDetail(email: string): Promise<SubAccountFuturesAccountDetail>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<SubAccountFuturesAccountDetail>

getSubAccountFuturesAccountSummary()

getSubAccountFuturesAccountSummary(): Promise<SubAccountFuturesAccountSummary>;

Returns

Promise<SubAccountFuturesAccountSummary>

getSubAccountFuturesAssetTransferHistory()

getSubAccountFuturesAssetTransferHistory(params: SubAccountFuturesAssetTransferHistoryParams): Promise<SubAccountFuturesAssetTransferHistory>;

Parameters

Parameter	Type
`params`	`SubAccountFuturesAssetTransferHistoryParams`

Returns

Promise<SubAccountFuturesAssetTransferHistory>

getSubAccountFuturesPositionMoveHistory()

getSubAccountFuturesPositionMoveHistory(params: SubAccountMovePositionHistoryParams): Promise<{
  futureMovePositionOrderVoList: SubAccountMovePositionHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`SubAccountMovePositionHistoryParams`

Returns

Promise<{ futureMovePositionOrderVoList: SubAccountMovePositionHistory[]; total: number; }>

getSubAccountFuturesPositionRisk()

getSubAccountFuturesPositionRisk(email: string): Promise<FuturesPositionRisk[]>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<FuturesPositionRisk[]>

getSubAccountFuturesPositionRiskV2()

getSubAccountFuturesPositionRiskV2(params: BasicFuturesSubAccountParams): Promise<
  | SubAccountUSDMPositionRisk
| SubAccountCOINMPositionRisk>;

Parameters

Parameter	Type
`params`	`BasicFuturesSubAccountParams`

Returns

Promise< | SubAccountUSDMPositionRisk | SubAccountCOINMPositionRisk>

getSubAccountFuturesTransferHistory()

getSubAccountFuturesTransferHistory(params: object): Promise<any>;

Parameters

Parameter	Type
`params`	{ `clientTranId?`: `string`; `endTime?`: `number`; `futuresType`: `number`; `limit?`: `number`; `page?`: `number`; `startTime?`: `number`; `subAccountId`: `string`; }
`params.clientTranId?`	`string`
`params.endTime?`	`number`
`params.futuresType`	`number`
`params.limit?`	`number`
`params.page?`	`number`
`params.startTime?`	`number`
`params.subAccountId`	`string`

Returns

Promise<any>

getSubAccountIPRestriction()

getSubAccountIPRestriction(params: BasicSubAccount): Promise<SubAccountEnableOrDisableIPRestriction>;

SUB ACCOUNT Endpoints - API management

Parameters

Parameter	Type
`params`	`BasicSubAccount`

Returns

Promise<SubAccountEnableOrDisableIPRestriction>

getSubAccountList()

getSubAccountList(params?: SubAccountListParams): Promise<SubAccountListResponse>;

Parameters

Parameter	Type
`params?`	`SubAccountListParams`

Returns

Promise<SubAccountListResponse>

getSubAccountMarginAssetInfo()

getSubAccountMarginAssetInfo(params: QuerySubAccountSpotMarginAssetInfoParams): Promise<{
  data: SubAccountBrokerMarginAsset[];
  timestamp: number;
}>;

Parameters

Parameter	Type
`params`	`QuerySubAccountSpotMarginAssetInfoParams`

Returns

Promise<{ data: SubAccountBrokerMarginAsset[]; timestamp: number; }>

getSubAccountSpotAssetsSummary()

getSubAccountSpotAssetsSummary(params?: SubAccountSpotAssetsSummaryParams): Promise<SubAccountSpotAssetsSummary>;

Parameters

Parameter	Type
`params?`	`SubAccountSpotAssetsSummaryParams`

Returns

Promise<SubAccountSpotAssetsSummary>

getSubAccountSpotAssetTransferHistory()

getSubAccountSpotAssetTransferHistory(params?: SubAccountSpotAssetTransferHistoryParams): Promise<SubAccountSpotAssetTransferHistory>;

Parameters

Parameter	Type
`params?`	`SubAccountSpotAssetTransferHistoryParams`

Returns

Promise<SubAccountSpotAssetTransferHistory>

getSubAccountsSummaryOfMarginAccount()

getSubAccountsSummaryOfMarginAccount(): Promise<SubAccountsMarginAccountSummary>;

Returns

Promise<SubAccountsMarginAccountSummary>

getSubAccountStatusOnMarginOrFutures()

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

Parameters

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

Returns

Promise<SubAccountStatus[]>

getSubAccountSummaryOnFuturesAccountV2()

getSubAccountSummaryOnFuturesAccountV2(params: SubAccountSummaryOnFuturesAccountV2Params): Promise<
  | SubAccountUSDMSummary
| SubAccountCOINMSummary>;

Parameters

Parameter	Type
`params`	`SubAccountSummaryOnFuturesAccountV2Params`

Returns

Promise< | SubAccountUSDMSummary | SubAccountCOINMSummary>

getSubAccountTransactionStatistics()

getSubAccountTransactionStatistics(params: object): Promise<SubAccountTransactionStatistics>;

Parameters

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

Returns

Promise<SubAccountTransactionStatistics>

getSubAccountUniversalTransferHistory()

getSubAccountUniversalTransferHistory(params?: SubAccountUniversalTransferHistoryParams): Promise<SubAccountUniversalTransferHistoryResponse>;

Parameters

Parameter	Type
`params?`	`SubAccountUniversalTransferHistoryParams`

Returns

Promise<SubAccountUniversalTransferHistoryResponse>

getSymbolOrderBookTicker()

getSymbolOrderBookTicker(params?: object): Promise<
  | SymbolOrderBookTicker
| SymbolOrderBookTicker[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; `symbols?`: `string`[]; `symbolStatus?`: `string`; }
`params.symbol?`	`string`
`params.symbols?`	`string`[]
`params.symbolStatus?`	`string`

Returns

Promise< | SymbolOrderBookTicker | SymbolOrderBookTicker[]>

getSymbolPriceTicker()

getSymbolPriceTicker(params?: object): Promise<
  | SymbolPrice
| SymbolPrice[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; `symbols?`: `string`[]; `symbolStatus?`: `string`; }
`params.symbol?`	`string`
`params.symbols?`	`string`[]
`params.symbolStatus?`	`string`

Returns

Promise< | SymbolPrice | SymbolPrice[]>

Example

import { MainClient } from 'binance';

async function main() {
  const client = new MainClient();
  const result = await client.getSymbolPriceTicker({ symbol: 'BTCUSDT' });
  if (Array.isArray(result)) throw new Error('Expected a single-symbol ticker.');
  console.log('BTCUSDT last price:', result.price);
}
main().catch((error) => {
  console.error(error instanceof Error ? error.message : 'Request failed. See the troubleshooting guide.');
  process.exitCode = 1;
});

See

Quickstart

getSystemStatus()

getSystemStatus(): Promise<SystemStatusResponse>;

WALLET Endpoints - Other endpoints

Returns

Promise<SystemStatusResponse>

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

getTokenLimit()

getTokenLimit(params: object): Promise<any>;

Parameters

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

Returns

Promise<any>

getTradeFee()

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

Parameters

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

Returns

Promise<SymbolTradeFee[]>

getTradingDayTicker()

getTradingDayTicker(params: TradingDayTickerParams): Promise<
  | TradingDayTickerSingle
| TradingDayTickerArray[]>;

Parameters

Parameter	Type
`params`	`TradingDayTickerParams`

Returns

Promise< | TradingDayTickerSingle | TradingDayTickerArray[]>

getTransferableEarnAssetBalanceForPortfolioMargin()

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

Get transferable earn asset balance for all types of Portfolio Margin account

Parameters

Parameter	Type
`params`	{ `asset`: `string`; `transferType`: `"EARN_TO_FUTURE"` \| `"FUTURE_TO_EARN"`; }
`params.asset`	`string`
`params.transferType`	`"EARN_TO_FUTURE"` \| `"FUTURE_TO_EARN"`

Returns

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

getTravelRuleCountryList()

getTravelRuleCountryList(): Promise<TravelRuleCountryListResponse>;

Returns

Promise<TravelRuleCountryListResponse>

getTravelRuleDepositHistory()

getTravelRuleDepositHistory(params?: GetTravelRuleDepositHistoryParams): Promise<TravelRuleDepositHistoryRecord[]>;

Fetch deposit history for local entities that require travel rule

Parameters

Parameter	Type
`params?`	`GetTravelRuleDepositHistoryParams`

Returns

Promise<TravelRuleDepositHistoryRecord[]>

getTravelRuleRegionList()

getTravelRuleRegionList(params: GetTravelRuleRegionListParams): Promise<TravelRuleRegionListResponse>;

Parameters

Parameter	Type
`params`	`GetTravelRuleRegionListParams`

Returns

Promise<TravelRuleRegionListResponse>

getTravelRuleWithdrawHistory()

getTravelRuleWithdrawHistory(params?: GetTravelRuleWithdrawHistoryParams): Promise<TravelRuleWithdrawHistoryRecord[]>;

Fetch withdraw history for local entities that require travel rule

Parameters

Parameter	Type
`params?`	`GetTravelRuleWithdrawHistoryParams`

Returns

Promise<TravelRuleWithdrawHistoryRecord[]>

getTravelRuleWithdrawHistoryV2()

getTravelRuleWithdrawHistoryV2(params?: GetTravelRuleWithdrawHistoryV2Params): Promise<TravelRuleWithdrawHistoryRecord[]>;

Fetch withdraw history for local entities that require travel rule

Parameters

Parameter	Type
`params?`	`GetTravelRuleWithdrawHistoryV2Params`

Returns

Promise<TravelRuleWithdrawHistoryRecord[]>

getUIKlines()

getUIKlines(params: KlinesParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`KlinesParams`

Returns

Promise<Kline[]>

getUniversalTransferBroker()

getUniversalTransferBroker(params: GetUniversalTransferBrokerParams): Promise<BrokerUniversalTransfer[]>;

Parameters

Parameter	Type
`params`	`GetUniversalTransferBrokerParams`

Returns

Promise<BrokerUniversalTransfer[]>

getUniversalTransferHistory()

getUniversalTransferHistory(params: UniversalTransferHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`UniversalTransferHistoryParams`

Returns

Promise<any>

getUserAsset()

getUserAsset(params: GetAssetParams): Promise<UserAsset[]>;

Parameters

Parameter	Type
`params`	`GetAssetParams`

Returns

Promise<UserAsset[]>

getVipApplicationStatus()

getVipApplicationStatus(params: GetApplicationStatusParams): Promise<{
  rows: ApplicationStatus[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetApplicationStatusParams`

Returns

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

getVipBorrowInterestRate()

getVipBorrowInterestRate(params: object): Promise<BorrowInterestRate[]>;

VIP LOAN Endpoints - Market Data

Parameters

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

Returns

Promise<BorrowInterestRate[]>

getVipCollateralAssets()

getVipCollateralAssets(params: object): Promise<{
  rows: CollateralAssetData[];
  total: number;
}>;

Parameters

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

Returns

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

getVipLoanableAssets()

getVipLoanableAssets(params: GetLoanableAssetsDataParams): Promise<{
  rows: LoanableAssetData[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetLoanableAssetsDataParams`

Returns

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

getVipLoanAccruedInterest()

getVipLoanAccruedInterest(params?: VipLoanAccruedInterestParams): Promise<{
  rows: VipLoanAccruedInterestRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params?`	`VipLoanAccruedInterestParams`

Returns

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

getVipLoanFixedRateMarket()

getVipLoanFixedRateMarket(params: GetVipLoanFixedRateMarketParams): Promise<{
  rows: VipLoanFixedRateMarketRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetVipLoanFixedRateMarketParams`

Returns

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

getVipLoanInterestRateHistory()

getVipLoanInterestRateHistory(params: VipLoanInterestRateHistoryParams): Promise<{
  rows: VipLoanInterestRateRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`VipLoanInterestRateHistoryParams`

Returns

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

getVipLoanOpenOrders()

getVipLoanOpenOrders(params: GetVipLoanOngoingOrdersParams): Promise<{
  rows: VipOngoingOrder[];
  total: number;
}>;

VIP LOAN Endpoints - User Info

Parameters

Parameter	Type
`params`	`GetVipLoanOngoingOrdersParams`

Returns

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

getVipLoanRepaymentHistory()

getVipLoanRepaymentHistory(params: GetVipLoanRepaymentHistoryParams): Promise<{
  rows: VipLoanRepaymentHistory[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`GetVipLoanRepaymentHistoryParams`

Returns

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

getWalletBalances()

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

Parameters

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

Returns

Promise<WalletBalance[]>

getWbethRewardsHistory()

getWbethRewardsHistory(params: GetWrapHistoryParams): Promise<GetWbethRewardsHistoryResponse>;

Parameters

Parameter	Type
`params`	`GetWrapHistoryParams`

Returns

Promise<GetWbethRewardsHistoryResponse>

getWithdrawAddresses()

getWithdrawAddresses(): Promise<WithdrawAddress[]>;

Returns

Promise<WithdrawAddress[]>

getWithdrawHistory()

getWithdrawHistory(params?: WithdrawHistoryParams): Promise<WithdrawHistory[]>;

Parameters

Parameter	Type
`params?`	`WithdrawHistoryParams`

Returns

Promise<WithdrawHistory[]>

getWithdrawQuota()

getWithdrawQuota(): Promise<{
  usedWdQuota: string;
  wdQuota: string;
}>;

Returns

Promise<{ usedWdQuota: string; wdQuota: string; }>

isolatedMarginAccountTransfer()

isolatedMarginAccountTransfer(params: IsolatedMarginAccountTransferParams): Promise<MarginTransactionResponse>;

Parameters

Parameter	Type
`params`	`IsolatedMarginAccountTransferParams`

Returns

Promise<MarginTransactionResponse>

Deprecated

on 2024-01-09, use submitUniversalTransfer() instead

keepAliveIsolatedMarginUserDataListenKey()

keepAliveIsolatedMarginUserDataListenKey(params: object): Promise<object>;

Parameters

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

Returns

Promise<object>

keepAliveMarginRiskUserDataListenKey()

keepAliveMarginRiskUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

keepAliveMarginUserDataListenKey()

keepAliveMarginUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

keepAliveMarginUserDataListenKeyV2()

keepAliveMarginUserDataListenKeyV2(listenKey: string): Promise<object>;

Keepalive a Margin user data stream (PUT /sapi/v2/margin/listen-key). Weight(IP): 1. USER_STREAM. listenKey is a query parameter.

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

keepAliveMarginUtaUserDataListenKey()

keepAliveMarginUtaUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

keepAliveSpotUserDataListenKey()

keepAliveSpotUserDataListenKey(listenKey: string): Promise<object>;

Parameters

Parameter	Type
`listenKey`	`string`

Returns

Promise<object>

marginAccountCancelOCO()

marginAccountCancelOCO(params: CancelOCOParams): Promise<any>;

Parameters

Parameter	Type
`params`	`CancelOCOParams`

Returns

Promise<any>

marginAccountCancelOpenOrders()

marginAccountCancelOpenOrders(params: BasicSymbolParam): Promise<CancelSpotOrderResult[]>;

Parameters

Parameter	Type
`params`	`BasicSymbolParam`

Returns

Promise<CancelSpotOrderResult[]>

marginAccountCancelOrder()

marginAccountCancelOrder(params: CancelOrderParams): Promise<CancelSpotOrderResult>;

Parameters

Parameter	Type
`params`	`CancelOrderParams`

Returns

Promise<CancelSpotOrderResult>

marginAccountNewOCO()

marginAccountNewOCO(params: NewOCOParams): Promise<any>;

Parameters

Parameter	Type
`params`	`NewOCOParams`

Returns

Promise<any>

marginAccountNewOrder()

marginAccountNewOrder<T extends OrderType, RT extends OrderResponseType | undefined = undefined>(params: NewSpotOrderParams<T, RT>): Promise<OrderResponseTypeFor<RT, T>>;

Type Parameters

Type Parameter	Default type
`T` extends `OrderType`	-
`RT` extends `OrderResponseType` \| `undefined`	`undefined`

Parameters

Parameter	Type
`params`	`NewSpotOrderParams`<`T`, `RT`>

Returns

Promise<OrderResponseTypeFor<RT, T>>

mintPortfolioMarginBFUSD()

mintPortfolioMarginBFUSD(params: PMProMintBFUSDParams): Promise<PMProMintBFUSDResponse>;

Parameters

Parameter	Type
`params`	`PMProMintBFUSDParams`

Returns

Promise<PMProMintBFUSDResponse>

Deprecated

Check Simple Earn endpoints for new way of doing it

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

purchaseFixedAndActivityProject()

purchaseFixedAndActivityProject(params: object): Promise<PurchaseFlexibleProductResponse>;

Parameters

Parameter	Type
`params`	{ `lot`: `number`; `projectId`: `string`; }
`params.lot`	`number`
`params.projectId`	`string`

Returns

Promise<PurchaseFlexibleProductResponse>

Deprecated

as of 2023-06-22, now Simple Earn

purchaseFlexibleProduct()

purchaseFlexibleProduct(params: SimpleEarnSubscribeProductParams): Promise<SimpleEarnSubscribeFlexibleProductResponse>;

SIMPLE EARN Endpoints - Earn

Parameters

Parameter	Type
`params`	`SimpleEarnSubscribeProductParams`

Returns

Promise<SimpleEarnSubscribeFlexibleProductResponse>

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

queryCrossMarginAccountDetails()

queryCrossMarginAccountDetails(): Promise<QueryCrossMarginAccountDetailsParams>;

Returns

Promise<QueryCrossMarginAccountDetailsParams>

queryDustConvertibleAssets()

queryDustConvertibleAssets(params: DustConvertibleAssetsParams): Promise<DustConvertibleAssetsResponse>;

Query assets eligible for dust conversion.

Parameters

Parameter	Type
`params`	`DustConvertibleAssetsParams`

Returns

Promise<DustConvertibleAssetsResponse>

queryLoanRecord()

queryLoanRecord(params: QueryMarginRecordParams): Promise<{
  rows: MarginAccountRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`QueryMarginRecordParams`

Returns

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

Deprecated

on 2024-01-09, use getMarginAccountBorrowRepayRecords() instead

queryMarginAccountAllOCO()

queryMarginAccountAllOCO(params: QueryMarginAccountAllOCOParams): Promise<any>;

Parameters

Parameter	Type
`params`	`QueryMarginAccountAllOCOParams`

Returns

Promise<any>

queryMarginAccountAllOrders()

queryMarginAccountAllOrders(params: GetAllOrdersParams): Promise<SpotOrder[]>;

Parameters

Parameter	Type
`params`	`GetAllOrdersParams`

Returns

Promise<SpotOrder[]>

queryMarginAccountOCO()

queryMarginAccountOCO(params: GetOCOParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetOCOParams`

Returns

Promise<any>

queryMarginAccountOpenOCO()

queryMarginAccountOpenOCO(params: object): Promise<any>;

Parameters

Parameter	Type
`params`	{ `isIsolated?`: `"TRUE"` \| `"FALSE"`; `symbol?`: `string`; }
`params.isIsolated?`	`"TRUE"` \| `"FALSE"`
`params.symbol?`	`string`

Returns

Promise<any>

queryMarginAccountOpenOrders()

queryMarginAccountOpenOrders(params: BasicSymbolParam): Promise<SpotOrder[]>;

Parameters

Parameter	Type
`params`	`BasicSymbolParam`

Returns

Promise<SpotOrder[]>

queryMarginAccountOpenOTOOrderLists()

queryMarginAccountOpenOTOOrderLists(params: QueryMarginOpenOTOOrderListsParams): Promise<MarginOpenOTOOrderList[]>;

Parameters

Parameter	Type
`params`	`QueryMarginOpenOTOOrderListsParams`

Returns

Promise<MarginOpenOTOOrderList[]>

queryMarginAccountOrder()

queryMarginAccountOrder(params: GetOrderParams): Promise<SpotOrder>;

Parameters

Parameter	Type
`params`	`GetOrderParams`

Returns

Promise<SpotOrder>

queryMarginAccountTradeList()

queryMarginAccountTradeList(params: QueryMarginAccountTradeListParams): Promise<any>;

Parameters

Parameter	Type
`params`	`QueryMarginAccountTradeListParams`

Returns

Promise<any>

queryMarginPriceIndex()

queryMarginPriceIndex(params: BasicSymbolParam): Promise<QueryMarginPriceIndexResponse>;

Parameters

Parameter	Type
`params`	`BasicSymbolParam`

Returns

Promise<QueryMarginPriceIndexResponse>

queryMaxBorrow()

queryMaxBorrow(params: BasicMarginAssetParams): Promise<QueryMaxBorrowResponse>;

Parameters

Parameter	Type
`params`	`BasicMarginAssetParams`

Returns

Promise<QueryMaxBorrowResponse>

queryMaxTransferOutAmount()

queryMaxTransferOutAmount(params: BasicMarginAssetParams): Promise<QueryMaxTransferOutAmountResponse>;

Parameters

Parameter	Type
`params`	`BasicMarginAssetParams`

Returns

Promise<QueryMaxTransferOutAmountResponse>

queryRepayRecord()

queryRepayRecord(params: QueryMarginRecordParams): Promise<{
  rows: MarginAccountRecord[];
  total: number;
}>;

Parameters

Parameter	Type
`params`	`QueryMarginRecordParams`

Returns

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

Deprecated

on 2024-01-09, use getMarginAccountBorrowRepayRecords() instead

querySubAccountFuturesAssetInfo()

querySubAccountFuturesAssetInfo(params: QuerySubAccountFuturesAssetInfoParams): Promise<{
  data: (
     | UsdtMarginedFuturesResponse
    | CoinMarginedFuturesResponse)[];
  timestamp: number;
}>;

Parameters

Parameter	Type
`params`	`QuerySubAccountFuturesAssetInfoParams`

Returns

Promise<{ data: ( | UsdtMarginedFuturesResponse | CoinMarginedFuturesResponse)[]; timestamp: number; }>

redeemBfusd()

redeemBfusd(params: BfusdRedeemParams): Promise<BfusdRedeemResponse>;

Parameters

Parameter	Type
`params`	`BfusdRedeemParams`

Returns

Promise<BfusdRedeemResponse>

redeemBlvt()

redeemBlvt(params: RedeemBlvtParams): Promise<RedeemBlvtResponse>;

Parameters

Parameter	Type
`params`	`RedeemBlvtParams`

Returns

Promise<RedeemBlvtResponse>

redeemEth()

redeemEth(params: RedeemEthParams): Promise<RedeemEthResponse>;

Parameters

Parameter	Type
`params`	`RedeemEthParams`

Returns

Promise<RedeemEthResponse>

redeemFlexibleProduct()

redeemFlexibleProduct(params: SimpleEarnRedeemFlexibleProductParams): Promise<SimpleEarnRedeemResponse>;

Parameters

Parameter	Type
`params`	`SimpleEarnRedeemFlexibleProductParams`

Returns

Promise<SimpleEarnRedeemResponse>

redeemGiftCard()

redeemGiftCard(params: RedeemGiftCardParams): Promise<any>;

Parameters

Parameter	Type
`params`	`RedeemGiftCardParams`

Returns

Promise<any>

redeemLockedProduct()

redeemLockedProduct(params: object): Promise<SimpleEarnRedeemResponse>;

Parameters

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

Returns

Promise<SimpleEarnRedeemResponse>

redeemOnchainYieldsLockedProduct()

redeemOnchainYieldsLockedProduct(params: OnchainYieldsLockedRedeemParams): Promise<OnchainYieldsLockedRedeemResponse>;

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedRedeemParams`

Returns

Promise<OnchainYieldsLockedRedeemResponse>

redeemPortfolioMarginBFUSD()

redeemPortfolioMarginBFUSD(params: object): Promise<PMProRedeemBFUSDResponse>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; `fromAsset`: `string`; `targetAsset`: `string`; }
`params.amount`	`number`
`params.fromAsset`	`string`
`params.targetAsset`	`string`

Returns

Promise<PMProRedeemBFUSDResponse>

Deprecated

Check Simple Earn endpointsfor new way of doing it

redeemRwusd()

redeemRwusd(params: RwusdRedeemParams): Promise<RwusdRedeemResponse>;

Parameters

Parameter	Type
`params`	`RwusdRedeemParams`

Returns

Promise<RwusdRedeemResponse>

redeemSol()

redeemSol(params: object): Promise<RedeemSolResponse>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; }
`params.amount`	`number`

Returns

Promise<RedeemSolResponse>

removeBSwapLiquidity()

removeBSwapLiquidity(params: RemoveBSwapLiquidityParams): Promise<{
  operationId: number;
}>;

Parameters

Parameter	Type
`params`	`RemoveBSwapLiquidityParams`

Returns

Promise<{ operationId: number; }>

Deprecated

as of 2024-01-19

renewVipLoan()

renewVipLoan(params: VipLoanRenewParams): Promise<VipLoanRenewResponse>;

VIP LOAN Endpoints - Trade

Parameters

Parameter	Type
`params`	`VipLoanRenewParams`

Returns

Promise<VipLoanRenewResponse>

repayCryptoLoan()

repayCryptoLoan(params: RepayCryptoLoanParams): Promise<RepayCryptoLoanResponse>;

Parameters

Parameter	Type
`params`	`RepayCryptoLoanParams`

Returns

Promise<RepayCryptoLoanResponse>

Deprecated

repayCryptoLoanFlexible()

repayCryptoLoanFlexible(params: RepayCryptoFlexibleLoanParams): Promise<RepayCryptoFlexibleLoanResponse>;

Parameters

Parameter	Type
`params`	`RepayCryptoFlexibleLoanParams`

Returns

Promise<RepayCryptoFlexibleLoanResponse>

repayCryptoLoanFlexibleWithCollateral()

repayCryptoLoanFlexibleWithCollateral(params: RepayCryptoLoanFlexibleWithCollateralParams): Promise<RepayCryptoLoanFlexibleWithCollateralResponse>;

Parameters

Parameter	Type
`params`	`RepayCryptoLoanFlexibleWithCollateralParams`

Returns

Promise<RepayCryptoLoanFlexibleWithCollateralResponse>

repayFuturesNegativeBalance()

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

Returns

Promise<{ msg: string; }>

repayInstitutionalLoan()

repayInstitutionalLoan(params: InstitutionalLoanRepayParams): Promise<InstitutionalLoanRepayResponse>;

Parameters

Parameter	Type
`params`	`InstitutionalLoanRepayParams`

Returns

Promise<InstitutionalLoanRepayResponse>

repayMarginLiquidationLoan()

repayMarginLiquidationLoan(params: RepayMarginLiquidationLoanParams): Promise<MarginLiquidationLoanRepayResponse>;

Repay an outstanding cross-margin liquidation loan from the spot wallet.

Parameters

Parameter	Type
`params`	`RepayMarginLiquidationLoanParams`

Returns

Promise<MarginLiquidationLoanRepayResponse>

repayPortfolioMarginProBankruptcyLoan()

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

Parameters

Parameter	Type
`params`	{ `from?`: `"SPOT"` \| `"MARGIN"`; }
`params.from?`	`"SPOT"` \| `"MARGIN"`

Returns

Promise<{ tranId: number; }>

repayVipLoan()

repayVipLoan(params: VipLoanRepayParams): Promise<VipLoanRepayResponse>;

Parameters

Parameter	Type
`params`	`VipLoanRepayParams`

Returns

Promise<VipLoanRepayResponse>

replaceOrder()

replaceOrder<T extends OrderType, RT extends OrderResponseType | undefined = undefined>(params: ReplaceSpotOrderParams<T, RT>): Promise<ReplaceSpotOrderResultSuccess<T, RT>>;

Type Parameters

Type Parameter	Default type
`T` extends `OrderType`	-
`RT` extends `OrderResponseType` \| `undefined`	`undefined`

Parameters

Parameter	Type
`params`	`ReplaceSpotOrderParams`<`T`, `RT`>

Returns

Promise<ReplaceSpotOrderResultSuccess<T, RT>>

setConvertibleCoins()

setConvertibleCoins(params: ConvertibleCoinsParams): Promise<void>;

Parameters

Parameter	Type
`params`	`ConvertibleCoinsParams`

Returns

Promise<void>

Deprecated

deleted as of 2024-11-21

setFlexibleAutoSubscribe()

setFlexibleAutoSubscribe(params: SetAutoSubscribeParams): Promise<{
  success: boolean;
}>;

Parameters

Parameter	Type
`params`	`SetAutoSubscribeParams`

Returns

Promise<{ success: boolean; }>

setLockedAutoSubscribe()

setLockedAutoSubscribe(params: SetAutoSubscribeParams): Promise<{
  success: boolean;
}>;

Parameters

Parameter	Type
`params`	`SetAutoSubscribeParams`

Returns

Promise<{ success: boolean; }>

setLockedProductRedeemOption()

setLockedProductRedeemOption(params: object): Promise<{
  success: boolean;
}>;

Parameters

Parameter	Type
`params`	{ `positionId`: `string`; `redeemTo`: `"SPOT"` \| `"FLEXIBLE"`; }
`params.positionId`	`string`
`params.redeemTo`	`"SPOT"` \| `"FLEXIBLE"`

Returns

Promise<{ success: boolean; }>

setOnchainYieldsLockedAutoSubscribe()

setOnchainYieldsLockedAutoSubscribe(params: OnchainYieldsLockedSetAutoSubscribeParams): Promise<OnchainYieldsLockedSetAutoSubscribeResponse>;

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedSetAutoSubscribeParams`

Returns

Promise<OnchainYieldsLockedSetAutoSubscribeResponse>

setOnchainYieldsLockedRedeemOption()

setOnchainYieldsLockedRedeemOption(params: OnchainYieldsLockedSetRedeemOptionParams): Promise<OnchainYieldsLockedSetRedeemOptionResponse>;

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedSetRedeemOptionParams`

Returns

Promise<OnchainYieldsLockedSetRedeemOptionResponse>

setPortfolioMarginMarginCallLevel()

setPortfolioMarginMarginCallLevel(params: SetPortfolioMarginMarginCallLevelParams): Promise<PortfolioMarginMarginCallLevelResponse>;

Parameters

Parameter	Type
`params`	`SetPortfolioMarginMarginCallLevelParams`

Returns

Promise<PortfolioMarginMarginCallLevelResponse>

setSoftStaking()

setSoftStaking(params: SetSoftStakingParams): Promise<SetSoftStakingResponse>;

Parameters

Parameter	Type
`params`	`SetSoftStakingParams`

Returns

Promise<SetSoftStakingResponse>

setTimeOffset()

setTimeOffset(value: number): void;

Parameters

Parameter	Type
`value`	`number`

Returns

void

Inherited from

BaseRestClient.setTimeOffset

subAccountAddIPList()

subAccountAddIPList(params: SubAccountEnableOrDisableIPRestriction): Promise<SubAccountAddOrDeleteIPList>;

Parameters

Parameter	Type
`params`	`SubAccountEnableOrDisableIPRestriction`

Returns

Promise<SubAccountAddOrDeleteIPList>

Deprecated

Use subAccountAddIPRestriction instead

subAccountAddIPRestriction()

subAccountAddIPRestriction(params: AddIpRestriction): Promise<SubAccountEnableOrDisableIPRestriction>;

Parameters

Parameter	Type
`params`	`AddIpRestriction`

Returns

Promise<SubAccountEnableOrDisableIPRestriction>

subAccountDeleteIPList()

subAccountDeleteIPList(params: SubAccountAddOrDeleteIPList): Promise<SubAccountEnableOrDisableIPRestriction>;

Parameters

Parameter	Type
`params`	`SubAccountAddOrDeleteIPList`

Returns

Promise<SubAccountEnableOrDisableIPRestriction>

subAccountEnableFutures()

subAccountEnableFutures(email: string): Promise<SubAccountEnableFutures>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<SubAccountEnableFutures>

subAccountEnableLeverageToken()

subAccountEnableLeverageToken(params: SubAccountEnableLeverageToken): Promise<SubAccountEnableLeverageToken>;

Parameters

Parameter	Type
`params`	`SubAccountEnableLeverageToken`

Returns

Promise<SubAccountEnableLeverageToken>

Deprecated

as of 2025-06-03 User now should make the initial transfer in the Margin account to enable it.

subAccountEnableMargin()

subAccountEnableMargin(email: string): Promise<SubAccountEnableMargin>;

Parameters

Parameter	Type
`email`	`string`

Returns

Promise<SubAccountEnableMargin>

Deprecated

as of 2025-06-03 User now should make the initial transfer in the Margin account to enable it.

subAccountEnableOrDisableIPRestriction()

subAccountEnableOrDisableIPRestriction(params: EnableOrDisableIPRestrictionForSubAccountParams): Promise<SubAccountEnableOrDisableIPRestriction>;

Parameters

Parameter	Type
`params`	`EnableOrDisableIPRestrictionForSubAccountParams`

Returns

Promise<SubAccountEnableOrDisableIPRestriction>

Deprecated

Use subAccountAddIPRestriction instead, or subAccountDeleteIPList

subAccountFuturesAssetTransfer()

subAccountFuturesAssetTransfer(params: SubAccountFuturesAssetTransferParams): Promise<SubAccountFuturesAssetTransfer>;

Parameters

Parameter	Type
`params`	`SubAccountFuturesAssetTransferParams`

Returns

Promise<SubAccountFuturesAssetTransfer>

subAccountFuturesTransfer()

subAccountFuturesTransfer(params: SubAccountTransferParams): Promise<SubAccountTransfer>;

SUB ACCOUNT Endpoints - Asset management

Parameters

Parameter	Type
`params`	`SubAccountTransferParams`

Returns

Promise<SubAccountTransfer>

subAccountMarginTransfer()

subAccountMarginTransfer(params: SubAccountTransferParams): Promise<SubAccountTransfer>;

Parameters

Parameter	Type
`params`	`SubAccountTransferParams`

Returns

Promise<SubAccountTransfer>

subAccountMovePosition()

subAccountMovePosition(params: SubAccountMovePositionParams): Promise<{
  movePositionOrders: SubAccountMovePosition[];
}>;

Parameters

Parameter	Type
`params`	`SubAccountMovePositionParams`

Returns

Promise<{ movePositionOrders: SubAccountMovePosition[]; }>

subAccountTransferHistory()

subAccountTransferHistory(params?: SubAccountTransferHistoryParams): Promise<SubAccountTransferHistory[]>;

Parameters

Parameter	Type
`params?`	`SubAccountTransferHistoryParams`

Returns

Promise<SubAccountTransferHistory[]>

subAccountTransferToMaster()

subAccountTransferToMaster(params: SubAccountTransferToMasterParams): Promise<SubAccountTransfer>;

Parameters

Parameter	Type
`params`	`SubAccountTransferToMasterParams`

Returns

Promise<SubAccountTransfer>

subAccountTransferToSameMaster()

subAccountTransferToSameMaster(params: SubAccountTransferToSameMasterParams): Promise<SubAccountTransfer>;

Parameters

Parameter	Type
`params`	`SubAccountTransferToSameMasterParams`

Returns

Promise<SubAccountTransfer>

subAccountUniversalTransfer()

subAccountUniversalTransfer(params: SubAccountUniversalTransferParams): Promise<SubAccountUniversalTransfer>;

Parameters

Parameter	Type
`params`	`SubAccountUniversalTransferParams`

Returns

Promise<SubAccountUniversalTransfer>

submitAutoInvestmentPlan()

submitAutoInvestmentPlan(params: CreateInvestmentPlanParams): Promise<CreateInvestmentPlanResponse>;

Parameters

Parameter	Type
`params`	`CreateInvestmentPlanParams`

Returns

Promise<CreateInvestmentPlanResponse>

submitAutoInvestOneTimeTransaction()

submitAutoInvestOneTimeTransaction(params: SubmitOneTimeTransactionParams): Promise<SubmitOneTimeTransactionResponse>;

https://developers.binance.com/docs/auto_invest/trade/One-Time-Transaction

Parameters

Parameter	Type	Description
`params`	`SubmitOneTimeTransactionParams`	-

Returns

Promise<SubmitOneTimeTransactionResponse>

submitAutoInvestRedemption()

submitAutoInvestRedemption(params: SubmitIndexLinkedPlanRedemptionParams): Promise<{
  redemptionId: number;
}>;

Parameters

Parameter	Type
`params`	`SubmitIndexLinkedPlanRedemptionParams`

Returns

Promise<{ redemptionId: number; }>

submitBrokerSubFuturesTransfer()

submitBrokerSubFuturesTransfer(params: object): Promise<{
  clientTranId?: string;
  success: boolean;
  txnId: string;
}>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; `asset`: `string`; `clientTranId?`: `string`; `fromId?`: `string`; `futuresType`: `number`; `toId?`: `string`; }
`params.amount`	`number`
`params.asset`	`string`
`params.clientTranId?`	`string`
`params.fromId?`	`string`
`params.futuresType`	`number`
`params.toId?`	`string`

Returns

Promise<{ clientTranId?: string; success: boolean; txnId: string; }>

submitConvertLimitOrder()

submitConvertLimitOrder(params: SubmitConvertLimitOrderParams): Promise<any>;

Parameters

Parameter	Type
`params`	`SubmitConvertLimitOrderParams`

Returns

Promise<any>

submitDepositCredit()

submitDepositCredit(params: SubmitDepositCreditParams): Promise<SubmitDepositCreditResponse>;

Parameters

Parameter	Type
`params`	`SubmitDepositCreditParams`

Returns

Promise<SubmitDepositCreditResponse>

submitHashrateResale()

submitHashrateResale(params: SubmitHashrateResaleParams): Promise<number>;

Parameters

Parameter	Type
`params`	`SubmitHashrateResaleParams`

Returns

Promise<number>

submitManualLiquidation()

submitManualLiquidation(params: ManualLiquidationParams): Promise<ManualLiquidationResponse[]>;

Parameters

Parameter	Type
`params`	`ManualLiquidationParams`

Returns

Promise<ManualLiquidationResponse[]>

submitMarginAccountBorrowRepay()

submitMarginAccountBorrowRepay(params: MarginAccountLoanParams): Promise<MarginTransactionResponse>;

Parameters

Parameter	Type
`params`	`MarginAccountLoanParams`

Returns

Promise<MarginTransactionResponse>

submitMarginOTOCOOrder()

submitMarginOTOCOOrder(params: SubmitMarginOTOCOOrderParams): Promise<MarginOTOCOOrder>;

Submit a new OTOCO order for margin account

Parameters

Parameter	Type
`params`	`SubmitMarginOTOCOOrderParams`

Returns

Promise<MarginOTOCOOrder>

submitMarginOTOOrder()

submitMarginOTOOrder(params: SubmitMarginOTOOrderParams): Promise<MarginOTOOrder>;

Post a new OTO order for margin account

Parameters

Parameter	Type
`params`	`SubmitMarginOTOOrderParams`

Returns

Promise<MarginOTOOrder>

submitNewFutureAccountTransfer()

submitNewFutureAccountTransfer(params: NewFutureAccountTransferParams): Promise<{
  tranId: number;
}>;

Possibly @deprecated, found only in old docs only Use sapi/v1/asset/transfer instead

Parameters

Parameter	Type
`params`	`NewFutureAccountTransferParams`

Returns

Promise<{ tranId: number; }>

submitNewOCO()

submitNewOCO(params: NewOCOParams): Promise<any>;

Parameters

Parameter	Type
`params`	`NewOCOParams`

Returns

Promise<any>

Deprecated

submitNewOrder()

submitNewOrder<T extends OrderType, RT extends OrderResponseType | undefined = undefined>(params: NewSpotOrderParams<T, RT>): Promise<OrderResponseTypeFor<RT, T>>;

SPOT TRADING Endpoints - Trading endpoints

Type Parameters

Type Parameter	Default type
`T` extends `OrderType`	-
`RT` extends `OrderResponseType` \| `undefined`	`undefined`

Parameters

Parameter	Type
`params`	`NewSpotOrderParams`<`T`, `RT`>

Returns

Promise<OrderResponseTypeFor<RT, T>>

submitNewOrderList()

submitNewOrderList<T extends OrderResponseType>(params: NewOrderListParams<T>): Promise<OrderListResponse<T>>;

Type Parameters

Type Parameter
`T` extends `OrderResponseType`

Parameters

Parameter	Type
`params`	`NewOrderListParams`<`T`>

Returns

Promise<OrderListResponse<T>>

submitNewOrderListOPO()

submitNewOrderListOPO(params: NewOrderListOPOParams): Promise<NewOrderListOPOResponse>;

Parameters

Parameter	Type
`params`	`NewOrderListOPOParams`

Returns

Promise<NewOrderListOPOResponse>

submitNewOrderListOPOCO()

submitNewOrderListOPOCO(params: NewOrderListOPOCOParams): Promise<NewOrderListOPOCOResponse>;

Parameters

Parameter	Type
`params`	`NewOrderListOPOCOParams`

Returns

Promise<NewOrderListOPOCOResponse>

submitNewOrderListOTO()

submitNewOrderListOTO(params: NewOrderListOTOParams): Promise<NewOrderListOTOResponse>;

Parameters

Parameter	Type
`params`	`NewOrderListOTOParams`

Returns

Promise<NewOrderListOTOResponse>

submitNewOrderListOTOCO()

submitNewOrderListOTOCO(params: NewOrderListOTOCOParams): Promise<NewOrderListOTOCOResponse>;

Parameters

Parameter	Type
`params`	`NewOrderListOTOCOParams`

Returns

Promise<NewOrderListOTOCOResponse>

submitNewSOROrder()

submitNewSOROrder(params: NewSpotSOROrderParams): Promise<SOROrderResponseFull>;

Places an order using smart order routing (SOR).

Parameters

Parameter	Type
`params`	`NewSpotSOROrderParams`

Returns

Promise<SOROrderResponseFull>

submitPortfolioMarginProFullTransfer()

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

Returns

Promise<{ msg: string; }>

submitPortfolioMarginProSpecificTransfer()

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

Fund collection by asset (POST /sapi/v1/portfolio/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; }>

submitSmallLiabilityExchange()

submitSmallLiabilityExchange(params: object): Promise<{
  message: string;
  success: boolean;
}>;

Parameters

Parameter	Type
`params`	{ `assetNames`: `string`[]; }
`params.assetNames`	`string`[]

Returns

Promise<{ message: string; success: boolean; }>

submitSpotAlgoTwapOrder()

submitSpotAlgoTwapOrder(params: SubmitSpotTwapNewOrderParams): Promise<SubmitSpotTwapNewOrderResponse>;

ALGO TRADING Endpoints - Spot algo

Parameters

Parameter	Type
`params`	`SubmitSpotTwapNewOrderParams`

Returns

Promise<SubmitSpotTwapNewOrderResponse>

submitTravelRuleDepositQuestionnaire()

submitTravelRuleDepositQuestionnaire(params: SubmitTravelRuleDepositQuestionnaireParams): Promise<SubmitTravelRuleDepositQuestionnaireResponse>;

Submit questionnaire for local entities that require travel rule

for questionaire format, please refer to the docs: https://developers.binance.com/docs/wallet/travel-rule/deposit-questionnaire

Parameters

Parameter	Type
`params`	`SubmitTravelRuleDepositQuestionnaireParams`

Returns

Promise<SubmitTravelRuleDepositQuestionnaireResponse>

submitTwapNewOrder()

submitTwapNewOrder(params: SubmitTwapNewOrderParams): Promise<SubmitTwapNewOrderResponse>;

Parameters

Parameter	Type
`params`	`SubmitTwapNewOrderParams`

Returns

Promise<SubmitTwapNewOrderResponse>

submitUniversalTransfer()

submitUniversalTransfer(params: UniversalTransferParams): Promise<{
  tranId: number;
}>;

Parameters

Parameter	Type
`params`	`UniversalTransferParams`

Returns

Promise<{ tranId: number; }>

submitVpNewOrder()

submitVpNewOrder(params: SubmitVpNewOrderParams): Promise<SubmitVpNewOrderResponse>;

ALGO TRADING Endpoints - Future algo

Parameters

Parameter	Type
`params`	`SubmitVpNewOrderParams`

Returns

Promise<SubmitVpNewOrderResponse>

subscribeBfusd()

subscribeBfusd(params: BfusdSubscribeParams): Promise<BfusdSubscribeResponse>;

Parameters

Parameter	Type
`params`	`BfusdSubscribeParams`

Returns

Promise<BfusdSubscribeResponse>

subscribeBlvt()

subscribeBlvt(params: SubscribeBlvtParams): Promise<SubscribeBlvtResponse>;

Parameters

Parameter	Type
`params`	`SubscribeBlvtParams`

Returns

Promise<SubscribeBlvtResponse>

subscribeDualInvestmentProduct()

subscribeDualInvestmentProduct(params: SubscribeDualInvestmentProductParams): Promise<SubscribeDualInvestmentProductResponse>;

DUAL INVESTMENT Endpoints - Trade

Parameters

Parameter	Type
`params`	`SubscribeDualInvestmentProductParams`

Returns

Promise<SubscribeDualInvestmentProductResponse>

subscribeEthStakingV1()

subscribeEthStakingV1(params: object): Promise<{
  success: boolean;
}>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; }
`params.amount`	`number`

Returns

Promise<{ success: boolean; }>

Deprecated

use subscribeEthStakingV2 instead

subscribeEthStakingV2()

subscribeEthStakingV2(params: object): Promise<SubscribeEthStakingV2Response>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; }
`params.amount`	`number`

Returns

Promise<SubscribeEthStakingV2Response>

subscribeOnchainYieldsLockedProduct()

subscribeOnchainYieldsLockedProduct(params: OnchainYieldsLockedSubscribeParams): Promise<OnchainYieldsLockedSubscribeResponse>;

Parameters

Parameter	Type
`params`	`OnchainYieldsLockedSubscribeParams`

Returns

Promise<OnchainYieldsLockedSubscribeResponse>

subscribeRwusd()

subscribeRwusd(params: RwusdSubscribeParams): Promise<RwusdSubscribeResponse>;

Parameters

Parameter	Type
`params`	`RwusdSubscribeParams`

Returns

Promise<RwusdSubscribeResponse>

subscribeSimpleEarnLockedProduct()

subscribeSimpleEarnLockedProduct(params: SimpleEarnSubscribeProductParams): Promise<SimpleEarnSubscribeLockedProductResponse>;

Parameters

Parameter	Type
`params`	`SimpleEarnSubscribeProductParams`

Returns

Promise<SimpleEarnSubscribeLockedProductResponse>

subscribeSolStaking()

subscribeSolStaking(params: object): Promise<SubscribeSolStakingResponse>;

STAKING Endpoints - SOL Staking - Staking

Parameters

Parameter	Type
`params`	{ `amount`: `number`; }
`params.amount`	`number`

Returns

Promise<SubscribeSolStakingResponse>

switchPortfolioDeltaMode()

switchPortfolioDeltaMode(params: SwitchPortfolioDeltaModeParams): Promise<{
  msg: string;
}>;

Parameters

Parameter	Type
`params`	`SwitchPortfolioDeltaModeParams`

Returns

Promise<{ msg: string; }>

syncTime()

syncTime(): Promise<void>;

Trigger time sync and store promise

Returns

Promise<void>

Inherited from

BaseRestClient.syncTime

testConnectivity()

testConnectivity(): Promise<object>;

SPOT TRADING Endpoints - General endpoints

Returns

Promise<object>

testNewOrder()

testNewOrder<T extends OrderType, RT extends OrderResponseType | undefined = undefined>(params: NewSpotOrderParams<T, RT>): Promise<object>;

Type Parameters

Type Parameter	Default type
`T` extends `OrderType`	-
`RT` extends `OrderResponseType` \| `undefined`	`undefined`

Parameters

Parameter	Type
`params`	`NewSpotOrderParams`<`T`, `RT`>

Returns

Promise<object>

testNewSOROrder()

testNewSOROrder(params: NewSpotSOROrderParams & object): Promise<
  | object
| SORTestOrderResponse>;

Test new order creation and signature/recvWindow using smart order routing (SOR). Creates and validates a new order but does not send it into the matching engine.

Parameters

Parameter	Type
`params`	`NewSpotSOROrderParams` & `object`

Returns

Promise< | object | SORTestOrderResponse>

toggleBNBBurn()

toggleBNBBurn(params: ToggleBNBBurnParams): Promise<BNBBurnResponse>;

Parameters

Parameter	Type
`params`	`ToggleBNBBurnParams`

Returns

Promise<BNBBurnResponse>

transferBrokerSubAccount()

transferBrokerSubAccount(params: TransferBrokerSubAccountParams): Promise<TransferBrokerSubAccount>;

EXCHANGE LINK - Asset Endpoints https://developers.binance.com/docs/binance_link

Parameters

Parameter	Type
`params`	`TransferBrokerSubAccountParams`

Returns

Promise<TransferBrokerSubAccount>

transferInstLoanRiskUnit()

transferInstLoanRiskUnit(params: InstitutionalLoanRiskUnitTransferParams): Promise<null>;

INSTITUTIONAL LOAN - TransferEndpoints

Parameters

Parameter	Type
`params`	`InstitutionalLoanRiskUnitTransferParams`

Returns

Promise<null>

transferLDUSDTPortfolioMargin()

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

Transfer LDUSDT as collateral for all types of Portfolio Margin account

Parameters

Parameter	Type
`params`	{ `amount`: `number`; `asset`: `string`; `transferType`: `"EARN_TO_FUTURE"` \| `"FUTURE_TO_EARN"`; }
`params.amount`	`number`
`params.asset`	`string`
`params.transferType`	`"EARN_TO_FUTURE"` \| `"FUTURE_TO_EARN"`

Returns

Promise<{ msg: string; }>

universalTransferBroker()

universalTransferBroker(params: UniversalTransferBrokerParams): Promise<{
  clientTranId: string;
  txnId: number;
}>;

Parameters

Parameter	Type
`params`	`UniversalTransferBrokerParams`

Returns

Promise<{ clientTranId: string; txnId: number; }>

updateAutoCompoundStatus()

updateAutoCompoundStatus(params: ChangeAutoCompoundStatusParams): Promise<ChangeAutoCompoundStatusResponse>;

Parameters

Parameter	Type
`params`	`ChangeAutoCompoundStatusParams`

Returns

Promise<ChangeAutoCompoundStatusResponse>

Deprecated

Binance removed POST /sapi/v1/dci/product/auto_compound/edit-status. Calls to this method will fail. Configure auto-compound for Dual Investment positions in the Binance web UI. This method will be removed in a future major version. connector-js dual-investment v6.0.0 removed changeAutoCompoundStatus. The published binance-api-swagger spec still lists the endpoint, so this method stays deprecated.

updateAutoInvestmentPlan()

updateAutoInvestmentPlan(params: EditInvestmentPlanParams): Promise<EditInvestmentPlanResponse>;

Parameters

Parameter	Type
`params`	`EditInvestmentPlanParams`

Returns

Promise<EditInvestmentPlanResponse>

updateAutoInvestPlanStatus()

updateAutoInvestPlanStatus(params: ChangePlanStatusParams): Promise<ChangePlanStatusResponse>;

Parameters

Parameter	Type
`params`	`ChangePlanStatusParams`

Returns

Promise<ChangePlanStatusResponse>

updateAutoRepayFuturesStatus()

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

Parameters

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

Returns

Promise<{ msg: string; }>

updateBrokerSubAccountCoinFuturesCommission()

updateBrokerSubAccountCoinFuturesCommission(params: ChangeSubAccountCoinFuturesCommissionParams): Promise<ChangeSubAccountFuturesCommissionResponse>;

Parameters

Parameter	Type
`params`	`ChangeSubAccountCoinFuturesCommissionParams`

Returns

Promise<ChangeSubAccountFuturesCommissionResponse>

updateBrokerSubAccountCommission()

updateBrokerSubAccountCommission(params: ChangeSubAccountCommissionParams): Promise<ChangeSubAccountCommissionResponse>;

EXCHANGE LINK - Fee Endpoints https://developers.binance.com/docs/binance_link

Parameters

Parameter	Type
`params`	`ChangeSubAccountCommissionParams`

Returns

Promise<ChangeSubAccountCommissionResponse>

updateBrokerSubAccountFuturesCommission()

updateBrokerSubAccountFuturesCommission(params: ChangeSubAccountFuturesCommissionParams): Promise<ChangeSubAccountFuturesCommissionResponse>;

Parameters

Parameter	Type
`params`	`ChangeSubAccountFuturesCommissionParams`

Returns

Promise<ChangeSubAccountFuturesCommissionResponse>

updateCrossMarginMaxLeverage()

updateCrossMarginMaxLeverage(params: object): Promise<{
  success: boolean;
}>;

MARGIN TRADING Endpoints - Account endpoints

Parameters

Parameter	Type
`params`	{ `maxLeverage`: `number`; }
`params.maxLeverage`	`number`

Returns

Promise<{ success: boolean; }>

updateIpRestrictionForSubAccountApiKey()

updateIpRestrictionForSubAccountApiKey(params: UpdateIpRestrictionForSubApiKey): Promise<{
  apiKey: string;
  ipList?: string[];
  status: string;
  updateTime: number;
}>;

Parameters

Parameter	Type
`params`	`UpdateIpRestrictionForSubApiKey`

Returns

Promise<{ apiKey: string; ipList?: string[]; status: string; updateTime: number; }>

updateMarginIPForSpecialLowLatencyKey()

updateMarginIPForSpecialLowLatencyKey(params: object): Promise<object>;

Parameters

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

Returns

Promise<object>

updateSubAccountBNBBurn()

updateSubAccountBNBBurn(params: object): Promise<{
  spotBNBBurn: boolean;
  subAccountId: string;
}>;

Parameters

Parameter	Type
`params`	{ `spotBNBBurn`: `"true"` \| `"false"`; `subAccountId`: `string`; }
`params.spotBNBBurn`	`"true"` \| `"false"`
`params.subAccountId`	`string`

Returns

Promise<{ spotBNBBurn: boolean; subAccountId: string; }>

updateSubAccountMarginInterestBNBBurn()

updateSubAccountMarginInterestBNBBurn(params: object): Promise<{
  interestBNBBurn: boolean;
  subAccountId: string;
}>;

Parameters

Parameter	Type
`params`	{ `interestBNBBurn`: `"true"` \| `"false"`; `subAccountId`: `string`; }
`params.interestBNBBurn`	`"true"` \| `"false"`
`params.subAccountId`	`string`

Returns

Promise<{ interestBNBBurn: boolean; subAccountId: string; }>

verifyGiftCard()

verifyGiftCard(params: object): Promise<any>;

Parameters

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

Returns

Promise<any>

withdraw()

withdraw(params: WithdrawParams): Promise<{
  id: string;
}>;

Parameters

Parameter	Type
`params`	`WithdrawParams`

Returns

Promise<{ id: string; }>

withdrawAssetsFromManagedSubAccount()

withdrawAssetsFromManagedSubAccount(params: WithdrawAssetsFromManagedSubAccountParams): Promise<MarginTransactionResponse>;

Parameters

Parameter	Type
`params`	`WithdrawAssetsFromManagedSubAccountParams`

Returns

Promise<MarginTransactionResponse>

withdrawTravelRule()

withdrawTravelRule(params: WithdrawTravelRuleParams): Promise<{
  accpted: boolean;
  info: string;
  trId: number;
}>;

Submit a withdrawal request for local entities that require travel rule

For questionaire format, please refer to the docs: https://developers.binance.com/docs/wallet/travel-rule/withdraw-questionnaire

Parameters

Parameter	Type
`params`	`WithdrawTravelRuleParams`

Returns

Promise<{ accpted: boolean; info: string; trId: number; }>

wrapBeth()

wrapBeth(params: object): Promise<WrapBethResponse>;

Parameters

Parameter	Type
`params`	{ `amount`: `number`; }
`params.amount`	`number`

Returns

Promise<WrapBethResponse>

Class: MainClient ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

apiLimitLastUpdated ​

Inherited from ​

apiLimitTrackers ​

Inherited from ​

Methods ​

acceptQuoteRequest() ​

Parameters ​

Returns ​

addBSwapLiquidity() ​

Parameters ​

Returns ​

Deprecated ​

addInstLoanCollateralAccount() ​

Parameters ​

Returns ​

adjustCryptoLoanFlexibleLTV() ​

Parameters ​

Returns ​

adjustCryptoLoanLTV() ​

Parameters ​

Returns ​

Deprecated ​

amendOrderKeepPriority() ​

Parameters ​

Returns ​

bnbTransfer() ​

Parameters ​

Returns ​

borrowCryptoLoan() ​

Parameters ​

Returns ​

Deprecated ​

borrowCryptoLoanFlexible() ​

Parameters ​

Returns ​

borrowInstitutionalLoan() ​

Parameters ​

Returns ​

borrowVipLoan() ​

Parameters ​

Returns ​

borrowVipLoanFixedRate() ​

Parameters ​

Returns ​

cancelAlgoOrder() ​

Parameters ​

Returns ​

cancelAllSymbolOrders() ​

Parameters ​

Returns ​

cancelConvertLimitOrder() ​

Parameters ​

Returns ​

cancelHashrateResaleConfig() ​

Parameters ​

Returns ​

cancelOCO() ​

Parameters ​

Returns ​

cancelOrder() ​

Parameters ​

Returns ​

cancelSpotAlgoOrder() ​

Parameters ​

Returns ​

changeComissionBrokerSubAccount() ​

Parameters ​

Returns ​

changeFixedAndActivityPositionToDailyPosition() ​

Parameters ​

Returns ​

Deprecated ​

Class: MainClient

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

apiLimitLastUpdated

Inherited from

apiLimitTrackers

Inherited from

Methods

acceptQuoteRequest()

Parameters

Returns

addBSwapLiquidity()

Parameters

Returns

Deprecated

addInstLoanCollateralAccount()

Parameters

Returns

adjustCryptoLoanFlexibleLTV()

Parameters

Returns

adjustCryptoLoanLTV()

Parameters

Returns

Deprecated

amendOrderKeepPriority()

Parameters

Returns

bnbTransfer()

Parameters

Returns

borrowCryptoLoan()

Parameters

Returns

Deprecated

borrowCryptoLoanFlexible()

Parameters

Returns

borrowInstitutionalLoan()

Parameters

Returns

borrowVipLoan()

Parameters

Returns

borrowVipLoanFixedRate()

Parameters

Returns

cancelAlgoOrder()

Parameters

Returns

cancelAllSymbolOrders()

Parameters

Returns

cancelConvertLimitOrder()

Parameters

Returns

cancelHashrateResaleConfig()

Parameters

Returns

cancelOCO()

Parameters

Returns

cancelOrder()

Parameters

Returns

cancelSpotAlgoOrder()

Parameters

Returns

changeComissionBrokerSubAccount()

Parameters

Returns

changeFixedAndActivityPositionToDailyPosition()

Parameters

Returns

Deprecated