Return computed changes between current and comparison records.

Compare recorded posted spending and income totals in explicit inclusive date ranges. Supply all four dates to override the default months, since, until, comparison_since, and comparison_until. These totals are not normalized rates or proof of complete provider history. Capped evidence suppresses transaction comparisons. Without ranges the last complete UTC calendar month is compared with the preceding month; the response reports both date ranges.

get/v1/changes

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/changes
  • Auth: HTTP bearer

Query parameters

domain'all' | 'spending' | 'income' | 'recurring' | 'account_terms' | 'investments'

Restrict to one change domain; omitted or all includes every supported domain.

account_identity_idstring

Restrict changes to one durable account identity before applying history caps. This scope applies to every domain; for investments it reads that account's own position observations, so a busy vault cannot crowd the account out of the capped read.

limitinteger

Maximum change items to return, from 1 to 1000; defaults to 25. Only trims output, never the comparison evidence.

sincestring

Inclusive start of the current range (YYYY-MM-DD). Supply all four range dates for spending or income comparisons.

untilstring

Inclusive end of the current range (YYYY-MM-DD).

comparison_sincestring

Inclusive start of the comparison range (YYYY-MM-DD).

comparison_untilstring

Inclusive end of the comparison range (YYYY-MM-DD).

Response

Envelope with change items, caveats, basis handles, and drilldown commands.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.