fds.sdk.RecommendationListAPIforDigitalPortals 0.10.2

Recommendation List API for Digital Portals client library for Python

Recommendation List API for Digital Portals client library for Python

A recommendation list is revision-controlled, with up to 5,000 revisions per recommendation list.

A recommendation list as of a given revision may optionally point to an instrument (e.g. an index) and contains a list of up to 1,000 elements, each referring to a security traded on a market (e.g. a financial product recommended by the bank). For listings that are not available in the Wealth Management platform, no information beyond a customer-defined name is available. Each element may optionally have a portfolio weight. Identifiers for revisions are globally unique.

See the Quotes API for Digital Portals for access to detailed price information.

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

• API version: 2
• Package version: 0.10.2
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.RecommendationListAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.RecommendationListAPIforDigitalPortals

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.RecommendationListAPIforDigitalPortals
from fds.sdk.RecommendationListAPIforDigitalPortals.api import recommendation_list_api
from fds.sdk.RecommendationListAPIforDigitalPortals.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# Examples for each supported authentication method are below,
# choose one that satisfies your use case.

# (Preferred) OAuth 2.0: FactSetOAuth2
# See https://github.com/FactSet/enterprise-sdk#oauth-20
# for information on how to create the app-config.json file
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.RecommendationListAPIforDigitalPortals.Configuration(
    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
)

# Basic authentication: FactSetApiKey
# See https://github.com/FactSet/enterprise-sdk#api-key
# for information how to create an API key
# configuration = fds.sdk.RecommendationListAPIforDigitalPortals.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.RecommendationListAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = recommendation_list_api.RecommendationListApi(api_client)
    id = 3.14 # float | 
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
    language = "_language_example" # str |  (optional)

    try:
        # Attributes of a single list.
        api_response = api_instance.get_recommendation_list_get(id, attributes=attributes, language=language)
        pprint(api_response)
    except fds.sdk.RecommendationListAPIforDigitalPortals.ApiException as e:
        print("Exception when calling RecommendationListApi->get_recommendation_list_get: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Attributes of a single list.
    #     api_response, http_status_code, response_headers = api_instance.get_recommendation_list_get_with_http_info(id, attributes=attributes, language=language)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.RecommendationListAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling RecommendationListApi->get_recommendation_list_get: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Attributes of a single list.
    #     async_result = api_instance.get_recommendation_list_get_async(id, attributes=attributes, language=language)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.RecommendationListAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling RecommendationListApi->get_recommendation_list_get: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Attributes of a single list.
    #     async_result = api_instance.get_recommendation_list_get_with_http_info_async(id, attributes=attributes, language=language)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.RecommendationListAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling RecommendationListApi->get_recommendation_list_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/wealth/v1

Class	Method	HTTP request	Description
RecommendationListApi	get_recommendation_list_get	GET /recommendationList/get	Attributes of a single list.
RecommendationListApi	get_recommendation_list_revision_element_list	GET /recommendationList/revision/element/list	List of elements of a given revision.
RecommendationListApi	get_recommendation_list_revision_get	GET /recommendationList/revision/get	Attributes of a single revision.
RecommendationListApi	get_recommendation_list_revision_search	GET /recommendationList/revision/search	Search for revisions of a recommendation list.
RecommendationListApi	get_recommendation_list_search	GET /recommendationList/search	Search for recommendation lists.
RecommendationListApi	post_recommendation_list_revision_list	POST /recommendationList/revision/list	List of revisions of a recommendation list.

Documentation For Models

• AttributesMember
• CursorBasedPaginationOutputObject
• CursorBasedPaginationOutputObjectWithoutTotal
• ErrorMetaObject
• ErrorObject
• InlineObject
• InlineResponse200
• InlineResponse2001
• InlineResponse2001ActiveRange
• InlineResponse2001Data
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2002DataInstrument
• InlineResponse2002DataRecommendationList
• InlineResponse2002DataTypes
• InlineResponse2003
• InlineResponse2003Data
• InlineResponse2004
• InlineResponse2004Data
• InlineResponse2005
• InlineResponse2005Data
• InlineResponse2005Description
• InlineResponse2005Notation
• InlineResponse2005NotationInstrument
• InlineResponse2005NotationInstrumentType
• InlineResponse2005NotationMarket
• InlineResponse2005RecommendationClass
• InlineResponse200Data
• InlineResponse200DataActiveRange
• InlineResponse200DataActiveRevision
• InlineResponse200DataActiveRevisionActiveRange
• InlineResponse200Meta
• LanguageMember
• OffsetBasedPaginationOutputObject
• OffsetBasedPaginationOutputObjectWithoutTotal
• PartialOutputObject
• RecommendationListRevisionListData
• RecommendationListRevisionListDataActiveRange
• RecommendationListRevisionListMeta
• StatusObject

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.RecommendationListAPIforDigitalPortals.apis and fds.sdk.RecommendationListAPIforDigitalPortals.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from fds.sdk.RecommendationListAPIforDigitalPortals.api.default_api import DefaultApi
• from fds.sdk.RecommendationListAPIforDigitalPortals.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.RecommendationListAPIforDigitalPortals
from fds.sdk.RecommendationListAPIforDigitalPortals.apis import *
from fds.sdk.RecommendationListAPIforDigitalPortals.models import *

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.