Skip to main content

Get list of plans (USER_DATA)

API Description#

Query plan lists

HTTP Request#

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

Request Weight(IP)#

1

Request Parameters#

NameTypeMandatoryDescription
planTypeSTRINGYESPlan identifier
recvWindowLONGNOno more than 60000
timestampLONGYES
  • max one request every 3s per account

Response Example#

SINGLE/PORTFOLIO

{        "planValueInUSD": "123",        "planValueInBTC":"0.1",        "pnlInUSD":"120",        "roi":"2.3",        "plans": [            {                "planId": 12345,                "planType": "SINGLE",                "editAllowed": "true",                "creationDateTime": 1648378800000,                "firstExecutionDateTime": 1648378800000, //first subscription date time                "nextExecutionDateTime": 1648378800000,                "status": "ONGOING", // ONGOING,PAUSED                "lastUpdatedDateTime": 1648378800000,                "targetAsset": "BTC",                "totalTargetAmount":"0.111",                "sourceAsset": "BUSD",                "totalInvestedInUSD":"4.555",                "subscriptionAmount": "0.1",                "subscriptionCycle": "WEEKLY",                "subscriptionStartDay": null,                "subscriptionStartWeekday" : "MON",                "subscriptionStartTime": "1",                "sourceWallet": "SPOT_WALLET",                "flexibleAllowedToUse": "false",                "planValueInUSD": "101.2",                "pnlInUSD": "101.2",                "roi": "1.02"            }        ]} 

OR INDEX

{    "planValueInUSD": "123",    "planValueInBTC": "0.1",     "plans": [        {            "planId": 12345,            "planType": "INDEX",            "editAllowed": "true",            "creationDateTime": 1648378800000,            "firstExecutionDateTime": 1648378800000, //first subscription date time            "nextExecutionDateTime": 1648378800000,            "status": "ONGOING",            "lastUpdatedDateTime": 1648378800000,            "targetAsset": "BTC",            "sourceAsset": "BUSD",            "totalInvestedInUSD":"4.555",            "subscriptionAmount": "0.1",            "subscriptionCycle": "DAILY",            "subscriptionStartDay": "1",            "subscriptionStartWeekday" : null,            "subscriptionStartTime": "2",            "sourceWallet": "SPOT",            "flexibleAllowedToUse": "false",                     }    ]}