fds.sdk.WatchlistAPIforDigitalPortals 0.9.5

Watchlist API for Digital Portals client library for Python

Watchlist API for Digital Portals client library for Python

Watchlists 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 the OpenAPI Generator project:

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

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.WatchlistAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.WatchlistAPIforDigitalPortals

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.WatchlistAPIforDigitalPortals
from fds.sdk.WatchlistAPIforDigitalPortals.api import watchlist_api
from fds.sdk.WatchlistAPIforDigitalPortals.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.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 client
with fds.sdk.WatchlistAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_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)
    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
    # 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 Endpoints

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

Class	Method	HTTP request	Description
WatchlistApi	get_watchlist_get	GET /watchlist/get	Details of a watchlist.
WatchlistApi	get_watchlist_list	GET /watchlist/list	List of watchlists.
WatchlistApi	get_watchlist_position_list	GET /watchlist/position/list	List of positions of a watchlist.
WatchlistApi	post_watchlist_create	POST /watchlist/create	Create a watchlist.
WatchlistApi	post_watchlist_delete	POST /watchlist/delete	Delete a watchlist.
WatchlistApi	post_watchlist_modify	POST /watchlist/modify	Modify a watchlist.
WatchlistApi	post_watchlist_position_create	POST /watchlist/position/create	Add a position to a watchlist.
WatchlistApi	post_watchlist_position_delete	POST /watchlist/position/delete	Delete a position of a watchlist.
WatchlistApi	post_watchlist_position_get	POST /watchlist/position/get	Details of the position of a watchlist.
WatchlistApi	post_watchlist_position_modify	POST /watchlist/position/modify	Modify a position in a watchlist.

Documentation For Models

• AttributesMember
• CursorBasedPaginationOutputObject
• CursorBasedPaginationOutputObjectWithoutTotal
• ErrorMetaObject
• ErrorObject
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineObject4
• InlineObject5
• InlineObject6
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Data
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2003
• InlineResponse2004
• InlineResponse2004Data
• InlineResponse2004DataNotation
• InlineResponse2005
• InlineResponse2005Data
• InlineResponse2005Notation
• InlineResponse201
• InlineResponse2011
• InlineResponse2011Data
• InlineResponse201Data
• InlineResponse201Meta
• LanguageMember
• OffsetBasedPaginationOutputObject
• OffsetBasedPaginationOutputObjectWithoutTotal
• PartialOutputObject
• StatusObject
• WatchlistCreateData
• WatchlistCreateMeta
• WatchlistDeleteData
• WatchlistModifyData
• WatchlistPositionCreateData
• WatchlistPositionCreateDataNotation
• WatchlistPositionDeleteData
• WatchlistPositionDeleteDataPosition
• WatchlistPositionGetData
• WatchlistPositionGetDataPosition
• WatchlistPositionModifyData
• WatchlistPositionModifyDataPosition

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.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 DefaultApi
• from fds.sdk.WatchlistAPIforDigitalPortals.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.WatchlistAPIforDigitalPortals
from fds.sdk.WatchlistAPIforDigitalPortals.apis import *
from fds.sdk.WatchlistAPIforDigitalPortals.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.