Walletguide
DevelopersAPIReferencedata

PeriodDetails

PeriodDetails (data endpoint) in the Walletguide REST API. Parameters, response fields, and a playground you can run.

POST
/wallets/{walletId}/data/periodDetails

Authorization

bearerAuth
headerAuthorization<token>

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

Path Parameters

walletId*string

The wallet id (row uuid)

Formatuuid

Request Body

application/json
  1. body
startDate*string

Inclusive window start (YYYY-MM-DD).

Match^\d{4}-\d{2}-\d{2}$
endDate*string

Inclusive window end (YYYY-MM-DD).

Match^\d{4}-\d{2}-\d{2}$
dateDefinition?string

Cash vs distributed accounting (default 'distributed').

Value in"cash""distributed"
requireCategoryAssignment?boolean

true = only categorized, false = only uncategorized, omitted = both.

categoryIds?array<string>

Restrict to these category ids.

categoryGroupIds?array<string>

Expanded server-side to their descendant category ids and merged into categoryIds.

categoryTypes?array<>

Restrict to these category types.

assetIds?array<string>

Restrict to these asset ids.

Response Body

periodDetails result

application/json
  1. response
amountByAssetId*
total*number
assetById*
Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/periodDetails' \  -H 'Content-Type: application/json' \  -d '{  "startDate": "string",  "endDate": "string"}'
Example Response
{  "amountByAssetId": {    "property1": 0,    "property2": 0  },  "total": 0,  "assetById": {    "property1": {      "name": "string",      "access": "fixed",      "assetGroupId": "string",      "archived": true,      "expectedAnnualReturn": 0,      "order": 0,      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "defaultCurrency": "EUR",      "defaultCategoryId": "string",      "type": "manualBank",      "accountNumber": "string",      "importSettings": {        "csv": null      },      "id": "string"    },    "property2": {      "name": "string",      "access": "fixed",      "assetGroupId": "string",      "archived": true,      "expectedAnnualReturn": 0,      "order": 0,      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "defaultCurrency": "EUR",      "defaultCategoryId": "string",      "type": "manualBank",      "accountNumber": "string",      "importSettings": {        "csv": null      },      "id": "string"    }  }}

NetWorthByAssetAccess

NetWorthByAssetAccess (data endpoint) in the Walletguide REST API. Parameters, response fields, and a playground you can run.

ProfitLoss

Whole-wallet figures need the permissions listed without assets:read; scoping the request with assetIds makes it a per-asset breakdown, which needs…