Class TradeApi

TradeApi - object-oriented interface TradeApi

Implements

AutoInvestRestAPI.TradeApiInterface

Index

Constructors

Methods

changePlanStatus indexLinkedPlanRebalanceDetails indexLinkedPlanRedemption indexLinkedPlanRedemptionTrade investmentPlanAdjustment investmentPlanCreation oneTimeTransaction queryHoldingDetailsOfThePlan queryIndexLinkedPlanPositionDetails queryOneTimeTransactionStatus querySubscriptionTransactionHistory

Constructors

constructor

new TradeApi(configuration: ConfigurationRestAPI): AutoInvestRestAPI.TradeApi
Parameters
- configuration: ConfigurationRestAPI
Returns AutoInvestRestAPI.TradeApi
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1456

Methods

changePlanStatus

changePlanStatus(
requestParameters: ChangePlanStatusRequest,
): Promise<RestApiResponse<ChangePlanStatusResponse>>
Change Plan Status

max one request every 3s per account

Weight: 1
Parameters
- requestParameters: ChangePlanStatusRequest
  Request parameters.
Returns Promise<RestApiResponse<ChangePlanStatusResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.changePlanStatus
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1475

indexLinkedPlanRebalanceDetails

indexLinkedPlanRebalanceDetails(
requestParameters?: IndexLinkedPlanRebalanceDetailsRequest,
): Promise<RestApiResponse<IndexLinkedPlanRebalanceDetailsResponse>>
Get the history of Index Linked Plan Redemption transactions

Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records

Weight: 1
Parameters
- requestParameters: IndexLinkedPlanRebalanceDetailsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<IndexLinkedPlanRebalanceDetailsResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.indexLinkedPlanRebalanceDetails
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1508

indexLinkedPlanRedemption

indexLinkedPlanRedemption(
requestParameters: IndexLinkedPlanRedemptionRequest,
): Promise<RestApiResponse<IndexLinkedPlanRedemptionResponse>>
To redeem index-Linked plan holdings

Weight: 1
Parameters
- requestParameters: IndexLinkedPlanRedemptionRequest
  Request parameters.
Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.indexLinkedPlanRedemption
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1541

indexLinkedPlanRedemptionTrade

indexLinkedPlanRedemptionTrade(
requestParameters: IndexLinkedPlanRedemptionTradeRequest,
): Promise<RestApiResponse<IndexLinkedPlanRedemptionTradeResponse>>
Get the history of Index Linked Plan Redemption transactions

Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records

Weight: 1
Parameters
- requestParameters: IndexLinkedPlanRedemptionTradeRequest
  Request parameters.
Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionTradeResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.indexLinkedPlanRedemptionTrade
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1575

investmentPlanAdjustment

investmentPlanAdjustment(
requestParameters: InvestmentPlanAdjustmentRequest,
): Promise<RestApiResponse<InvestmentPlanAdjustmentResponse>>
Query Source Asset to be used for investment

max one request every 3s per account

Weight: 1
Parameters
- requestParameters: InvestmentPlanAdjustmentRequest
  Request parameters.
Returns Promise<RestApiResponse<InvestmentPlanAdjustmentResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.investmentPlanAdjustment
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1612

investmentPlanCreation

investmentPlanCreation(
requestParameters: InvestmentPlanCreationRequest,
): Promise<RestApiResponse<InvestmentPlanCreationResponse>>
Post an investment plan creation

max one request every 3s per account

Weight: 1
Parameters
- requestParameters: InvestmentPlanCreationRequest
  Request parameters.
Returns Promise<RestApiResponse<InvestmentPlanCreationResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.investmentPlanCreation
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1649

oneTimeTransaction

oneTimeTransaction(
requestParameters: OneTimeTransactionRequest,
): Promise<RestApiResponse<OneTimeTransactionResponse>>
One time transaction

planId/planId/details must not all be null

Weight: 1
Parameters
- requestParameters: OneTimeTransactionRequest
  Request parameters.
Returns Promise<RestApiResponse<OneTimeTransactionResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.oneTimeTransaction
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1689

queryHoldingDetailsOfThePlan

queryHoldingDetailsOfThePlan(
requestParameters?: QueryHoldingDetailsOfThePlanRequest,
): Promise<RestApiResponse<QueryHoldingDetailsOfThePlanResponse>>
Query holding details of the plan

Weight: 1
Parameters
- requestParameters: QueryHoldingDetailsOfThePlanRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<QueryHoldingDetailsOfThePlanResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.queryHoldingDetailsOfThePlan
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1725

queryIndexLinkedPlanPositionDetails

queryIndexLinkedPlanPositionDetails(
requestParameters: QueryIndexLinkedPlanPositionDetailsRequest,
): Promise<RestApiResponse<QueryIndexLinkedPlanPositionDetailsResponse>>
Details on users Index-Linked plan position details

Weight: 1
Parameters
- requestParameters: QueryIndexLinkedPlanPositionDetailsRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryIndexLinkedPlanPositionDetailsResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.queryIndexLinkedPlanPositionDetails
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1755

queryOneTimeTransactionStatus

queryOneTimeTransactionStatus(
requestParameters: QueryOneTimeTransactionStatusRequest,
): Promise<RestApiResponse<QueryOneTimeTransactionStatusResponse>>
Transaction status for one-time transaction

Weight: 1
Parameters
- requestParameters: QueryOneTimeTransactionStatusRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryOneTimeTransactionStatusResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.queryOneTimeTransactionStatus
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1785

querySubscriptionTransactionHistory

querySubscriptionTransactionHistory(
requestParameters?: QuerySubscriptionTransactionHistoryRequest,
): Promise<RestApiResponse<QuerySubscriptionTransactionHistoryResponse>>
Query subscription transaction history of a plan

Max span between startTime and endTime is 30days If both startTime and endTime are null，then default is 30days

Weight: 1
Parameters
- requestParameters: QuerySubscriptionTransactionHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<QuerySubscriptionTransactionHistoryResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.querySubscriptionTransactionHistory
- Defined in clients/auto-invest/src/rest-api/modules/trade-api.ts:1820

Class TradeApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AutoInvestRestAPI.TradeApi

Methods

changePlanStatus

Parameters

Returns Promise<RestApiResponse<ChangePlanStatusResponse>>

Throws

Memberof

See

indexLinkedPlanRebalanceDetails

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRebalanceDetailsResponse>>

Throws

Memberof

See

indexLinkedPlanRedemption

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionResponse>>

Throws

Memberof

See

indexLinkedPlanRedemptionTrade

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionTradeResponse>>

Throws

Memberof

See

investmentPlanAdjustment

Parameters

Returns Promise<RestApiResponse<InvestmentPlanAdjustmentResponse>>

Throws

Memberof

See

investmentPlanCreation

Parameters

Returns Promise<RestApiResponse<InvestmentPlanCreationResponse>>

Throws

Memberof

See

oneTimeTransaction

Parameters

Returns Promise<RestApiResponse<OneTimeTransactionResponse>>

Throws

Memberof

See

queryHoldingDetailsOfThePlan

Parameters

Returns Promise<RestApiResponse<QueryHoldingDetailsOfThePlanResponse>>

Throws

Memberof

See

queryIndexLinkedPlanPositionDetails

Parameters

Returns Promise<RestApiResponse<QueryIndexLinkedPlanPositionDetailsResponse>>

Throws

Memberof

See

queryOneTimeTransactionStatus

Parameters

Returns Promise<RestApiResponse<QueryOneTimeTransactionStatusResponse>>

Throws

Memberof

See

querySubscriptionTransactionHistory

Parameters

Returns Promise<RestApiResponse<QuerySubscriptionTransactionHistoryResponse>>

Throws

Memberof

See

Settings

On This Page