Package: fds.sdk.FactSetRBICS
FactSet RBICS client library for PythonFactSet Revere Business Industry Classification System (RBICS) is a comprehensive structured taxonomy to classify companies by what they primarily do. It delivers a granular view for investors by classifying companies using a bottom-up approach according to the products and services they provide. By combining this approach with a top-level grouping based on companies' behavior similarities and stock co-movement, FactSet RBICS delivers unprecedented precision for 1,400+ sector groups.RBICS Focus is a six level classification which highlights the companys main business. It is based on the company business line/s that stand for majority of a the revenue that the company generates. Updated monthly. For more details, visitOnline Assitant Page #20710.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.1.0Package version: 0.21.8Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.FactSetRBICS==0.21.8pippipinstallfds.sdk.utilsfds.sdk.FactSetRBICS==0.21.8UsageGenerate 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.FactSetRBICSfromfds.sdk.FactSetRBICS.apiimportentity_focus_apifromfds.sdk.FactSetRBICS.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.FactSetRBICS.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.FactSetRBICS.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetRBICS.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=entity_focus_api.EntityFocusApi(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] | List of Company identifiers. Accepted identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet Permanent Ids, such as -R, -L, or -E.<p>**ids limit = 2500 per request**</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># NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.date="2017-07-24"# str | Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity. (optional)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.levels=[1,3,6]# [int] | List of RBICS industry levels to include in the response. **By default if left blank, all levels are returned.** (optional)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.include_names=True# bool | Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. (optional) if omitted the server will use the default value of Truetry:# Get RBICS classification for the Focus industry# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_rbics_entity_focus(ids,date=date,levels=levels,include_names=include_names)pprint(api_response)exceptfds.sdk.FactSetRBICS.ApiExceptionase:print("Exception when calling EntityFocusApi->get_rbics_entity_focus:%s\n"%e)# # Get response, http status code and response headers# try:#     # Get RBICS classification for the Focus industry#     api_response, http_status_code, response_headers = api_instance.get_rbics_entity_focus_with_http_info(ids, date=date, levels=levels, include_names=include_names)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetRBICS.ApiException as e:#     print("Exception when calling EntityFocusApi->get_rbics_entity_focus: %s\n" % e)# # Get response asynchronous# try:#     # Get RBICS classification for the Focus industry#     async_result = api_instance.get_rbics_entity_focus_async(ids, date=date, levels=levels, include_names=include_names)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetRBICS.ApiException as e:#     print("Exception when calling EntityFocusApi->get_rbics_entity_focus: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Get RBICS classification for the Focus industry#     async_result = api_instance.get_rbics_entity_focus_with_http_info_async(ids, date=date, levels=levels, include_names=include_names)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetRBICS.ApiException as e:#     print("Exception when calling EntityFocusApi->get_rbics_entity_focus: %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.FactSetRBICSlogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetRBICS.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.FactSetRBICSconfiguration=fds.sdk.FactSetRBICS.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.FactSetRBICSconfiguration=fds.sdk.FactSetRBICS.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionEntityFocusApiget_rbics_entity_focusGET/factset-rbics/v1/entity-focusGet RBICS classification for the Focus industryEntityFocusApiget_rbics_entity_focus_for_listPOST/factset-rbics/v1/entity-focusGet RBICS classification for the Focus industryStructureApiget_rbics_structureGET/factset-rbics/v1/structureGet the full RBICS Taxonomy Structure Ids, Names, and effective periods.StructureApiget_rbics_structure_for_listPOST/factset-rbics/v1/structureGet the full RBICS Taxonomy Structure Ids, Names, and effective periods.Documentation For ModelsEntityFocusEntityFocusRequestEntityFocusResponseErrorResponseErrorResponseSubErrorsIdsLevelStructureLevelsRbicsIdsStructureStructureRequestStructureResponseDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetRBICS.apis and fds.sdk.FactSetRBICS.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.FactSetRBICS.api.default_api import DefaultApifrom fds.sdk.FactSetRBICS.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.FactSetRBICS
from fds.sdk.FactSetRBICS.apis import *
from fds.sdk.FactSetRBICS.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.