Module: AutoInvest

API auto-invest endpoints

Parameters:

Name	Type	Description
`superclass`	*

Source: restful/autoInvest.js, line 5

Methods

changePlanStatus(planId, status, optionsopt)

Change Plan Status

POST /sapi/v1/lending/auto-invest/plan/edit-status

https://developers.binance.com/docs/auto_invest/trade/Change-Plan-Status

Parameters:

Name Type Attributes Description

planId number

status Status

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 111

getListOfPlans(planType, optionsopt)

Get list of plans

GET /sapi/v1/lending/auto-invest/plan/list

https://developers.binance.com/docs/auto_invest/market-data/Get-list-of-plans

Parameters:

Name Type Attributes Description

planType string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 134

getTargetAssetList(optionsopt)

Get target asset list (USER_DATA)

GET /sapi/v1/lending/auto-invest/target-asset/list

https://developers.binance.com/docs/auto_invest/market-data/Get-target-asset-list

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`targetAsset`	string	<optional>
`size`	number	<optional>	Default:10 Max:100
`current`	number	<optional>	Current querying page. Start from 1. Default:1
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 24

getTargetAssetRoiData(targetAsset, hisRoiType, optionsopt)

Get target asset ROI data (USER_DATA)

GET /sapi/v1/lending/auto-invest/target-asset/roi/list

https://developers.binance.com/docs/auto_invest/market-data/Get-target-asset-ROI-data

Parameters:

Name Type Attributes Description

targetAsset string

hisRoiType string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 44

indexLinkedPlanRebalanceDetails(optionsopt)

Index Linked Plan Rebalance Details (USER_DATA)

GET /sapi/v1/lending/auto-invest/rebalance/history

https://developers.binance.com/docs/auto_invest/trade/Index-Linked-Plan-Rebalance-Details

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>	UTC timestamp in ms
`endTime`	number	<optional>	UTC timestamp in ms
`current`	number	<optional>	Current querying page. Start from 1. Default:1
`size`	number	<optional>	Default:10 Max:100
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 323

indexLinkedPlanRedemption(indexId, redemptionPercentage, optionsopt)

Index Linked Plan Redemption (TRADE)

POST /sapi/v1/lending/auto-invest/redeem

https://developers.binance.com/docs/auto_invest/trade/Index-Linked-Plan-Redemption

Parameters:

Name Type Attributes Description

indexId

number

PORTFOLIO plan's Id

redemptionPercentage

number

user redeem percentage,10/20/100.

options

object

Properties

Name	Type	Attributes	Description
`requestId`	string	<optional>	sourceType + unique, transactionId and requestId cannot be empty at the same time
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 270

indexLinkedPlanRedemptionHistory(requestId, optionsopt)

Index Linked Plan Redemption History (USER_DATA)

GET /sapi/v1/lending/auto-invest/redeem/history

https://developers.binance.com/docs/auto_invest/trade/Query-Index-Linked-Plan-Redemption

Parameters:

Name Type Attributes Description

requestId number

options

object

Properties

Name	Type	Attributes	Description
`startTime`	number	<optional>	UTC timestamp in ms
`endTime`	number	<optional>	UTC timestamp in ms
`current`	number	<optional>	Current querying page. Start from 1. Default:1
`asset`	string	<optional>
`size`	number	<optional>	Default:10 Max:100
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 298

queryAllSourceAssetAndTargetAsset(optionsopt)

Query all source asset and target asset (USER_DATA)

GET /sapi/v1/lending/auto-invest/all/asset

https://developers.binance.com/docs/auto_invest/market-data/Query-all-source-asset-and-target-asset

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 66

queryHoldingDetailsOfThePlan(optionsopt)

Query holding details of the plan

GET /sapi/v1/lending/auto-invest/plan/id

https://developers.binance.com/docs/auto_invest/trade/Query-holding-details-of-the-plan

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`planId`	number	<optional>
`requestId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 157

queryIndexDetails(indexId, optionsopt)

Query Index Details (USER_DATA)

GET /sapi/v1/lending/auto-invest/index/info

https://developers.binance.com/docs/auto_invest/market-data/Query-Index-Details

Parameters:

Name Type Attributes Description

indexId number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 201

queryIndexLinkedPlanPositionDetails(indexId, optionsopt)

Query Index Linked Plan Position Details (USER_DATA)

GET /sapi/v1/lending/auto-invest/index/user-summary

https://developers.binance.com/docs/auto_invest/trade/Query-Index-Linked-Plan-Position-Details

Parameters:

Name Type Attributes Description

indexId number

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 223

queryOnetimeTransactionStatus(transactionId, optionsopt)

Query One-Time Transaction Status (USER_DATA)

GET /sapi/v1/lending/auto-invest/one-off/status

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

Parameters:

Name Type Attributes Description

transactionId number

options

object

Properties

Name	Type	Attributes	Description
`requestId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 246

querySourceAssetList(usageType, optionsopt)

Query source asset list (USER_DATA)

GET /sapi/v1/lending/auto-invest/source-asset/list

https://developers.binance.com/docs/auto_invest/market-data/Query-source-asset-list

Parameters:

Name Type Attributes Description

usageType string

options

object

Properties

Name	Type	Attributes	Description
`targetAsset`	string	<optional>
`indexId`	number	<optional>
`flexibleAllowedToUse`	boolean	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 88

querySubscriptionTransactionHistory(optionsopt)

Query subscription transaction history

GET /sapi/v1/lending/auto-invest/history/list

https://developers.binance.com/docs/auto_invest/trade/Query-subscription-transaction-history

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`planId`	number	<optional>
`startTime`	number	<optional>	UTC timestamp in ms
`endTime`	number	<optional>	UTC timestamp in ms
`targetAsset`	number	<optional>
`planType`	PlanType	<optional>
`size`	number	<optional>	Default:10 Max:100
`current`	number	<optional>	Current querying page. Start from 1. Default:1
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/autoInvest.js, line 182