Package: fds.sdk.WatchlistAPIforDigitalPortals
Watchlist API for Digital Portals client library for PythonWatchlists keeps track of users' individual investment objectives. They are meant to support the self-directed business of wealth management firms.The Watchlist API for Digital Portals is fully integrated with the corresponding Quotes API, allowing access to detailed price and
performance information of instruments in a watchlist. This also supports basic security identifier cross-reference. To complement
the Watchlist API with direct access to price histories, please refer to the Time Series API for Digital Portals.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 2Package version: 0.9.5Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.WatchlistAPIforDigitalPortalspippipinstallfds.sdk.utilsfds.sdk.WatchlistAPIforDigitalPortalsUsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.WatchlistAPIforDigitalPortalsfromfds.sdk.WatchlistAPIforDigitalPortals.apiimportwatchlist_apifromfds.sdk.WatchlistAPIforDigitalPortals.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# 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 classconfiguration=fds.sdk.WatchlistAPIforDigitalPortals.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.WatchlistAPIforDigitalPortals.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.WatchlistAPIforDigitalPortals.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=watchlist_api.WatchlistApi(api_client)id="id_example"# str |attributes=["_attributes_example",]# [str] | Limit the attributes returned in the response to the specified set. (optional)try:# Details of a watchlist.api_response=api_instance.get_watchlist_get(id,attributes=attributes)pprint(api_response)exceptfds.sdk.WatchlistAPIforDigitalPortals.ApiExceptionase:print("Exception when calling WatchlistApi->get_watchlist_get:%s\n"%e)# Get response, http status code and response headers# try:#     # Details of a watchlist.#     api_response, http_status_code, response_headers = api_instance.get_watchlist_get_with_http_info(id, attributes=attributes)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.WatchlistAPIforDigitalPortals.ApiException as e:#     print("Exception when calling WatchlistApi->get_watchlist_get: %s\n" % e)# Get response asynchronous# try:#     # Details of a watchlist.#     async_result = api_instance.get_watchlist_get_async(id, attributes=attributes)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.WatchlistAPIforDigitalPortals.ApiException as e:#     print("Exception when calling WatchlistApi->get_watchlist_get: %s\n" % e)# Get response, http status code and response headers asynchronous# try:#     # Details of a watchlist.#     async_result = api_instance.get_watchlist_get_with_http_info_async(id, attributes=attributes)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.WatchlistAPIforDigitalPortals.ApiException as e:#     print("Exception when calling WatchlistApi->get_watchlist_get: %s\n" % e)Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/wealth/v1ClassMethodHTTP requestDescriptionWatchlistApiget_watchlist_getGET/watchlist/getDetails of a watchlist.WatchlistApiget_watchlist_listGET/watchlist/listList of watchlists.WatchlistApiget_watchlist_position_listGET/watchlist/position/listList of positions of a watchlist.WatchlistApipost_watchlist_createPOST/watchlist/createCreate a watchlist.WatchlistApipost_watchlist_deletePOST/watchlist/deleteDelete a watchlist.WatchlistApipost_watchlist_modifyPOST/watchlist/modifyModify a watchlist.WatchlistApipost_watchlist_position_createPOST/watchlist/position/createAdd a position to a watchlist.WatchlistApipost_watchlist_position_deletePOST/watchlist/position/deleteDelete a position of a watchlist.WatchlistApipost_watchlist_position_getPOST/watchlist/position/getDetails of the position of a watchlist.WatchlistApipost_watchlist_position_modifyPOST/watchlist/position/modifyModify a position in a watchlist.Documentation For ModelsAttributesMemberCursorBasedPaginationOutputObjectCursorBasedPaginationOutputObjectWithoutTotalErrorMetaObjectErrorObjectInlineObjectInlineObject1InlineObject2InlineObject3InlineObject4InlineObject5InlineObject6InlineResponse200InlineResponse2001InlineResponse2001DataInlineResponse2002InlineResponse2002DataInlineResponse2003InlineResponse2004InlineResponse2004DataInlineResponse2004DataNotationInlineResponse2005InlineResponse2005DataInlineResponse2005NotationInlineResponse201InlineResponse2011InlineResponse2011DataInlineResponse201DataInlineResponse201MetaLanguageMemberOffsetBasedPaginationOutputObjectOffsetBasedPaginationOutputObjectWithoutTotalPartialOutputObjectStatusObjectWatchlistCreateDataWatchlistCreateMetaWatchlistDeleteDataWatchlistModifyDataWatchlistPositionCreateDataWatchlistPositionCreateDataNotationWatchlistPositionDeleteDataWatchlistPositionDeleteDataPositionWatchlistPositionGetDataWatchlistPositionGetDataPositionWatchlistPositionModifyDataWatchlistPositionModifyDataPositionDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.WatchlistAPIforDigitalPortals.apis and fds.sdk.WatchlistAPIforDigitalPortals.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.WatchlistAPIforDigitalPortals.api.default_api import DefaultApifrom fds.sdk.WatchlistAPIforDigitalPortals.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import fds.sdk.WatchlistAPIforDigitalPortals
from fds.sdk.WatchlistAPIforDigitalPortals.apis import *
from fds.sdk.WatchlistAPIforDigitalPortals.models import *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.