Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.youneedabudget.com/v1
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com
| method | path | what the vendor says it does |
|---|---|---|
GET | /budgets | List budgets Returns budgets list with summary information Budgets |
GET | /budgets/{budget_id} | Single budget Returns a single budget with all related entities. This resource is effectively a full budget e |
GET | /budgets/{budget_id}/accounts | Account list Returns all accounts Accounts |
POST | /budgets/{budget_id}/accounts | Create a new account Creates a new account Accounts |
GET | /budgets/{budget_id}/accounts/{account_id} | Single account Returns a single account Accounts |
GET | /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions Returns all transactions for a specified account Transactions |
GET | /budgets/{budget_id}/categories | List categories Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) |
GET | /budgets/{budget_id}/categories/{category_id} | Single category Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the cu |
GET | /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions Returns all transactions for a specified category Transactions |
GET | /budgets/{budget_id}/months | List budget months Returns all budget months Months |
GET | /budgets/{budget_id}/months/{month} | Single budget month Returns a single budget month Months |
GET | /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month Returns a single category for a specific budget month. Amounts (b |
PATCH | /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month Update a category for a specific month. Only `budgeted` amount can be |
GET | /budgets/{budget_id}/payee_locations | List payee locations Returns all payee locations Payee Locations |
GET | /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location Returns a single payee location Payee Locations |
GET | /budgets/{budget_id}/payees | List payees Returns all payees Payees |
GET | /budgets/{budget_id}/payees/{payee_id} | Single payee Returns a single payee Payees |
GET | /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee Returns all payee locations for a specified payee Payee Locations |
GET | /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions Returns all transactions for a specified payee Transactions |
GET | /budgets/{budget_id}/scheduled_transactions | List scheduled transactions Returns all scheduled transactions Scheduled Transactions |
GET | /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction Returns a single scheduled transaction Scheduled Transactions |
GET | /budgets/{budget_id}/settings | Budget Settings Returns settings for a budget Budgets |
GET | /budgets/{budget_id}/transactions | List transactions Returns budget transactions Transactions |
POST | /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions Creates a single transaction or multiple transactions. I |
PATCH | /budgets/{budget_id}/transactions | Update multiple transactions Updates multiple transactions, by `id` or `import_id`. Transactions |
POST | /budgets/{budget_id}/transactions/bulk | Bulk create transactions Creates multiple transactions. Although this endpoint is still supported, it is reco |
POST | /budgets/{budget_id}/transactions/import | Import transactions Imports available transactions on all linked accounts for the given budget. Linked accoun |
GET | /budgets/{budget_id}/transactions/{transaction_id} | Single transaction Returns a single transaction Transactions |
PUT | /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction Updates a single transaction Transactions |
DELETE | /budgets/{budget_id}/transactions/{transaction_id} | Deletes an existing transaction Deletes a transaction Transactions |
GET | /user | User info Returns authenticated user information User |
specification origin: https://api.youneedabudget.com/papi/spec-v1-swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.