Real-Time Price Alerting client library for Python

Project description

Real-Time Price Alerting client library for Python

The Price Alerting API is designed to inform the users of an application directly about important changes in the data on the platform. The endpoint group basic price alerting deals 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 the Quotes API for Digital Portals for 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 see https://endpointreference.factset.com.

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

API version: 3.0.0
SDK version: 0.11.5
Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.RealTimePriceAlerting==0.11.5

pip

pip install fds.sdk.utils fds.sdk.RealTimePriceAlerting==0.11.5

Usage

Generate authentication credentials.
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.
Install dependencies.
Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.RealTimePriceAlerting
from fds.sdk.RealTimePriceAlerting.api import alerting_api
from fds.sdk.RealTimePriceAlerting.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
#
# 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 class
configuration = 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 client
with fds.sdk.RealTimePriceAlerting.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alerting_api.AlertingApi(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 an alert.
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_alerting_prices_basic_alert_get(id, attributes=attributes)

        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
    # 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 Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.RealTimePriceAlerting

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.RealTimePriceAlerting.Configuration(...)
configuration.debug = True

Configure a Proxy

You 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).

import fds.sdk.RealTimePriceAlerting

configuration = fds.sdk.RealTimePriceAlerting.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

ssl_ca_cert: a path to the certificate to use for verification in PEM format.
verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.

import fds.sdk.RealTimePriceAlerting

configuration = fds.sdk.RealTimePriceAlerting.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.RealTimePriceAlerting

configuration = fds.sdk.RealTimePriceAlerting.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

Documentation for API Endpoints

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

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

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

Contributing

Please refer to the contributing guide.

Copyright

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.

Project details

Release history Release notifications | RSS feed

0.11.6

Nov 1, 2024

This version

0.11.5

Jun 26, 2024

0.11.4

Jun 26, 2024

0.11.3

May 2, 2024

0.11.2

Apr 8, 2024

0.11.1

Oct 25, 2023

0.11.0

Oct 17, 2023

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.RealTimePriceAlerting-0.11.5-py3-none-any.whl (197.5 kB view hashes)

Uploaded Jun 26, 2024 Python 3

Hashes for fds.sdk.RealTimePriceAlerting-0.11.5-py3-none-any.whl

Hashes for fds.sdk.RealTimePriceAlerting-0.11.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`609f836ef1b3fd376dbe92e19854e00c700eca75b23129b37a2ce204804a6c00`
MD5	`008c95c061dce4f3d71e6e0064003de5`
BLAKE2b-256	`07daf00418aa4aa254b594df0b5099f7c0622685d66c561c3ff9863d1fb2cc74`