Skip to content

moneykit/yodlee-api-client

Repository files navigation

yodlee

This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview.

You will have to set the header before making the API call. The following headers apply to all the APIs:

  • Authorization: This header holds the access token
  • Api-Version: 1.1
Note: If there are any API-specific headers, they are mentioned explicitly in the respective API's description.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import yodlee

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 yodlee

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with yodlee.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountTokenApi(api_client)
    token_request = yodlee.PaymentProcessorTokenRequest() # PaymentProcessorTokenRequest | account information

    try:
        # Create Account Token
        api_response = api_instance.generate_payment_processor_token(token_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountTokenApi->generate_payment_processor_token: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountTokenApi generate_payment_processor_token POST /paymentProcessor/token Create Account Token
AccountTokenApi revoke_payment_processor_token DELETE /paymentProcessor/token Delete Account Token
AccountsApi create_manual_account POST /accounts Add Manual Account
AccountsApi delete_account DELETE /accounts/{accountId} Delete Account
AccountsApi evaluate_address POST /accounts/evaluateAddress Evaluate Address
AccountsApi get_account GET /accounts/{accountId} Get Account Details
AccountsApi get_all_accounts GET /accounts Get Accounts
AccountsApi get_associated_accounts GET /accounts/associatedAccounts/{providerAccountId} Associated Accounts
AccountsApi get_historical_balances GET /accounts/historicalBalances Get Historical Balances
AccountsApi get_latest_balances GET /accounts/latestBalances Get Latest Balances
AccountsApi migrate_accounts PUT /accounts/migrateAccounts/{providerAccountId} Migrate Accounts
AccountsApi update_account PUT /accounts/{accountId} Update Account
AuthApi delete_api_key DELETE /auth/apiKey/{key} Delete API Key
AuthApi delete_token DELETE /auth/token Delete Token
AuthApi generate_access_token POST /auth/token Generate Access Token
AuthApi generate_api_key POST /auth/apiKey Generate API Key
AuthApi get_api_keys GET /auth/apiKey Get API Keys
CobrandApi cobrand_login POST /cobrand/login Cobrand Login
CobrandApi cobrand_logout POST /cobrand/logout Cobrand Logout
CobrandApi create_subscription_event POST /cobrand/config/notifications/events/{eventName} Subscribe Event
CobrandApi delete_subscribed_event DELETE /cobrand/config/notifications/events/{eventName} Delete Subscription
CobrandApi get_public_key GET /cobrand/publicKey Get Public Key
CobrandApi get_subscribed_events GET /cobrand/config/notifications/events Get Subscribed Events
CobrandApi update_subscribed_event PUT /cobrand/config/notifications/events/{eventName} Update Subscription
ConfigsApi create_subscription_notification_event POST /configs/notifications/events/{eventName} Subscribe For Notification Event
ConfigsApi delete_subscribed_notification_event DELETE /configs/notifications/events/{eventName} Delete Notification Subscription
ConfigsApi get_public_encryption_key GET /configs/publicKey Get Public Key
ConfigsApi get_subscribed_notification_events GET /configs/notifications/events Get Subscribed Notification Events
ConfigsApi update_subscribed_notification_event PUT /configs/notifications/events/{eventName} Update Notification Subscription
ConsentsApi create_consent POST /consents Post Consent
ConsentsApi get_consent_details GET /consents/{consentId} Get Authorization Details
ConsentsApi get_consents GET /consents Get Consents
ConsentsApi renew_consent PUT /consents/{consentId}/renewal Renew Consent
ConsentsApi update_consent PUT /consents/{consentId} Put Consent
DataExtractsApi get_data_extracts_events GET /dataExtracts/events Get Events
DataExtractsApi get_data_extracts_user_data GET /dataExtracts/userData Get userData
DerivedApi get_holding_summary GET /derived/holdingSummary Get Holding Summary
DerivedApi get_networth GET /derived/networth Get Networth Summary
DerivedApi get_transaction_summary GET /derived/transactionSummary Get Transaction Summary
DocumentsApi delete_document DELETE /documents/{documentId} Delete Document
DocumentsApi download_document GET /documents/{documentId} Download a Document
DocumentsApi get_documents GET /documents Get Documents
HoldingsApi get_asset_classification_list GET /holdings/assetClassificationList Get Asset Classification List
HoldingsApi get_holding_type_list GET /holdings/holdingTypeList Get Holding Type List
HoldingsApi get_holdings GET /holdings Get Holdings
HoldingsApi get_securities GET /holdings/securities Get Security Details
InstitutionsApi get_institutions GET /institutions Get institutions
PaymentProcessorApi get_verified_account GET /partner/paymentProcessor/account Get Account Details
PaymentProcessorApi get_verified_account_balance GET /partner/paymentProcessor/account/balance Get Account Balance
PaymentProcessorApi get_verified_account_holder GET /partner/paymentProcessor/account/holder Get Account Holder Details
ProviderAccountsApi delete_provider_account DELETE /providerAccounts/{providerAccountId} Delete Provider Account
ProviderAccountsApi edit_credentials_or_refresh_provider_account PUT /providerAccounts Update Account
ProviderAccountsApi get_all_provider_accounts GET /providerAccounts Get Provider Accounts
ProviderAccountsApi get_provider_account GET /providerAccounts/{providerAccountId} Get Provider Account Details
ProviderAccountsApi get_provider_account_profiles GET /providerAccounts/profile Get User Profile Details
ProviderAccountsApi link_provider_account POST /providerAccounts Add Account
ProviderAccountsApi update_preferences PUT /providerAccounts/{providerAccountId}/preferences Update Preferences
ProvidersApi get_all_providers GET /providers Get Providers
ProvidersApi get_provider GET /providers/{providerId} Get Provider Details
ProvidersApi get_providers_count GET /providers/count Get Providers Count
StatementsApi get_statements GET /statements Get Statements
TransactionsApi create_or_run_transaction_categorization_rules POST /transactions/categories/rules Create or Run Transaction Categorization Rule
TransactionsApi create_transaction_category POST /transactions/categories Create Category
TransactionsApi delete_transaction_categorization_rule DELETE /transactions/categories/rules/{ruleId} Delete Transaction Categorization Rule
TransactionsApi delete_transaction_category DELETE /transactions/categories/{categoryId} Delete Category
TransactionsApi get_transaction_categories GET /transactions/categories Get Transaction Category List
TransactionsApi get_transaction_categorization_rules GET /transactions/categories/txnRules Get Transaction Categorization Rules
TransactionsApi get_transaction_categorization_rules_deprecated GET /transactions/categories/rules Get Transaction Categorization Rules
TransactionsApi get_transactions GET /transactions Get Transactions
TransactionsApi get_transactions_count GET /transactions/count Get Transactions Count
TransactionsApi run_transaction_categorization_rule POST /transactions/categories/rules/{ruleId} Run Transaction Categorization Rule
TransactionsApi update_transaction PUT /transactions/{transactionId} Update Transaction
TransactionsApi update_transaction_categorization_rule PUT /transactions/categories/rules/{ruleId} Update Transaction Categorization Rule
TransactionsApi update_transaction_category PUT /transactions/categories Update Category
UserApi get_access_tokens GET /user/accessTokens Get Access Tokens
UserApi get_user GET /user Get User Details
UserApi register_user POST /user/register Register User
UserApi saml_login POST /user/samlLogin Saml Login
UserApi unregister DELETE /user/unregister Delete User
UserApi update_user PUT /user Update User Details
UserApi user_logout POST /user/logout User Logout
VerificationApi get_classification_summary GET /verification/classification/summary Get Classification Summary
VerificationApi get_holder_profile GET /verification/holderProfile Get Holder Profile
VerificationApi get_verification_status GET /verification Get Verification Status
VerificationApi get_verified_accounts GET /verification/verifiedAccounts Get Verified Accounts
VerificationApi initiate_matching_or_challenge_deposite_verification POST /verification Initiaite Challenge Deposit
VerificationApi verify_challenge_deposit PUT /verification Verify Challenge Deposit
VerifyAccountApi initiate_account_verification POST /verifyAccount/{providerAccountId} Verify Accounts Using Transactions

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

[email protected]

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages