Class AccountManagementApi

AccountManagementApi - object-oriented interface AccountManagementApi

Implements

AccountManagementApiInterface

Index

Constructors

Methods

createAVirtualSubAccount enableFuturesForSubAccount enableOptionsForSubAccount getFuturesPositionRiskOfSubAccount getFuturesPositionRiskOfSubAccountV2 getSubAccountsStatusOnMarginOrFutures querySubAccountList querySubAccountTransactionStatistics

Constructors

constructor

new AccountManagementApi(
configuration: ConfigurationRestAPI,
): AccountManagementApi
Parameters
- configuration: ConfigurationRestAPI
Returns AccountManagementApi
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:690

Methods

createAVirtualSubAccount

createAVirtualSubAccount(
requestParameters: CreateAVirtualSubAccountRequest,
): Promise<RestApiResponse<CreateAVirtualSubAccountResponse>>
Create a Virtual Sub-account

This request will generate a virtual sub account under your master account. You need to enable "trade" option for the API Key which requests this endpoint.

Weight: 1
Parameters
- requestParameters: CreateAVirtualSubAccountRequest
  Request parameters.
Returns Promise<RestApiResponse<CreateAVirtualSubAccountResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.createAVirtualSubAccount
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:710

enableFuturesForSubAccount

enableFuturesForSubAccount(
requestParameters: EnableFuturesForSubAccountRequest,
): Promise<RestApiResponse<EnableFuturesForSubAccountResponse>>
Enable Futures for Sub-account for Master Account

Weight: 1
Parameters
- requestParameters: EnableFuturesForSubAccountRequest
  Request parameters.
Returns Promise<RestApiResponse<EnableFuturesForSubAccountResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.enableFuturesForSubAccount
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:739

enableOptionsForSubAccount

enableOptionsForSubAccount(
requestParameters: EnableOptionsForSubAccountRequest,
): Promise<RestApiResponse<EnableOptionsForSubAccountResponse>>
Enable Options for Sub-account (For Master Account).

Weight: 1
Parameters
- requestParameters: EnableOptionsForSubAccountRequest
  Request parameters.
Returns Promise<RestApiResponse<EnableOptionsForSubAccountResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.enableOptionsForSubAccount
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:768

getFuturesPositionRiskOfSubAccount

getFuturesPositionRiskOfSubAccount(
requestParameters: GetFuturesPositionRiskOfSubAccountRequest,
): Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountResponse>>
Get Futures Position-Risk of Sub-account

Weight: 10
Parameters
- requestParameters: GetFuturesPositionRiskOfSubAccountRequest
  Request parameters.
Returns Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.getFuturesPositionRiskOfSubAccount
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:797

getFuturesPositionRiskOfSubAccountV2

getFuturesPositionRiskOfSubAccountV2(
requestParameters: GetFuturesPositionRiskOfSubAccountV2Request,
): Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountV2Response>>
Get Futures Position-Risk of Sub-account V2

Weight: 1
Parameters
- requestParameters: GetFuturesPositionRiskOfSubAccountV2Request
  Request parameters.
Returns Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountV2Response>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.getFuturesPositionRiskOfSubAccountV2
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:827

getSubAccountsStatusOnMarginOrFutures

getSubAccountsStatusOnMarginOrFutures(
requestParameters?: GetSubAccountsStatusOnMarginOrFuturesRequest,
): Promise<RestApiResponse<GetSubAccountsStatusOnMarginOrFuturesResponse>>
Get Sub-account's Status on Margin Or Futures

If no email sent, all sub-accounts' information will be returned.

Weight: 10
Parameters
- requestParameters: GetSubAccountsStatusOnMarginOrFuturesRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetSubAccountsStatusOnMarginOrFuturesResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.getSubAccountsStatusOnMarginOrFutures
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:860

querySubAccountList

querySubAccountList(
requestParameters?: QuerySubAccountListRequest,
): Promise<RestApiResponse<QuerySubAccountListResponse>>
Query Sub-account List

Weight: 1
Parameters
- requestParameters: QuerySubAccountListRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<QuerySubAccountListResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.querySubAccountList
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:890

querySubAccountTransactionStatistics

querySubAccountTransactionStatistics(
requestParameters: QuerySubAccountTransactionStatisticsRequest,
): Promise<RestApiResponse<QuerySubAccountTransactionStatisticsResponse>>
Query Sub-account Transaction statistics (For Master Account).

Weight: 60
Parameters
- requestParameters: QuerySubAccountTransactionStatisticsRequest
  Request parameters.
Returns Promise<RestApiResponse<QuerySubAccountTransactionStatisticsResponse>>
Throws
Memberof
AccountManagementApi

See
Binance API Documentation
Implementation of AccountManagementApiInterface.querySubAccountTransactionStatistics
- Defined in clients/sub-account/src/rest-api/modules/account-management-api.ts:922

Class AccountManagementApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AccountManagementApi

Methods

createAVirtualSubAccount

Parameters

Returns Promise<RestApiResponse<CreateAVirtualSubAccountResponse>>

Throws

Memberof

See

enableFuturesForSubAccount

Parameters

Returns Promise<RestApiResponse<EnableFuturesForSubAccountResponse>>

Throws

Memberof

See

enableOptionsForSubAccount

Parameters

Returns Promise<RestApiResponse<EnableOptionsForSubAccountResponse>>

Throws

Memberof

See

getFuturesPositionRiskOfSubAccount

Parameters

Returns Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountResponse>>

Throws

Memberof

See

getFuturesPositionRiskOfSubAccountV2

Parameters

Returns Promise<RestApiResponse<GetFuturesPositionRiskOfSubAccountV2Response>>

Throws

Memberof

See

getSubAccountsStatusOnMarginOrFutures

Parameters

Returns Promise<RestApiResponse<GetSubAccountsStatusOnMarginOrFuturesResponse>>

Throws

Memberof

See

querySubAccountList

Parameters

Returns Promise<RestApiResponse<QuerySubAccountListResponse>>

Throws

Memberof

See

querySubAccountTransactionStatistics

Parameters

Returns Promise<RestApiResponse<QuerySubAccountTransactionStatisticsResponse>>

Throws

Memberof

See

Settings

On This Page