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.ynab.com
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.68.0
- Package version: 0.0.1
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/eturino/ynab-sdk-openapi-python.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/eturino/ynab-sdk-openapi-python.git
)
Then import the package:
import ynab_sdk_openapi
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_sdk_openapi
Execute pytest
to run the tests.
Please follow the installation procedure and then run the following:
import ynab_sdk_openapi
from ynab_sdk_openapi.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab_sdk_openapi.Configuration(
host = "https://api.ynab.com/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: bearer
configuration = ynab_sdk_openapi.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ynab_sdk_openapi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ynab_sdk_openapi.AccountsApi(api_client)
budget_id = 'budget_id_example' # str | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget)
data = ynab_sdk_openapi.PostAccountWrapper() # PostAccountWrapper | The account to create.
try:
# Create a new account
api_response = api_instance.create_account(budget_id, data)
print("The response of AccountsApi->create_account:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->create_account: %s\n" % e)
All URIs are relative to https://api.ynab.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | create_account | POST /budgets/{budget_id}/accounts | Create a new account |
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 |
CategoriesApi | get_month_category_by_id | GET /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month |
CategoriesApi | update_category | PATCH /budgets/{budget_id}/categories/{category_id} | Update a category |
CategoriesApi | update_month_category | PATCH /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
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 | create_transaction | POST /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions |
TransactionsApi | delete_transaction | DELETE /budgets/{budget_id}/transactions/{transaction_id} | Deletes an existing transaction |
TransactionsApi | get_transaction_by_id | GET /budgets/{budget_id}/transactions/{transaction_id} | Single 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, excluding any pending transactions |
TransactionsApi | get_transactions_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions, excluding any pending transactions |
TransactionsApi | import_transactions | POST /budgets/{budget_id}/transactions/import | Import transactions |
TransactionsApi | update_transaction | PUT /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction |
TransactionsApi | update_transactions | PATCH /budgets/{budget_id}/transactions | Update multiple transactions |
UserApi | get_user | GET /user | User info |
- Account
- AccountResponse
- AccountResponseData
- AccountType
- AccountsResponse
- AccountsResponseData
- BudgetDetail
- BudgetDetailResponse
- BudgetDetailResponseData
- BudgetSettings
- BudgetSettingsResponse
- BudgetSettingsResponseData
- BudgetSummary
- BudgetSummaryResponse
- BudgetSummaryResponseData
- BulkResponse
- BulkResponseData
- BulkResponseDataBulk
- BulkTransactions
- CategoriesResponse
- CategoriesResponseData
- Category
- CategoryGroup
- CategoryGroupWithCategories
- CategoryResponse
- CategoryResponseData
- CurrencyFormat
- DateFormat
- ErrorDetail
- ErrorResponse
- ExistingTransaction
- HybridTransaction
- HybridTransactionsResponse
- HybridTransactionsResponseData
- MonthDetail
- MonthDetailResponse
- MonthDetailResponseData
- MonthSummariesResponse
- MonthSummariesResponseData
- MonthSummary
- NewTransaction
- PatchCategoryWrapper
- PatchMonthCategoryWrapper
- PatchTransactionsWrapper
- Payee
- PayeeLocation
- PayeeLocationResponse
- PayeeLocationResponseData
- PayeeLocationsResponse
- PayeeLocationsResponseData
- PayeeResponse
- PayeeResponseData
- PayeesResponse
- PayeesResponseData
- PostAccountWrapper
- PostTransactionsWrapper
- PutTransactionWrapper
- SaveAccount
- SaveCategory
- SaveCategoryResponse
- SaveCategoryResponseData
- SaveMonthCategory
- SaveSubTransaction
- SaveTransactionWithIdOrImportId
- SaveTransactionWithOptionalFields
- SaveTransactionsResponse
- SaveTransactionsResponseData
- ScheduledSubTransaction
- ScheduledTransactionDetail
- ScheduledTransactionResponse
- ScheduledTransactionResponseData
- ScheduledTransactionSummary
- ScheduledTransactionsResponse
- ScheduledTransactionsResponseData
- SubTransaction
- TransactionClearedStatus
- TransactionDetail
- TransactionFlagColor
- TransactionResponse
- TransactionResponseData
- TransactionSummary
- TransactionsImportResponse
- TransactionsImportResponseData
- TransactionsResponse
- TransactionsResponseData
- User
- UserResponse
- UserResponseData
Authentication schemes defined for the API:
- Type: Bearer authentication