Skip to content

Latest commit

 

History

History
270 lines (196 loc) · 9.77 KB

HoldingsApi.md

File metadata and controls

270 lines (196 loc) · 9.77 KB
Raw

yodlee.HoldingsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_asset_classification_list GET /holdings/assetClassificationList Get Asset Classification List
get_holding_type_list GET /holdings/holdingTypeList Get Holding Type List
get_holdings GET /holdings Get Holdings
get_securities GET /holdings/securities Get Security Details

get_asset_classification_list

HoldingAssetClassificationListResponse get_asset_classification_list()

Get Asset Classification List

The get asset classifications list service is used to get the supported asset classifications.
The response includes different classification types like assetClass, country, sector, style, etc. and the values corresponding to each type.

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.HoldingsApi(api_client)
    
    try:
        # Get Asset Classification List
        api_response = api_instance.get_asset_classification_list()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HoldingsApi->get_asset_classification_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HoldingAssetClassificationListResponse

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 -
401 Unauthorized -
404 Not Found -

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

get_holding_type_list

HoldingTypeListResponse get_holding_type_list()

Get Holding Type List

The get holding types list service is used to get the supported holding types.
The response includes different holding types such as future, moneyMarketFund, stock, etc. and it returns the supported holding types

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.HoldingsApi(api_client)
    
    try:
        # Get Holding Type List
        api_response = api_instance.get_holding_type_list()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HoldingsApi->get_holding_type_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HoldingTypeListResponse

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 -
401 Unauthorized -
404 Not Found -

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

get_holdings

HoldingResponse get_holdings(account_id=account_id, asset_classification_classification_type=asset_classification_classification_type, classification_value=classification_value, include=include, provider_account_id=provider_account_id)

Get Holdings

The get holdings service is used to get the list of holdings of a user.
Supported holding types can be employeeStockOption, moneyMarketFund, bond, etc. and is obtained using get holding type list service.
Asset classifications for the holdings need to be requested through the "include" parameter.
Asset classification information for holdings are not available by default, as it is a premium feature.

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.HoldingsApi(api_client)
    account_id = 'account_id_example' # str | Comma separated accountId (optional)
asset_classification_classification_type = 'asset_classification_classification_type_example' # str | e.g. Country, Sector, etc. (optional)
classification_value = 'classification_value_example' # str | e.g. US (optional)
include = 'include_example' # str | assetClassification (optional)
provider_account_id = 'provider_account_id_example' # str | providerAccountId (optional)

    try:
        # Get Holdings
        api_response = api_instance.get_holdings(account_id=account_id, asset_classification_classification_type=asset_classification_classification_type, classification_value=classification_value, include=include, provider_account_id=provider_account_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HoldingsApi->get_holdings: %s\n" % e)

Parameters

Name Type Description Notes
account_id str Comma separated accountId [optional]
asset_classification_classification_type str e.g. Country, Sector, etc. [optional]
classification_value str e.g. US [optional]
include str assetClassification [optional]
provider_account_id str providerAccountId [optional]

Return type

HoldingResponse

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 accountId<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for include<br>Y800 : Invalid value for classificationType<br>Y800 : Invalid value for classificationValue<br>Y800 : Invalid value for include<br>Y400 : classificationType mismatch<br>Y400 : classificationValue mismatch<br>Y824 : The maximum number of accountIds permitted is 100 -
401 Unauthorized -
404 Not Found -

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

get_securities

HoldingSecuritiesResponse get_securities(holding_id=holding_id)

Get Security Details

The get security details service is used to get all the security information for the holdings

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.HoldingsApi(api_client)
    holding_id = 'holding_id_example' # str | Comma separated holdingId (optional)

    try:
        # Get Security Details
        api_response = api_instance.get_securities(holding_id=holding_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HoldingsApi->get_securities: %s\n" % e)

Parameters

Name Type Description Notes
holding_id str Comma separated holdingId [optional]

Return type

HoldingSecuritiesResponse

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 holdingId<br>Y824 : The maximum number of holdingIds permitted is 100 -
401 Unauthorized -
404 Not Found -

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