Get recurring transactions

Detect and retrieve recurring transaction patterns for an entity with detailed transaction history

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
The ID of the entity to analyze for recurring patterns
analysisWindowDaysintegerOptional<=365Defaults to 180
Number of days to look back for analysis
confidenceThresholddoubleOptional>=0<=1Defaults to 0.65

Minimum confidence score for pattern detection (0.0-1.0)

includeInactivebooleanOptionalDefaults to false
Whether to include inactive recurring streams

Response

Recurring transaction streams detected successfully
inflow_streamslist of objects or null

Detected recurring inflow patterns (income)

outflow_streamslist of any or null

Detected recurring outflow patterns (expenses/subscriptions)

total_inflow_streamsinteger or null
Count of detected inflow streams
total_outflow_streamsinteger or null
Count of detected outflow streams
summaryobject or null

Errors