YNAB API v1 Python Client
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
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install ynab-client(you may need to run pip with root permission: sudo pip install git+https://github.com/gchiam/ynab-client-python.git)
Then import the package:
import ynab_clientSetuptools
Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import ynab_clientGetting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import ynab_client
from ynab_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: bearer
configuration = ynab_client.Configuration()
configuration.api_key_prefix['Authorization'] = 'Bearer'
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = ynab_client.BudgetsApi()
try:
api_response = api_instance.get_budgets()
pprint(api_response)
except ApiException as e:
print("Exception when calling BudgetApi->get_budgets: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.youneedabudget.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | get_account_by_id | GET /budgets/{budget_id}/accounts/{account_id} | Single account |
| AccountsApi | get_accounts | GET /budgets/{budget_id}/accounts | Account list |
| BudgetsApi | get_budget_by_id | GET /budgets/{budget_id} | Single budget |
| BudgetsApi | get_budget_settings_by_id | GET /budgets/{budget_id}/settings | Budget Settings |
| BudgetsApi | get_budgets | GET /budgets | List budgets |
| CategoriesApi | get_categories | GET /budgets/{budget_id}/categories | List categories |
| CategoriesApi | get_category_by_id | GET /budgets/{budget_id}/categories/{category_id} | Single category |
| MonthsApi | get_budget_month | GET /budgets/{budget_id}/months/{month} | Single budget month |
| MonthsApi | get_budget_months | GET /budgets/{budget_id}/months | List budget months |
| PayeeLocationsApi | get_payee_location_by_id | GET /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
| PayeeLocationsApi | get_payee_locations | GET /budgets/{budget_id}/payee_locations | List payee locations |
| PayeeLocationsApi | get_payee_locations_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
| PayeesApi | get_payee_by_id | GET /budgets/{budget_id}/payees/{payee_id} | Single payee |
| PayeesApi | get_payees | GET /budgets/{budget_id}/payees | List payees |
| ScheduledTransactionsApi | get_scheduled_transaction_by_id | GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction |
| ScheduledTransactionsApi | get_scheduled_transactions | GET /budgets/{budget_id}/scheduled_transactions | List scheduled transactions |
| TransactionsApi | bulk_create_transactions | POST /budgets/{budget_id}/transactions/bulk | Bulk create transactions |
| TransactionsApi | create_transaction | POST /budgets/{budget_id}/transactions | Create new transaction |
| TransactionsApi | get_transactions | GET /budgets/{budget_id}/transactions | List transactions |
| TransactionsApi | get_transactions_by_account | GET /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions |
| TransactionsApi | get_transactions_by_category | GET /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions |
| TransactionsApi | get_transactions_by_id | GET /budgets/{budget_id}/transactions/{transaction_id} | Single transaction |
| TransactionsApi | get_transactions_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions |
| TransactionsApi | update_transaction | PUT /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction |
| UserApi | get_user | GET /user | User info |
Documentation For Models
- Account
- AccountResponse
- AccountWrapper
- AccountsResponse
- AccountsWrapper
- BudgetDetailResponse
- BudgetDetailWrapper
- BudgetSettings
- BudgetSettingsResponse
- BudgetSettingsWrapper
- BudgetSummary
- BudgetSummaryResponse
- BudgetSummaryWrapper
- BulkIdWrapper
- BulkIds
- BulkResponse
- BulkTransactions
- CategoriesResponse
- Category
- CategoryGroup
- CategoryGroupsWrapper
- CategoryResponse
- CategoryWrapper
- CurrencyFormat
- DateFormat
- ErrorDetail
- ErrorResponse
- HybridTransactionsResponse
- HybridTransactionsWrapper
- MonthDetailResponse
- MonthDetailWrapper
- MonthSummariesResponse
- MonthSummariesWrapper
- MonthSummary
- Payee
- PayeeLocation
- PayeeLocationResponse
- PayeeLocationWrapper
- PayeeLocationsResponse
- PayeeLocationsWrapper
- PayeeResponse
- PayeeWrapper
- PayeesResponse
- PayeesWrapper
- SaveTransaction
- SaveTransactionWrapper
- ScheduledSubTransaction
- ScheduledTransactionResponse
- ScheduledTransactionSummary
- ScheduledTransactionWrapper
- ScheduledTransactionsResponse
- ScheduledTransactionsWrapper
- SubTransaction
- TransactionResponse
- TransactionSummary
- TransactionWrapper
- TransactionsResponse
- TransactionsWrapper
- User
- UserResponse
- UserWrapper
- BudgetDetail
- CategoryGroupWithCategories
- HybridTransaction
- MonthDetail
- ScheduledTransactionDetail
- TransactionDetail
Documentation For Authorization
bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
