🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

ynab-client

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ynab-client

YNAB API v1 Python Client

0.1.8
PyPI
Maintainers
1

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

ClassMethodHTTP requestDescription
AccountsApiget_account_by_idGET /budgets/{budget_id}/accounts/{account_id}Single account
AccountsApiget_accountsGET /budgets/{budget_id}/accountsAccount list
BudgetsApiget_budget_by_idGET /budgets/{budget_id}Single budget
BudgetsApiget_budget_settings_by_idGET /budgets/{budget_id}/settingsBudget Settings
BudgetsApiget_budgetsGET /budgetsList budgets
CategoriesApiget_categoriesGET /budgets/{budget_id}/categoriesList categories
CategoriesApiget_category_by_idGET /budgets/{budget_id}/categories/{category_id}Single category
MonthsApiget_budget_monthGET /budgets/{budget_id}/months/{month}Single budget month
MonthsApiget_budget_monthsGET /budgets/{budget_id}/monthsList budget months
PayeeLocationsApiget_payee_location_by_idGET /budgets/{budget_id}/payee_locations/{payee_location_id}Single payee location
PayeeLocationsApiget_payee_locationsGET /budgets/{budget_id}/payee_locationsList payee locations
PayeeLocationsApiget_payee_locations_by_payeeGET /budgets/{budget_id}/payees/{payee_id}/payee_locationsList locations for a payee
PayeesApiget_payee_by_idGET /budgets/{budget_id}/payees/{payee_id}Single payee
PayeesApiget_payeesGET /budgets/{budget_id}/payeesList payees
ScheduledTransactionsApiget_scheduled_transaction_by_idGET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}Single scheduled transaction
ScheduledTransactionsApiget_scheduled_transactionsGET /budgets/{budget_id}/scheduled_transactionsList scheduled transactions
TransactionsApibulk_create_transactionsPOST /budgets/{budget_id}/transactions/bulkBulk create transactions
TransactionsApicreate_transactionPOST /budgets/{budget_id}/transactionsCreate new transaction
TransactionsApiget_transactionsGET /budgets/{budget_id}/transactionsList transactions
TransactionsApiget_transactions_by_accountGET /budgets/{budget_id}/accounts/{account_id}/transactionsList account transactions
TransactionsApiget_transactions_by_categoryGET /budgets/{budget_id}/categories/{category_id}/transactionsList category transactions
TransactionsApiget_transactions_by_idGET /budgets/{budget_id}/transactions/{transaction_id}Single transaction
TransactionsApiget_transactions_by_payeeGET /budgets/{budget_id}/payees/{payee_id}/transactionsList payee transactions
TransactionsApiupdate_transactionPUT /budgets/{budget_id}/transactions/{transaction_id}Updates an existing transaction
UserApiget_userGET /userUser info

Documentation For Models

Documentation For Authorization

bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts