Similar Transactions API
monetr groups transactions that look alike into clusters. Every coffee from the same shop, every paycheck from the same
employer, that kind of thing. It's how monetr spots recurring spending. A background job builds the clusters, so a
brand new transaction won't be in one until that job gets to it.
Each transaction has a transactionClusterId that tells you which cluster it's
in. It's null when the transaction isn't in one, which is normal for anything one-off.
The similar transaction object
If a cluster falls apart completely it gets deleted. Its ID stops working and the transactions that were in it go back
to a null transactionClusterId.
History
v1.17.0
- Removed
members. Use List similar transactions to get the transactions in a cluster.
- Added
originalMemo.
- Deprecated
signature.
originalName is now refreshed every time the clusters are recalculated, instead of only when the cluster is created.- Cluster IDs now stay the same between recalculations as long as enough of the same transactions stay in the cluster.
GET Get similar transactions
Returns one cluster. You'll usually get the ID from a transaction's transactionClusterId.
In the app: Nothing in the app calls this yet.
GET /api/bank_accounts/:bankAccountId/similar/:transactionClusterId
Auth: API key, subscription required.
Path parameters
Example
curl --request GET \
--url "https://my.monetr.local/api/bank_accounts/bac_01gds6eqsq7h5mgevwtmw3cyxb/similar/tcl_01j6a2mkxw5rt8p9e3vqn7hd4c" \
--user "$MONETR_API_KEY_ID:$MONETR_API_KEY_SECRET"
{
"transactionClusterId": "tcl_01j6a2mkxw5rt8p9e3vqn7hd4c",
"bankAccountId": "bac_01gds6eqsq7h5mgevwtmw3cyxb",
"signature": "9f2c4e81b07a3d56c8e1f09a4b7d2e63a5c8f1b0d94e7a2c36b5f8e0a1d4c7b9",
"centroid": "txn_01j68vszqeq30t7jz7atk9yd9r",
"name": "RUBY COFFEE ROASTERS",
"originalName": "RUBY COFFEE ROASTERS",
"originalMemo": "SQ *RUBY COFFEE ROASTERS",
"debug": [
{
"word": "RUBY",
"sanitized": "ruby",
"order": 2,
"value": 0.48,
"rank": 1,
"count": 3
}
],
"merchant": [],
"createdAt": "2024-08-27T03:15:02.881Z",
"updatedAt": "2024-08-30T03:15:04.127Z"
}
Errors
GET List similar transactions
Returns the transactions in a cluster, newest first. This is how you get the transactions that look like one you already
have: take its transactionClusterId and ask for the rest of the cluster.
In the app: The similar transactions panel on the transaction details page. It only asks for the first 10.
GET /api/bank_accounts/:bankAccountId/similar/:transactionClusterId/transactions
Auth: API key, subscription required.
Path parameters
Query parameters
Example
curl --request GET \
--url "https://my.monetr.local/api/bank_accounts/bac_01gds6eqsq7h5mgevwtmw3cyxb/similar/tcl_01j6a2mkxw5rt8p9e3vqn7hd4c/transactions?limit=2" \
--user "$MONETR_API_KEY_ID:$MONETR_API_KEY_SECRET"
[
{
"transactionId": "txn_01j68vszqeq30t7jz7atk9yd9r",
"bankAccountId": "bac_01gds6eqsq7h5mgevwtmw3cyxb",
"plaidTransaction": null,
"pendingPlaidTransaction": null,
"transactionClusterId": "tcl_01j6a2mkxw5rt8p9e3vqn7hd4c",
"amount": 685,
"spendingId": "spnd_01fpwx67z8djhb8bqcy17mrzfe",
"spendingAmount": 685,
"createdBySpendingId": null,
"createdByFundingScheduleId": null,
"categories": ["Food and Drink", "Coffee Shop"],
"category": "FOOD_AND_DRINK_COFFEE",
"date": "2024-08-27T05:00:00Z",
"name": "Ruby Coffee Roasters",
"originalName": "SQ *RUBY COFFEE ROASTERS",
"merchantName": "Ruby Coffee Roasters",
"originalMerchantName": "Ruby Coffee Roasters",
"isPending": false,
"uploadIdentifier": null,
"source": "plaid",
"createdAt": "2024-08-27T02:49:28.059Z",
"deletedAt": null
},
{
"transactionId": "txn_01j61k7dp3wc8xm2r9tzs4bnhy",
"bankAccountId": "bac_01gds6eqsq7h5mgevwtmw3cyxb",
"plaidTransaction": null,
"pendingPlaidTransaction": null,
"transactionClusterId": "tcl_01j6a2mkxw5rt8p9e3vqn7hd4c",
"amount": 540,
"spendingId": "spnd_01fpwx67z8djhb8bqcy17mrzfe",
"spendingAmount": 540,
"createdBySpendingId": null,
"createdByFundingScheduleId": null,
"categories": ["Food and Drink", "Coffee Shop"],
"category": "FOOD_AND_DRINK_COFFEE",
"date": "2024-08-24T05:00:00Z",
"name": "Ruby Coffee Roasters",
"originalName": "SQ *RUBY COFFEE ROASTERS",
"merchantName": "Ruby Coffee Roasters",
"originalMerchantName": "Ruby Coffee Roasters",
"isPending": false,
"uploadIdentifier": null,
"source": "plaid",
"createdAt": "2024-08-24T03:12:40.517Z",
"deletedAt": null
}
]
These are regular transaction objects. The transaction you started from is in
here too, so skip it yourself if you only want the others. Soft deleted transactions are left out. Same as the main
list, plaidTransaction is always null here, use Get a transaction if you need it.
A cluster ID that doesn't exist isn't an error here. You just get back an empty array.
Errors
GET Find similar transactions
Warning
This endpoint is deprecated and will be removed in a future release. Use the transaction's transactionClusterId with
Get similar transactions instead.
Returns the cluster a transaction is in, looked up by the transaction instead of the cluster.
In the app: Nothing in the app calls this.
GET /api/bank_accounts/:bankAccountId/transactions/:transactionId/similar
Auth: API key, subscription required.
Path parameters
Example
curl --request GET \
--url "https://my.monetr.local/api/bank_accounts/bac_01gds6eqsq7h5mgevwtmw3cyxb/transactions/txn_01j68vszqeq30t7jz7atk9yd9r/similar" \
--user "$MONETR_API_KEY_ID:$MONETR_API_KEY_SECRET"
You get back a similar transaction object, the same one Get similar
transactions returns.
History
Errors
