fds.sdk.PriceAlertingAPIforDigitalPortals 0.9.1

Price Alerting API for Digital Portals client library for Python

Price Alerting API for Digital Portals client library for Python

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: v1
• Package version: 0.9.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.PriceAlertingAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.PriceAlertingAPIforDigitalPortals

Usage

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

   1. Install and activate python 3.6+. 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.PriceAlertingAPIforDigitalPortals
from fds.sdk.PriceAlertingAPIforDigitalPortals.api import alerting_api
from fds.sdk.PriceAlertingAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.PriceAlertingAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.PriceAlertingAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.PriceAlertingAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.PriceAlertingAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
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.PriceAlertingAPIforDigitalPortals.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.PriceAlertingAPIforDigitalPortals.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.PriceAlertingAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alerting_api.AlertingApi(api_client)
    id = "id_example" # str | Identifier of the alert.
attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)

    try:
        # Details of an alert.
        api_response = api_instance.get_alerting_prices_basic_alert_get(id, attributes=attributes)
        pprint(api_response)
    except fds.sdk.PriceAlertingAPIforDigitalPortals.ApiException as e:
        print("Exception when calling AlertingApi->get_alerting_prices_basic_alert_get: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AlertingApi	get_alerting_prices_basic_alert_get	GET /alerting/prices/basic/alert/get	Details of an alert.
AlertingApi	get_alerting_prices_basic_alert_list	GET /alerting/prices/basic/alert/list	List of alerts.
AlertingApi	get_alerting_prices_basic_trigger_get	GET /alerting/prices/basic/trigger/get	Details of a trigger.
AlertingApi	post_alerting_prices_basic_trigger_list	POST /alerting/prices/basic/trigger/list	List of triggers.

Documentation For Models

• AlertingPricesBasicTriggerListData
• AlertingPricesBasicTriggerListDataFilter
• AlertingPricesBasicTriggerListDataFilterStatus
• AlertingPricesBasicTriggerListMeta
• AlertingPricesBasicTriggerListMetaPagination
• AttributesMember
• CursorBasedPaginationOutputObject
• CursorBasedPaginationOutputObjectWithoutTotal
• ErrorMetaObject
• ErrorObject
• InlineObject
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Data
• InlineResponse2001Meta
• InlineResponse2001Trigger
• InlineResponse2001TriggerPrice
• InlineResponse2001TriggerStatus
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2003
• InlineResponse2003Data
• InlineResponse2003Range
• InlineResponse200Data
• InlineResponse200DataPrice
• InlineResponse200DataTrigger
• InlineResponse200DataTriggerNotation
• InlineResponse200DataTriggerPrice
• InlineResponse200DataTriggerRange
• InlineResponse200DataTriggerStatus
• InlineResponse200Meta
• LanguageMember
• OffsetBasedPaginationOutputObject
• OffsetBasedPaginationOutputObjectWithoutTotal
• PartialOutputObject
• 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.PriceAlertingAPIforDigitalPortals.apis and fds.sdk.PriceAlertingAPIforDigitalPortals.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.PriceAlertingAPIforDigitalPortals.api.default_api import DefaultApi
• from fds.sdk.PriceAlertingAPIforDigitalPortals.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.PriceAlertingAPIforDigitalPortals
from fds.sdk.PriceAlertingAPIforDigitalPortals.apis import *
from fds.sdk.PriceAlertingAPIforDigitalPortals.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.