Package: fds.sdk.FactSetEntity
FactSet Entity client library for PythonUsing an entity centric data model, FactSet's Entity API provides access to
FactSet's complete security and entity level symbology, comprehensive entity reference data, and all of the
necessary relationships and connections to create a foundation that tightly correlates disparate sources of
information to a master entity identifier. Use this API to quickly understand the full entity structure and related securities.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.4.0Package version: 1.1.2Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.FactSetEntity==1.1.2pippipinstallfds.sdk.utilsfds.sdk.FactSetEntity==1.1.2UsageGenerate 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.FactSetEntityfromfds.sdk.FactSetEntity.apiimportentity_reference_apifromfds.sdk.FactSetEntity.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.FactSetEntity.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.FactSetEntity.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetEntity.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=entity_reference_api.EntityReferenceApi(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.ids=["AAPL-US","0FPWZZ-E","TSLA-US"]# [str] | The requested Market Identifier. Accepted input identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet Permanent Ids, such as -R, -L, or -E.<p>**Max Ids Limit set to 3000 in a single request**</p>   *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids,       which may lead to exceeding this request line limit of 8KB, its       advised for any requests with large request lines to be requested through       the respective \\\"POST\\\" method.</p>*try:# Returns an entity reference profiles for an individual entity# example passing only required values which don't have defaults setapi_response=api_instance.get_entity_references(ids)pprint(api_response)exceptfds.sdk.FactSetEntity.ApiExceptionase:print("Exception when calling EntityReferenceApi->get_entity_references:%s\n"%e)# # Get response, http status code and response headers# try:#     # Returns an entity reference profiles for an individual entity#     api_response, http_status_code, response_headers = api_instance.get_entity_references_with_http_info(ids)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetEntity.ApiException as e:#     print("Exception when calling EntityReferenceApi->get_entity_references: %s\n" % e)# # Get response asynchronous# try:#     # Returns an entity reference profiles for an individual entity#     async_result = api_instance.get_entity_references_async(ids)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetEntity.ApiException as e:#     print("Exception when calling EntityReferenceApi->get_entity_references: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Returns an entity reference profiles for an individual entity#     async_result = api_instance.get_entity_references_with_http_info_async(ids)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetEntity.ApiException as e:#     print("Exception when calling EntityReferenceApi->get_entity_references: %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.FactSetEntitylogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetEntity.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.FactSetEntityconfiguration=fds.sdk.FactSetEntity.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.FactSetEntityconfiguration=fds.sdk.FactSetEntity.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionEntityReferenceApiget_entity_referencesGET/factset-entity/v1/entity-referencesReturns an entity reference profiles for an individual entityEntityReferenceApipost_entity_referencesPOST/factset-entity/v1/entity-referencesReturns an entity reference data for a list of ids.EntityReferenceChineseApiget_entity_reference_chiGET/factset-entity/v1/entity-reference-chiReturns entity reference data in Chinese for an individual entity.EntityReferenceChineseApiget_entity_reference_chi_for_listPOST/factset-entity/v1/entity-reference-chiReturns entity reference data in Chinese for an individual entity.EntitySecuritiesApiget_entity_securitiesGET/factset-entity/v1/entity-securitiesReturns all Equity Exchange Listings and all debt instruments issued for the requested entity.EntitySecuritiesApipost_entity_securitiesPOST/factset-entity/v1/entity-securitiesReturns all Equity Exchange Listings and all debt instruments issued for the requested entity.EntityStructureApiget_entity_structureGET/factset-entity/v1/entity-structuresReturns all active or inactive entities and respective levels below the requested entity id.EntityStructureApiget_ultimate_entity_structureGET/factset-entity/v1/ultimate-entity-structuresReturns the full ultimate parent entity hiearachy. Control levels and active status of underlying entities.EntityStructureApipost_entity_structurePOST/factset-entity/v1/entity-structuresReturns all active or inactive entities below the requested entity id.EntityStructureApipost_ultimate_entity_structurePOST/factset-entity/v1/ultimate-entity-structuresReturns all active or inactive entities and respective levels below the requested entity id.HistoricalCreditParentApiget_hist_cred_parentGET/factset-entity/v1/hist-credit-parentReturns historical credit parents for the requested id(s).HistoricalCreditParentApipost_hist_cred_parentPOST/factset-entity/v1/hist-credit-parentReturns historical credit parents for the requested id(s).Documentation For ModelsActiveCreditParentCreditParentRequestCreditParentResponseEntityReferenceEntityReferenceChiEntityReferenceChiRequestEntityReferenceChiResponseEntityReferenceRequestEntityReferenceResponseEntitySecuritiesEntitySecuritiesRequestEntitySecuritiesResponseEntityStructureEntityStructureRequestEntityStructureResponseErrorResponseErrorResponseSubErrorsHcpIdsIdsIdsChiSecurityTypeStructureIdsUltimateEntityStructureRequestUltimateEntityStructureResponseUtlimateEntityStructureDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetEntity.apis and fds.sdk.FactSetEntity.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.FactSetEntity.api.default_api import DefaultApifrom fds.sdk.FactSetEntity.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.FactSetEntity
from fds.sdk.FactSetEntity.apis import *
from fds.sdk.FactSetEntity.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.