{"id":20884217,"url":"https://github.com/irunasroot/pynab-client","last_synced_at":"2025-05-12T18:31:25.858Z","repository":{"id":50189311,"uuid":"197314053","full_name":"irunasroot/pynab-client","owner":"irunasroot","description":"Python API to access YNAB v1 API","archived":false,"fork":false,"pushed_at":"2022-12-08T05:53:41.000Z","size":29,"stargazers_count":5,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-27T00:23:30.591Z","etag":null,"topics":["budget","pynab-client","python-api","ynab","youneedabudget"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/irunasroot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-17T04:19:03.000Z","updated_at":"2021-02-28T13:12:58.000Z","dependencies_parsed_at":"2023-01-24T14:45:49.061Z","dependency_job_id":null,"html_url":"https://github.com/irunasroot/pynab-client","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irunasroot%2Fpynab-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irunasroot%2Fpynab-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irunasroot%2Fpynab-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irunasroot%2Fpynab-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/irunasroot","download_url":"https://codeload.github.com/irunasroot/pynab-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253798065,"owners_count":21965999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["budget","pynab-client","python-api","ynab","youneedabudget"],"created_at":"2024-11-18T08:09:26.002Z","updated_at":"2025-05-12T18:31:25.611Z","avatar_url":"https://github.com/irunasroot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pynab-client\nPython API module for interfacing with You Need a Budget's (YNAB) v1 API\n\nOnly runs on python \u003e3.6 .....#sorrynotsorry\n\n## installation\nEasy way\n```bash\npip install pynab-client\n```\n\nLess easy way\n```bash\ngit clone https://github.com/irunasroot/pynab-client.git\ncd pynab-client\npython setup.py install\n```\n\n## Usage\n```python\nfrom pynabapi import YnabClient\n\nclient = YnabClient(\"my-api-token\")\n\nmy_budgets = client.get_budget()\n```\n\n## API\n\nYnabClient.get_budget()\n```text\nThe mother load. By default you'll get a summary list of all Budgets you have on your account. If you're looking\nfor a single budget you can specify the budget_id or by default it will pull data for the last opened budget.\n\n:param summary: Set summary to False if you want an entire payload of a single budget\n    :default: True\n:param budget_id: The budget id of the budget you want to view data from.\n    :default: last-used which is your last opened budget.\n:return: Returns Budgets object as a list of Budget objects or a single Budget object\n```\n\nYnabClient.get_account()  \n```text\n:param account_id: Provide account_id to retrieve a single known account.  \n    :default: None\n:param budget_id: The budget id of the budget you want to view data from.  \n    :default: last-used which is your last opened budget.  \n:return: Returns Accounts object as a list of Account objects or a single Account object  \n```\n\nYnabClient.get_budgetmonth()\n```text\nGet budget month or months. If specifying the month then a list of categories are also provided.\n\n:param month: Provide month to retrieve a single known month.\n    :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n    :default: last-used which is your last opened budget.\n:return: Returns BudgetMonths object as a list of BudgetMonth objects or a single BudgetMonth object\n```\n\nYnabClient.get_category()\n```text\nGet budget category or categories. If specifying the month then you also need to specify a category_id\n\n:param category_id: The category ID of the specific category you want to retrieve\n    :default: None\n:param month: The month of the category you want to retrieve format: yyyy-MM-dd\n    :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n    :default: last-used which is your last opened budget.\n:return: Returns BudgetCategories object as a list of BudgetCategory objects or a single BudgetCategory object\n```\n\nYnabClient.get_payee()\n```text\nGet budget payee or payees.\n\n:param payee_id: Provide payee_id to retrieve a single known payee.\n:param budget_id: The budget id of the budget you want to view data from.\n    :default: last-used which is your last opened budget.\n:return: Returns Payees object as a list of Payee objects or a single Payee object\n```\n\nYnabClient.get_transaction()\n```text\nGet budget transaction or transactions.\n\n:param transaction_id: Provide transaction_id to retrieve a single known transaction.\n    :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n    :default: last-used which is your last opened budget.\n:return: Returns Transactions object as a list of Transaction objects or a single Transaction object\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firunasroot%2Fpynab-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firunasroot%2Fpynab-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firunasroot%2Fpynab-client/lists"}