[GH-ISSUE #1384] [Feature] Implement RESTful API so that I can integrate with Home Automation or other home server tools #7461

Closed
opened 2026-04-10 17:18:17 -05:00 by GiteaMirror · 4 comments
Owner

Originally created by @faspina on GitHub (Jul 21, 2023).
Original GitHub issue: https://github.com/actualbudget/actual/issues/1384

Verified feature request does not already exist?

  • I have searched and found no existing issue

💻

  • Would you like to implement this feature?

Pitch: what problem are you trying to solve?

Restful API with token so that I can push and pull data utilizing home automation and other local server apps that I have.

Describe your ideal solution to this problem

Set of Restful API calls.
PutTransaction
GetTransaction
etc.

Teaching and learning

No response

Originally created by @faspina on GitHub (Jul 21, 2023). Original GitHub issue: https://github.com/actualbudget/actual/issues/1384 ### Verified feature request does not already exist? - [X] I have searched and found no existing issue ### 💻 - [ ] Would you like to implement this feature? ### Pitch: what problem are you trying to solve? Restful API with token so that I can push and pull data utilizing home automation and other local server apps that I have. ### Describe your ideal solution to this problem Set of Restful API calls. PutTransaction GetTransaction etc. ### Teaching and learning _No response_
GiteaMirror added the needs votesfeatureAPI labels 2026-04-10 17:18:17 -05:00
Author
Owner

@github-actions[bot] commented on GitHub (Jul 21, 2023):

Thanks for sharing your idea!

This repository uses lodash style issue management for enhancements. That means enhancement issues are automatically closed. This doesn’t mean we don’t accept feature requests, though! We will consider implementing ones that receive many upvotes, and we welcome contributions for any feature requests marked as needing votes (just post a comment first so we can help you make a successful contribution).

The enhancement backlog can be found here: https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+

Don’t forget to upvote the top comment with 👍!

<!-- gh-comment-id:1646324998 --> @github-actions[bot] commented on GitHub (Jul 21, 2023): :sparkles: Thanks for sharing your idea! :sparkles: This repository uses lodash style issue management for enhancements. That means enhancement issues are automatically closed. This doesn’t mean we don’t accept feature requests, though! We will consider implementing ones that receive many upvotes, and we welcome contributions for any feature requests marked as needing votes (just post a comment first so we can help you make a successful contribution). The enhancement backlog can be found here: https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+ Don’t forget to upvote the top comment with 👍! <!-- feature-auto-close-comment -->
Author
Owner

@j-f1 commented on GitHub (Jul 21, 2023):

We’ve discussed doing this before, but it’s complicated by the way Actual runs — the server doesn’t actually have the ability to open up a budget file and view/make changes to it. Additionally, budget files take a nonzero amount of time to open, sync, and close so any API would likely have disappointing performance or be very tricky/un-RESTful to use.

I think your best option would be to run your own program that uses our existing JS API package to respond to requests and make any modifications to the budget that are requested.

<!-- gh-comment-id:1646344171 --> @j-f1 commented on GitHub (Jul 21, 2023): We’ve discussed doing this before, but it’s complicated by the way Actual runs — the server doesn’t actually have the ability to open up a budget file and view/make changes to it. Additionally, budget files take a nonzero amount of time to open, sync, and close so any API would likely have disappointing performance or be very tricky/un-RESTful to use. I think your best option would be to run your own program that uses our existing JS API package to respond to requests and make any modifications to the budget that are requested.
Author
Owner

@jhonderson commented on GitHub (Sep 1, 2023):

I created a project to achieve something similar, an Actual http api: https://github.com/jhonderson/actual-http-api.

It has the following limitations, but for common uses cases (self-hosted, single Actual server, non concurrent access) it should be sufficient:

  1. A running instance is tied to a single Actual server
  2. It doesn’t support accessing multiple budgets concurrently
<!-- gh-comment-id:1703296660 --> @jhonderson commented on GitHub (Sep 1, 2023): I created a project to achieve something similar, an Actual http api: https://github.com/jhonderson/actual-http-api. It has the following limitations, but for common uses cases (self-hosted, single Actual server, non concurrent access) it should be sufficient: 1. A running instance is tied to a single Actual server 2. It doesn’t support accessing multiple budgets concurrently
Author
Owner

@faspina commented on GitHub (Sep 1, 2023):

This is cool, I will give it a try.

<!-- gh-comment-id:1703308683 --> @faspina commented on GitHub (Sep 1, 2023): This is cool, I will give it a try.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#7461