Class RestAPI

Constructors

constructor

new RestAPI(configuration: ConfigurationRestAPI): AutoInvestRestAPI.RestAPI
Parameters
- configuration: ConfigurationRestAPI
Returns AutoInvestRestAPI.RestAPI
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:67

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:224

getListOfPlans

getListOfPlans(
requestParameters: GetListOfPlansRequest,
): Promise<RestApiResponse<GetListOfPlansResponse>>
Query plan lists

max one request every 3s per account

Weight: 1
Parameters
- requestParameters: GetListOfPlansRequest
  Request parameters.
Returns Promise<RestApiResponse<GetListOfPlansResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:120

getTargetAssetList

getTargetAssetList(
requestParameters?: GetTargetAssetListRequest,
): Promise<RestApiResponse<GetTargetAssetListResponse>>
Get target asset list

Weight: 1
Parameters
- requestParameters: GetTargetAssetListRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetTargetAssetListResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:137

getTargetAssetRoiData

getTargetAssetRoiData(
requestParameters: GetTargetAssetRoiDataRequest,
): Promise<RestApiResponse<GetTargetAssetRoiDataResponse>>
ROI return list for target asset

Weight: 1
Parameters
- requestParameters: GetTargetAssetRoiDataRequest
  Request parameters.
Returns Promise<RestApiResponse<GetTargetAssetRoiDataResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:154

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:244

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:261

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:281

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:300

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:319

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:338

queryAllSourceAssetAndTargetAsset

queryAllSourceAssetAndTargetAsset(
requestParameters?: QueryAllSourceAssetAndTargetAssetRequest,
): Promise<RestApiResponse<QueryAllSourceAssetAndTargetAssetResponse>>
Query all source assets and target assets

Weight: 1
Parameters
- requestParameters: QueryAllSourceAssetAndTargetAssetRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<QueryAllSourceAssetAndTargetAssetResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:171

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:355

queryIndexDetails

queryIndexDetails(
requestParameters: QueryIndexDetailsRequest,
): Promise<RestApiResponse<QueryIndexDetailsResponse>>
Query index details

Weight: 1
Parameters
- requestParameters: QueryIndexDetailsRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryIndexDetailsResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:188

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:372

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:389

querySourceAssetList

querySourceAssetList(
requestParameters: QuerySourceAssetListRequest,
): Promise<RestApiResponse<QuerySourceAssetListResponse>>
Query Source Asset to be used for investment

Weight: 1
Parameters
- requestParameters: QuerySourceAssetListRequest
  Request parameters.
Returns Promise<RestApiResponse<QuerySourceAssetListResponse>>
Throws
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:205

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
See
Binance API Documentation
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:410

sendRequest

sendRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    params?: Record<string, unknown>,
): Promise<RestApiResponse<T>>
Generic function to send a request.
Type Parameters
- T
Parameters
- endpoint: string
  The API endpoint to call.
- method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"
  HTTP method to use (GET, POST, DELETE, etc.).
- params: Record<string, unknown> = {}
  Query parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:81

sendSignedRequest

sendSignedRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    params?: Record<string, unknown>,
): Promise<RestApiResponse<T>>
Generic function to send a signed request.
Type Parameters
- T
Parameters
- endpoint: string
  The API endpoint to call.
- method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"
  HTTP method to use (GET, POST, DELETE, etc.).
- params: Record<string, unknown> = {}
  Query parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/auto-invest/src/rest-api/rest-api.ts:97

Class RestAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AutoInvestRestAPI.RestAPI

Methods

changePlanStatus

Parameters

Returns Promise<RestApiResponse<ChangePlanStatusResponse>>

Throws

See

getListOfPlans

Parameters

Returns Promise<RestApiResponse<GetListOfPlansResponse>>

Throws

See

getTargetAssetList

Parameters

Returns Promise<RestApiResponse<GetTargetAssetListResponse>>

Throws

See

getTargetAssetRoiData

Parameters

Returns Promise<RestApiResponse<GetTargetAssetRoiDataResponse>>

Throws

See

indexLinkedPlanRebalanceDetails

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRebalanceDetailsResponse>>

Throws

See

indexLinkedPlanRedemption

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionResponse>>

Throws

See

indexLinkedPlanRedemptionTrade

Parameters

Returns Promise<RestApiResponse<IndexLinkedPlanRedemptionTradeResponse>>

Throws

See

investmentPlanAdjustment

Parameters

Returns Promise<RestApiResponse<InvestmentPlanAdjustmentResponse>>

Throws

See

investmentPlanCreation

Parameters

Returns Promise<RestApiResponse<InvestmentPlanCreationResponse>>

Throws

See

oneTimeTransaction

Parameters

Returns Promise<RestApiResponse<OneTimeTransactionResponse>>

Throws

See

queryAllSourceAssetAndTargetAsset

Parameters

Returns Promise<RestApiResponse<QueryAllSourceAssetAndTargetAssetResponse>>

Throws

See

queryHoldingDetailsOfThePlan

Parameters

Returns Promise<RestApiResponse<QueryHoldingDetailsOfThePlanResponse>>

Throws

See

queryIndexDetails

Parameters

Returns Promise<RestApiResponse<QueryIndexDetailsResponse>>

Throws

See

queryIndexLinkedPlanPositionDetails

Parameters

Returns Promise<RestApiResponse<QueryIndexLinkedPlanPositionDetailsResponse>>

Throws

See

queryOneTimeTransactionStatus