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_client

Setuptools

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_client

Getting 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

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