Package: fds.sdk.SPAREngine
SPAR Engine client library for PythonAllow clients to fetch Analytics through APIs.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 3.13.4Package version: 1.0.1Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.protobuf.stach.extensionsfds.sdk.SPAREngine==1.0.1pippipinstallfds.sdk.utilsfds.protobuf.stach.extensionsfds.sdk.SPAREngine==1.0.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.SPAREnginefromfds.sdk.SPAREngine.apiimportaccounts_apifromfds.sdk.SPAREngine.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.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 clientwithfds.sdk.SPAREngine.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=accounts_api.AccountsApi(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.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 setapi_response=api_instance.get_accounts(path)pprint(api_response)exceptfds.sdk.SPAREngine.ApiExceptionase: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 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.SPAREnginelogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.SPAREngine.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.SPAREngineconfiguration=fds.sdk.SPAREngine.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.SPAREngineconfiguration=fds.sdk.SPAREngine.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')STACH extensionsSome 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-extensionsand hereSTACH schemaDocumentation for API EndpointsAll URIs are relative tohttps://api.factset.comClassMethodHTTP requestDescriptionAccountsApiget_accountsGET/analytics/lookups/v3/accounts/{path}Get accounts and sub-directories in a directoryAccountsApiget_spar_returns_typeGET/analytics/engines/spar/v3/accounts/{accountPath}/returns-typeGet SPAR account returns type detailsBenchmarksApiget_spar_benchmark_by_idGET/analytics/engines/spar/v3/benchmarksGet SPAR benchmark detailsComponentsApiget_spar_component_by_idGET/analytics/engines/spar/v3/components/{id}Get SPAR component by idComponentsApiget_spar_componentsGET/analytics/engines/spar/v3/componentsGet SPAR componentsCurrenciesApiget_currenciesGET/analytics/lookups/v3/currenciesGet currenciesDocumentsApiget_spar3_documentsGET/analytics/engines/spar/v3/documents/{path}Gets SPAR3 documents and sub-directories in a directoryFrequenciesApiget_spar_frequenciesGET/analytics/engines/spar/v3/frequenciesGet SPAR frequenciesSPARCalculationsApicancel_calculation_by_idDELETE/analytics/engines/spar/v3/calculations/{id}Cancel SPAR calculationSPARCalculationsApiget_all_calculationsGET/analytics/engines/spar/v3/calculationsGet all calculationsSPARCalculationsApiget_calculation_parametersGET/analytics/engines/spar/v3/calculations/{id}Get SPAR calculation parameters by idSPARCalculationsApiget_calculation_status_by_idGET/analytics/engines/spar/v3/calculations/{id}/statusGet SPAR calculation status by idSPARCalculationsApiget_calculation_unit_result_by_idGET/analytics/engines/spar/v3/calculations/{id}/units/{unitId}/resultGet SPAR calculation result by idSPARCalculationsApipost_and_calculatePOST/analytics/engines/spar/v3/calculationsCreate and Run SPAR calculationSPARCalculationsApiput_and_calculatePUT/analytics/engines/spar/v3/calculations/{id}Create or Update SPAR calculation and run it.Documentation For ModelsAccountDirectoriesAccountDirectoriesRootCalculationMetaCalculationStatusCalculationStatusMetaCalculationStatusRootCalculationUnitStatusCalculationUnitStatusMetaCalculationsSummaryCalculationsSummaryRootClientErrorResponseComponentSummaryComponentSummaryRootCurrencyCurrencyRootDocumentDirectoriesDocumentDirectoriesRootErrorErrorSourceFrequencyFrequencyRootObjectRootPaginationInfoPaginationMetaReturnTypeSPARAccountsSPARAccountsRootSPARBenchmarkSPARBenchmarkRootSPARCalculationParametersSPARCalculationParametersRootSPARComponentSPARComponentRootSPARDateParametersSPARIdentifierDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf 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 DefaultApifrom fds.sdk.SPAREngine.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.SPAREngine
from fds.sdk.SPAREngine.apis import *
from fds.sdk.SPAREngine.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.