Package: fds.sdk.RealTimePriceAlerting
Real-Time Price Alerting client library for PythonThe Price Alerting API is designed to inform the users of an application directly about important changes in the data on the platform. The endpoint groupbasic price alertingdeals with generation of alerts based on current price data. For notations, users can define an upper or lower limit and choose on which price type those limit conditions apply.Alerting uses the concepts of triggers and alerts.A trigger is an entity that is set up by an application to watch a certain condition in the market data around a financial instrument. The standard conditions that can be applied are lower limit and upper limit for the value of the price for a given financial instrument.When the condition of a trigger is met, an alert is created. Each alert thus represents one event where a trigger condition was met.An application can learn about the creation of alerts in two ways: The application can actively request the list of alerts (pull approach) or it can subscribe to the list of existing alerts. If a new alert is created, that list changes and the application is notified about the new alert with an update that contains the details on the new alert (push approach).The API supports both approaches. The push approach is realized most easily by using the subscription support that the client libraries provide.See theQuotes API for Digital Portalsfor access to detailed price information.Note: As part of the general trial access, endpoints to write data are excluded. For a description of the full alerting API, please work with a
FactSet consultant and seehttps://endpointreference.factset.com.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 3.0.0Package version: 0.11.1Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.RealTimePriceAlerting==0.11.1pippipinstallfds.sdk.utilsfds.sdk.RealTimePriceAlerting==0.11.1UsageGenerate 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.RealTimePriceAlertingfromfds.sdk.RealTimePriceAlerting.apiimportalerting_apifromfds.sdk.RealTimePriceAlerting.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## The confidential client instance should be reused in production environments.# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication# for more information on using the ConfidentialClient classconfiguration=fds.sdk.RealTimePriceAlerting.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.RealTimePriceAlerting.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.RealTimePriceAlerting.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=alerting_api.AlertingApi(api_client)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.id="id_example"# str |# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.attributes=["_attributes_example",]# [str] | Limit the attributes returned in the response to the specified set. (optional)try:# Details of an alert.# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_alerting_prices_basic_alert_get(id,attributes=attributes)pprint(api_response)exceptfds.sdk.RealTimePriceAlerting.ApiExceptionase:print("Exception when calling AlertingApi->get_alerting_prices_basic_alert_get:%s\n"%e)# # Get response, http status code and response headers# try:#     # Details of an alert.#     api_response, http_status_code, response_headers = api_instance.get_alerting_prices_basic_alert_get_with_http_info(id, attributes=attributes)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.RealTimePriceAlerting.ApiException as e:#     print("Exception when calling AlertingApi->get_alerting_prices_basic_alert_get: %s\n" % e)# # Get response asynchronous# try:#     # Details of an alert.#     async_result = api_instance.get_alerting_prices_basic_alert_get_async(id, attributes=attributes)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.RealTimePriceAlerting.ApiException as e:#     print("Exception when calling AlertingApi->get_alerting_prices_basic_alert_get: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Details of an alert.#     async_result = api_instance.get_alerting_prices_basic_alert_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.RealTimePriceAlerting.ApiException as e:#     print("Exception when calling AlertingApi->get_alerting_prices_basic_alert_get: %s\n" % e)Using PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.RealTimePriceAlertinglogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.RealTimePriceAlerting.Configuration(...)configuration.debug=TrueConfigure a ProxyYou can pass proxy settings to the Configuration class:proxy: The URL of the proxy to use.proxy_headers: a dictionary to pass additional headers to the proxy (e.g.Proxy-Authorization).importfds.sdk.RealTimePriceAlertingconfiguration=fds.sdk.RealTimePriceAlerting.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.RealTimePriceAlertingconfiguration=fds.sdk.RealTimePriceAlerting.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/wealth/v3ClassMethodHTTP requestDescriptionAlertingApiget_alerting_prices_basic_alert_getGET/alerting/prices/basic/alert/getDetails of an alert.AlertingApiget_alerting_prices_basic_alert_listGET/alerting/prices/basic/alert/listList of alerts.AlertingApiget_alerting_prices_basic_trigger_getGET/alerting/prices/basic/trigger/getDetails of a trigger.AlertingApipost_alerting_prices_basic_trigger_listPOST/alerting/prices/basic/trigger/listList of triggers.Documentation For ModelsAttributesMemberCursorBasedPaginationOutputObjectCursorBasedPaginationOutputObjectWithoutTotalErrorMetaObjectErrorObjectInlineResponse200InlineResponse2001InlineResponse2001DataInlineResponse2001MetaInlineResponse2001TriggerInlineResponse2001TriggerPriceInlineResponse2001TriggerStatusInlineResponse2002InlineResponse2002DataInlineResponse2002DataNotificationInlineResponse2002DataNotificationChannelInlineResponse2003InlineResponse2003DataInlineResponse200DataInlineResponse200DataNotificationInlineResponse200DataNotificationChannelInlineResponse200DataNotificationStatusInlineResponse200DataPriceInlineResponse200DataTriggerInlineResponse200DataTriggerNotationInlineResponse200DataTriggerNotificationInlineResponse200DataTriggerNotificationChannelInlineResponse200DataTriggerPriceInlineResponse200DataTriggerRangeInlineResponse200DataTriggerStatusInlineResponse200MetaLanguageMemberOffsetBasedPaginationOutputObjectOffsetBasedPaginationOutputObjectWithoutTotalPartialOutputObjectPostAlertingPricesBasicTriggerListRequestPostAlertingPricesBasicTriggerListRequestDataPostAlertingPricesBasicTriggerListRequestDataFilterPostAlertingPricesBasicTriggerListRequestDataFilterStatusPostAlertingPricesBasicTriggerListRequestMetaPostAlertingPricesBasicTriggerListRequestMetaPaginationStatusObjectDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.RealTimePriceAlerting.apis and fds.sdk.RealTimePriceAlerting.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.RealTimePriceAlerting.api.default_api import DefaultApifrom fds.sdk.RealTimePriceAlerting.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.RealTimePriceAlerting
from fds.sdk.RealTimePriceAlerting.apis import *
from fds.sdk.RealTimePriceAlerting.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.