fds.sdk.SPAREngine 2.0.1

Style Performance and Risk Analysis (SPAR) Engine client library for Python

Style Performance and Risk Analysis (SPAR) Engine client library for Python

Allow clients to fetch Analytics through APIs.

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

• API version: 3.13.4
• SDK version: 2.0.1
• 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.protobuf.stach.extensions fds.sdk.SPAREngine==2.0.1

pip

pip install fds.sdk.utils fds.protobuf.stach.extensions fds.sdk.SPAREngine==2.0.1

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:

[!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.SPAREngine
from fds.sdk.SPAREngine.api import accounts_api
from fds.sdk.SPAREngine.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.SPAREngine.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.SPAREngine.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.SPAREngine.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = accounts_api.AccountsApi(api_client)
    path = "Client:" # str | The directory to get the accounts and sub-directories.

    try:
        # Get accounts and sub-directories in a directory
        # example passing only required values which don't have defaults set
        api_response = api_instance.get_accounts(path)

        pprint(api_response)
    except fds.sdk.SPAREngine.ApiException as e:
        print("Exception when calling AccountsApi->get_accounts: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get accounts and sub-directories in a directory
    #     api_response, http_status_code, response_headers = api_instance.get_accounts_with_http_info(path)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.SPAREngine.ApiException as e:
    #     print("Exception when calling AccountsApi->get_accounts: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Get accounts and sub-directories in a directory
    #     async_result = api_instance.get_accounts_async(path)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.SPAREngine.ApiException as e:
    #     print("Exception when calling AccountsApi->get_accounts: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get accounts and sub-directories in a directory
    #     async_result = api_instance.get_accounts_with_http_info_async(path)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.SPAREngine.ApiException as e:
    #     print("Exception when calling AccountsApi->get_accounts: %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.SPAREngine

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.SPAREngine.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.SPAREngine

configuration = fds.sdk.SPAREngine.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.SPAREngine

configuration = fds.sdk.SPAREngine.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.SPAREngine

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

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

STACH extensions

Some methods within this client library are able to return STACH formatted data. Please see the documentation of those endpoints on how to enable and use STACH formatted data.

Documentation of the STACH extension can be found here: stach-extensions and here STACH schema

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	get_accounts	GET /analytics/lookups/v3/accounts/{path}	Get accounts and sub-directories in a directory
AccountsApi	get_spar_returns_type	GET /analytics/engines/spar/v3/accounts/{accountPath}/returns-type	Get SPAR account returns type details
BenchmarksApi	get_spar_benchmark_by_id	GET /analytics/engines/spar/v3/benchmarks	Get SPAR benchmark details
ComponentsApi	get_spar_component_by_id	GET /analytics/engines/spar/v3/components/{id}	Get SPAR component by id
ComponentsApi	get_spar_components	GET /analytics/engines/spar/v3/components	Get SPAR components
CurrenciesApi	get_currencies	GET /analytics/lookups/v3/currencies	Get currencies
DocumentsApi	get_spar3_documents	GET /analytics/engines/spar/v3/documents/{path}	Gets SPAR3 documents and sub-directories in a directory
FrequenciesApi	get_spar_frequencies	GET /analytics/engines/spar/v3/frequencies	Get SPAR frequencies
SPARCalculationsApi	cancel_calculation_by_id	DELETE /analytics/engines/spar/v3/calculations/{id}	Cancel SPAR calculation
SPARCalculationsApi	get_all_calculations	GET /analytics/engines/spar/v3/calculations	Get all calculations
SPARCalculationsApi	get_calculation_parameters	GET /analytics/engines/spar/v3/calculations/{id}	Get SPAR calculation parameters by id
SPARCalculationsApi	get_calculation_status_by_id	GET /analytics/engines/spar/v3/calculations/{id}/status	Get SPAR calculation status by id
SPARCalculationsApi	get_calculation_unit_result_by_id	GET /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result	Get SPAR calculation result by id
SPARCalculationsApi	post_and_calculate	POST /analytics/engines/spar/v3/calculations	Create and Run SPAR calculation
SPARCalculationsApi	put_and_calculate	PUT /analytics/engines/spar/v3/calculations/{id}	Create or Update SPAR calculation and run it.

Documentation For Models

• AccountDirectories
• AccountDirectoriesRoot
• CalculationMeta
• CalculationStatus
• CalculationStatusMeta
• CalculationStatusRoot
• CalculationUnitStatus
• CalculationUnitStatusMeta
• CalculationsSummary
• CalculationsSummaryRoot
• ClientErrorResponse
• ComponentSummary
• ComponentSummaryRoot
• Currency
• CurrencyRoot
• DocumentDirectories
• DocumentDirectoriesRoot
• Error
• ErrorSource
• Frequency
• FrequencyRoot
• ObjectRoot
• PaginationInfo
• PaginationMeta
• ReturnType
• SPARAccounts
• SPARAccountsRoot
• SPARBenchmark
• SPARBenchmarkRoot
• SPARCalculationParameters
• SPARCalculationParametersRoot
• SPARComponent
• SPARComponentRoot
• SPARDateParameters
• SPARIdentifier

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.SPAREngine.apis and fds.sdk.SPAREngine.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.SPAREngine.api.default_api import DefaultApi
• from fds.sdk.SPAREngine.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.SPAREngine
from fds.sdk.SPAREngine.apis import *
from fds.sdk.SPAREngine.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.