YNAB API

by youneedabudget.com

OAuthHTTPSCORSFinance

Overview

Budgeting & Planning

YNAB is a finance API from youneedabudget.com. Requests are authenticated with OAuth. It is served over HTTPS and allows browser requests (CORS). Its OpenAPI description documents 31 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Yes
Category: Finance
Base URL: https://api.youneedabudget.com/v1
Version: 1.0.0
Endpoints: 31
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.youneedabudget.com/v1/budgets" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.youneedabudget.com/v1/budgets", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.youneedabudget.com/v1/budgets",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/budgets`	List budgets
GET	`/budgets/{budget_id}`	Single budget
GET	`/budgets/{budget_id}/accounts`	Account list
POST	`/budgets/{budget_id}/accounts`	Create a new account
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
GET	`/budgets/{budget_id}/categories/{category_id}/transactions`	List category transactions
GET	`/budgets/{budget_id}/months`	List budget months
GET	`/budgets/{budget_id}/months/{month}`	Single budget month
GET	`/budgets/{budget_id}/months/{month}/categories/{category_id}`	Single category for a specific budget month
PATCH	`/budgets/{budget_id}/months/{month}/categories/{category_id}`	Update a category for a specific month
GET	`/budgets/{budget_id}/payee_locations`	List payee locations
GET	`/budgets/{budget_id}/payee_locations/{payee_location_id}`	Single payee location
GET	`/budgets/{budget_id}/payees`	List payees
GET	`/budgets/{budget_id}/payees/{payee_id}`	Single payee
GET	`/budgets/{budget_id}/payees/{payee_id}/payee_locations`	List locations for a payee
GET	`/budgets/{budget_id}/payees/{payee_id}/transactions`	List payee transactions
GET	`/budgets/{budget_id}/scheduled_transactions`	List scheduled transactions
GET	`/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}`	Single scheduled transaction
GET	`/budgets/{budget_id}/settings`	Budget Settings
GET	`/budgets/{budget_id}/transactions`	List transactions
POST	`/budgets/{budget_id}/transactions`	Create a single transaction or multiple transactions
PATCH	`/budgets/{budget_id}/transactions`	Update multiple transactions
POST	`/budgets/{budget_id}/transactions/bulk`	Bulk create transactions
POST	`/budgets/{budget_id}/transactions/import`	Import transactions
GET	`/budgets/{budget_id}/transactions/{transaction_id}`	Single transaction
PUT	`/budgets/{budget_id}/transactions/{transaction_id}`	Updates an existing transaction
DELETE	`/budgets/{budget_id}/transactions/{transaction_id}`	Deletes an existing transaction
GET	`/user`	User info