Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.09 KB

info.md

File metadata and controls

47 lines (37 loc) · 2.09 KB

Configuration options

Key Type Required Default Description
api_key string True None YNAB API key (see instructions below)
name string False sensor.ynab Custom name for the sensor
budget string False last-used Budget ID to use if you have multiple budgets. If none specified, your last used budget will be used
currency string False $ Currency to use as unit of measurement
categories list False None List of YNAB categories to include in the sensor. These are CASE SENSITIVE
accounts list False None List of YNAB accounts to include in the sensor. These are CASE SENSTIVIE

Example default configuration.yaml

ynab:
  api_key: <api_key_here>

Example: configuration.yaml with options

ynab:
  api_key: <api_key_here>
  name: "My YNAB Budget"
  budget: <budget_id_here>
  currency: "$"
  categories:
    - "HASS Budget"
    - "Vacation Budget"
  accounts:
    - "Savings Account"

Generate YNAB API key / Get budget ID

API:

  1. Log on to YNAB
  2. Go to My Budget > My Account > Developer Settings
  3. Click on New Token
  4. Enter your password and click Generate
  5. Copy the token that appears at the top of the page

Budget ID:

The budget ID is the combination between the slashes after the URL https://app.youneedabudget.com If you only have one budget, you can omit the the budget option, if you have multiple budgets pick a budget you want the sensor to report on. At this time only 1 budget is retrieved.