Walletguide
DevelopersAPIReferencescenarios

List scenarios

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

GET
/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

Response Body

application/json

curl -X GET "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenarios"
[  {    "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"  }]

CounterTransaction

Reads the source position, builds the mirror transaction in the target asset (amount negated / holding total price, FX-converted into the asset currency…

Create scenario

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