Skip to content

Latest commit

 

History

History
240 lines (182 loc) · 11.9 KB

DerivedApi.md

File metadata and controls

240 lines (182 loc) · 11.9 KB

yodlee.DerivedApi

All URIs are relative to http://localhost

Method HTTP request Description
get_holding_summary GET /derived/holdingSummary Get Holding Summary
get_networth GET /derived/networth Get Networth Summary
get_transaction_summary GET /derived/transactionSummary Get Transaction Summary

get_holding_summary

DerivedHoldingSummaryResponse get_holding_summary(account_ids=account_ids, classification_type=classification_type, include=include)

Get Holding Summary

The get holding summary service is used to get the summary of asset classifications for the user.
By default, accounts with status as ACTIVE and TO BE CLOSED will be considered.
If the include parameter value is passed as details then a summary with holdings and account information is returned.

Example

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() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.DerivedApi(api_client)
    account_ids = 'account_ids_example' # str | Comma separated accountIds (optional)
classification_type = 'classification_type_example' # str | e.g. Country, Sector, etc. (optional)
include = 'include_example' # str | details (optional)

    try:
        # Get Holding Summary
        api_response = api_instance.get_holding_summary(account_ids=account_ids, classification_type=classification_type, include=include)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DerivedApi->get_holding_summary: %s\n" % e)

Parameters

Name Type Description Notes
account_ids str Comma separated accountIds [optional]
classification_type str e.g. Country, Sector, etc. [optional]
include str details [optional]

Return type

DerivedHoldingSummaryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y800 : Invalid value for classificationType<br>Y814 : Exchange rate not available for currency<br>Y824 : The maximum number of accountIds permitted is 100<br> -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_networth

DerivedNetworthResponse get_networth(account_ids=account_ids, container=container, from_date=from_date, include=include, interval=interval, skip=skip, to_date=to_date, top=top)

Get Networth Summary

The get networth service is used to get the networth for the user.
If the include parameter value is passed as details then networth with historical balances is returned.

Example

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() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.DerivedApi(api_client)
    account_ids = 'account_ids_example' # str | comma separated accountIds (optional)
container = 'container_example' # str | bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities (optional)
from_date = 'from_date_example' # str | from date for balance retrieval (YYYY-MM-DD) (optional)
include = 'include_example' # str | details (optional)
interval = 'interval_example' # str | D-daily, W-weekly or M-monthly (optional)
skip = 56 # int | skip (Min 0) (optional)
to_date = 'to_date_example' # str | toDate for balance retrieval (YYYY-MM-DD) (optional)
top = 56 # int | top (Max 500) (optional)

    try:
        # Get Networth Summary
        api_response = api_instance.get_networth(account_ids=account_ids, container=container, from_date=from_date, include=include, interval=interval, skip=skip, to_date=to_date, top=top)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DerivedApi->get_networth: %s\n" % e)

Parameters

Name Type Description Notes
account_ids str comma separated accountIds [optional]
container str bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities [optional]
from_date str from date for balance retrieval (YYYY-MM-DD) [optional]
include str details [optional]
interval str D-daily, W-weekly or M-monthly [optional]
skip int skip (Min 0) [optional]
to_date str toDate for balance retrieval (YYYY-MM-DD) [optional]
top int top (Max 500) [optional]

Return type

DerivedNetworthResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y800 : Invalid value for accountIds<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed<br>Y814 : Exchange rate not available for currency<br>Y800 : Invalid value for container -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_transaction_summary

DerivedTransactionSummaryResponse get_transaction_summary(group_by, account_id=account_id, category_id=category_id, category_type=category_type, from_date=from_date, include=include, include_user_category=include_user_category, interval=interval, to_date=to_date)

Get Transaction Summary

The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.

Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.

Notes:

  1. Details can be requested for only one system-defined category
  2. Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE
  3. Dates will not be respected for monthly, yearly, and weekly details
  4. When monthly details are requested, only the fromDate and toDate month will be respected
  5. When yearly details are requested, only the fromDate and toDate year will be respected
  6. For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate
  7. This service supports the localization feature and accepts locale as a header parameter

Example

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() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.DerivedApi(api_client)
    group_by = 'group_by_example' # str | CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY
account_id = 'account_id_example' # str | comma separated account Ids (optional)
category_id = 'category_id_example' # str | comma separated categoryIds (optional)
category_type = 'category_type_example' # str | INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION (optional)
from_date = 'from_date_example' # str | YYYY-MM-DD format (optional)
include = 'include_example' # str | details (optional)
include_user_category = True # bool | TRUE/FALSE (optional)
interval = 'interval_example' # str | D-daily, W-weekly, M-mothly or Y-yearly (optional)
to_date = 'to_date_example' # str | YYYY-MM-DD format (optional)

    try:
        # Get Transaction Summary
        api_response = api_instance.get_transaction_summary(group_by, account_id=account_id, category_id=category_id, category_type=category_type, from_date=from_date, include=include, include_user_category=include_user_category, interval=interval, to_date=to_date)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DerivedApi->get_transaction_summary: %s\n" % e)

Parameters

Name Type Description Notes
group_by str CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY
account_id str comma separated account Ids [optional]
category_id str comma separated categoryIds [optional]
category_type str INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION [optional]
from_date str YYYY-MM-DD format [optional]
include str details [optional]
include_user_category bool TRUE/FALSE [optional]
interval str D-daily, W-weekly, M-mothly or Y-yearly [optional]
to_date str YYYY-MM-DD format [optional]

Return type

DerivedTransactionSummaryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y010 : Invalid session<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for groupBy<br>Y803 : groupBy required<br>Y803 : categoryType required<br>Y800 : Invalid value for categoryId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for fromDate or toDate<br>Y814 : Exchange rate not available for currency<br>Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE<br>Y816 : User-defined category details can only be requested for one system categoryId with groupBy='CATEGORY'<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of categoryTypes permitted is 100 -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]