YNAB API Endpoints
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…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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
Endpoints 31
User
- GETUser info
/userReturns authenticated user information
Budgets
- GETList budgets
/budgets?include_accounts=trueReturns budgets list with summary information - GETSingle budget
/budgets/:budget_id?last_knowledge_of_server=0Returns a single budget with all related entities. This resource is effectively a full budget export. - GETBudget Settings
/budgets/:budget_id/settingsReturns settings for a budget
Accounts
- GETAccount list
/budgets/:budget_id/accounts?last_knowledge_of_server=0Returns all accounts - POSTCreate a new account
/budgets/:budget_id/accountsCreates a new account - GETSingle account
/budgets/:budget_id/accounts/:account_idReturns a single account
Categories
- GETList categories
/budgets/:budget_id/categories?last_knowledge_of_server=0Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). - GETSingle category
/budgets/:budget_id/categories/:category_idReturns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). - GETSingle category for a specific budget month
/budgets/:budget_id/months/:month/categories/:category_idReturns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). - PATCHUpdate a category for a specific month
/budgets/:budget_id/months/:month/categories/:category_idUpdate a category for a specific month. Only budgeted amount can be updated.
Payees
- GETList payees
/budgets/:budget_id/payees?last_knowledge_of_server=0Returns all payees - GETSingle payee
/budgets/:budget_id/payees/:payee_idReturns a single payee
Payee Locations
- GETList payee locations
/budgets/:budget_id/payee_locationsReturns all payee locations - GETSingle payee location
/budgets/:budget_id/payee_locations/:payee_location_idReturns a single payee location - GETList locations for a payee
/budgets/:budget_id/payees/:payee_id/payee_locationsReturns all payee locations for a specified payee
Months
- GETList budget months
/budgets/:budget_id/months?last_knowledge_of_server=0Returns all budget months - GETSingle budget month
/budgets/:budget_id/months/:monthReturns a single budget month
Transactions
- GETList account transactions
/budgets/:budget_id/accounts/:account_id/transactions?since_date=2024-01-01&type=uncategorized&last_knowledge_of_server=0Returns all transactions for a specified account - GETList category transactions
/budgets/:budget_id/categories/:category_id/transactions?since_date=2024-01-01&type=uncategorized&last_knowledge_of_server=0Returns all transactions for a specified category - GETList payee transactions
/budgets/:budget_id/payees/:payee_id/transactions?since_date=2024-01-01&type=uncategorized&last_knowledge_of_server=0Returns all transactions for a specified payee - GETList transactions
/budgets/:budget_id/transactions?since_date=2024-01-01&type=uncategorized&last_knowledge_of_server=0Returns budget transactions - POSTCreate a single transaction or multiple transactions
/budgets/:budget_id/transactionsCreates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you… - PATCHUpdate multiple transactions
/budgets/:budget_id/transactionsUpdates multiple transactions, by id or import_id. - POSTImport transactions
/budgets/:budget_id/transactions/importImports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified… - GETSingle transaction
/budgets/:budget_id/transactions/:transaction_idReturns a single transaction - PUTUpdates an existing transaction
/budgets/:budget_id/transactions/:transaction_idUpdates a single transaction - DELETEDeletes an existing transaction
/budgets/:budget_id/transactions/:transaction_idDeletes a transaction
Scheduled Transactions
- GETList scheduled transactions
/budgets/:budget_id/scheduled_transactions?last_knowledge_of_server=0Returns all scheduled transactions - GETSingle scheduled transaction
/budgets/:budget_id/scheduled_transactions/:scheduled_transaction_idReturns a single scheduled transaction
Deprecated
- POSTBulk create transactions
/budgets/:budget_id/transactions/bulkCreates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple…
API details
- Base URL
https://api.youneedabudget.com/v1- Authentication
- An API key in the Authorization header
- Operations
- 31 operations on 25 pathsGET 23POST 4PATCH 2PUT 1DELETE 1
- Main resources
- Transactions 10Categories 4Accounts 3Budgets 3Payee Locations 3Months 2Payees 2Scheduled Transactions 2Deprecated 1User 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the YNAB API Endpoints in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the YNAB API Endpoints collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “User info” (GET /user), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the YNAB API Endpoints?
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… It is listed under Finance & banking and has 31 endpoints.
Who publishes the YNAB API Endpoints?
It is listed from Youneedabudget's public API description (an OpenAPI document), not published by Youneedabudget on Swastik Codes. Anyone who controls youneedabudget.com can claim the profile by adding a DNS TXT record.
What is the base URL of the YNAB API Endpoints?
Requests go to https://api.youneedabudget.com/v1. Endpoint paths are added to this base URL.
How do I authenticate with the YNAB API Endpoints?
With an API key in the Authorization header.
How many endpoints does the YNAB API Endpoints have?
31 operations on 25 paths (23 GET, 4 POST, 2 PATCH, 1 PUT, 1 DELETE). The largest groups are Transactions, Categories, Accounts, Budgets.
Is forking the YNAB API Endpoints free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.