canonical: https://jentic.com/apis/youneedabudget.com/ynab-api-endpoints

# Youneedabudget 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 an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com. The API exposes 31 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list budgets, single budget. Covers 31 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for maps and geolocation only.

## Capabilities

- List budgets
- Single budget
- Create a new account
- Account list
- Monitor YNAB API Endpoints operational status and events

## Use cases

### Maps and Geolocation Operations

Use the YNAB API Endpoints to perform maps geolocation operations programmatically. The API provides 31 endpoints covering core functionality including list budgets, single budget, create a new account.

Example prompt: Call GET /budgets to list budgets

### Automated User Management

Automate user operations by combining multiple YNAB API Endpoints endpoints. Agents can single budget and then create a new account in a single workflow.

Example prompt: Call GET `/budgets/{budget_id}` to single budget, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call YNAB API Endpoints endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'list budgets', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/budgets` | List budgets |
| GET | `/budgets/{budget_id}` | Single budget |
| POST | `/budgets/{budget_id}/accounts` | Create a new account |
| GET | `/budgets/{budget_id}/accounts` | Account list |
| GET | `/budgets/{budget_id}/accounts/{account_id}` | Single account |
| GET | `/budgets/{budget_id}/accounts/{account_id}/transactions` | List account transactions |
| GET | `/budgets/{budget_id}/categories` | List categories |
| GET | `/budgets/{budget_id}/categories/{category_id}` | Single category |

## Key resources

- **User** — Operations related to User
- **Budgets** — Operations related to Budgets
- **Accounts** — The accounts for a budget
- **Categories** — The categories for a budget
- **Payees** — The payees for a budget

## Why Jentic

- **Setup:** Wiring the YNAB API by hand means sending your token in the Authorization header on api.youneedabudget.com, matching its budget and account structure, and handling retries yourself. Through Jentic you install once, import the YNAB API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The YNAB API puts the budget id in the URL path (`/budgets/{budget_id}/...`), so a rule can pin your agent to one budget: it reads that budget's accounts, categories, and transactions and nothing else. You choose the operations it may call, so writes like creating an account are not included unless you add them.
- **Credential handling:** Your YNAB token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list budgets' or 'read account transactions', and Jentic returns the matching YNAB operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Here** — Alternative maps geolocation API
- **Tomtom** — Alternative maps geolocation API
- **Googleapis** — Complementary maps geolocation API

## FAQ

### What authentication does the YNAB API Endpoints use?

The YNAB API Endpoints uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list budgets with the YNAB API Endpoints?

Yes. Use the GET /budgets endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the YNAB API Endpoints?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list budgets through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list budgets'. Jentic returns the matching YNAB API Endpoints operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the YNAB API Endpoints have?

The YNAB API Endpoints exposes 31 endpoints covering user, budgets, accounts operations.

### Can I limit what my agent is allowed to do with the YNAB API?

Yes. Because you run Jentic One yourself, your own rules decide which YNAB operations and credentials the agent may use. Since the budget id sits in the URL path (`/budgets/{budget_id}/...`), you can pin the agent to a single budget so it only reads that budget's accounts, categories, and transactions. Write operations such as creating an account (POST `/budgets/{budget_id}/accounts`) are excluded unless you explicitly grant them.