<a href="https://www.openledger.com/contact" target="_blank">We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀</a>
Get a demoPostman Collection
GuideReact SDKAPI Reference
GuideReact SDKAPI Reference
  • API Overview
    • Reference
    • Authentication
    • Rate Limits
    • Pagination
We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀
LogoLogo
Get a demoPostman Collection
API OverviewAPI EndpointsTransactions

GET
/v1/transactions/recurring
GET
/v1/transactions/recurring
1curl -G https://api-staging.openledger.com/v1/transactions/recurring \
2 -H "Authorization: Bearer <token>" \
3 -d entityId=entityId
Try it
200Retrieved
1{
2 "inflow_streams": [
3 {
4 "stream_id": "string",
5 "account_id": "string",
6 "merchant_name": "string",
7 "description": "string",
8 "frequency": "WEEKLY",
9 "category": [
10 "string"
11 ],
12 "last_amount": {
13 "amount": 1.1,
14 "currency": "string"
15 },
16 "average_amount": {
17 "amount": 1.1,
18 "currency": "string"
19 },
20 "is_active": true,
21 "last_date": "2023-01-15",
22 "first_date": "2023-01-15",
23 "confidence": 1.1,
24 "status": "ACTIVE",
25 "next_expected_date": "2023-01-15",
26 "transactions": [
27 {
28 "id": "string",
29 "timestamp": "2024-01-15T09:30:00Z",
30 "amount": 1.1,
31 "currency": "string",
32 "description": "string",
33 "status": "string",
34 "debit_account": {
35 "id": "string",
36 "name": "string",
37 "type": "string"
38 },
39 "credit_account": {
40 "id": "string",
41 "name": "string",
42 "type": "string"
43 },
44 "vendor": {
45 "id": "string",
46 "name": "string",
47 "category": "string"
48 },
49 "plaid_account": {
50 "id": "string",
51 "account_name": "string",
52 "account_type": "string",
53 "account_mask": "string"
54 },
55 "metadata": {}
56 }
57 ]
58 }
59 ],
60 "outflow_streams": [
61 null
62 ],
63 "total_inflow_streams": 1,
64 "total_outflow_streams": 1,
65 "summary": {
66 "total_transactions_analyzed": 1,
67 "analysis_period": {
68 "start_date": "2023-01-15",
69 "end_date": "2023-01-15",
70 "days_analyzed": 1
71 },
72 "patterns_found": 1,
73 "confidence_threshold": 1.1,
74 "processing_time_ms": 1
75 }
76}
Was this page helpful?
Previous

Get recurring transaction templates

Next
Built with
Detect and retrieve recurring transaction patterns for an entity with detailed transaction history
Get recurring transactions

Authentication

AuthorizationBearer

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
confidenceThresholddoubleOptional0-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

Whether to include inactive recurring streams
Recurring transaction streams detected successfully

Minimum confidence score for pattern detection (0.0-1.0)