Walletguide
DevelopersAPIReferencescenarios

Create scenario

Create a scenario with the Walletguide REST API. Parameters, response fields, and a playground you can run.

POST
/wallets/{walletId}/scenarios

Authorization

bearerAuth
Authorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

In: header

Path Parameters

walletId*string

Row uuid

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenarios" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "startDate": "string",    "expectedAnnualReturn": 0  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",  "firestoreId": "string",  "name": "string",  "startDate": "string",  "endMonth": "string",  "startingBasePerCategory": "string",  "expectedAnnualReturn": -140737488355328,  "assetIds": [    "96fa1cd8-4f1c-475e-ac07-c52694e711b7"  ],  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

List scenarios

List a wallet's scenarios with the Walletguide REST API. Parameters, response fields, and a playground you can run.

Retrieve scenario

Retrieve one scenario by id with the Walletguide REST API. Parameters, response fields, and a playground you can run.