Package: fds.sdk.Classifications
Classifications client library for PythonThe Classifications API gives access to various Industry Classifications for a given list of securities. Beginning first with GICS Direct, the service will then expand to offering NAICS, SIC, RBICS, and more.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.1Package version: 1.0.7Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.Classifications==1.0.7pippipinstallfds.sdk.utilsfds.sdk.Classifications==1.0.7UsageGenerate 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.Classificationsfromfds.sdk.Classifications.apiimportgics_apifromfds.sdk.Classifications.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.Classifications.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.Classifications.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.Classifications.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=gics_api.GICSApi(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=["ids_example",]# [str] | The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** =  1000 per 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>*# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.start_date="startDate_example"# str | Requested start date expressed in YYYY-MM-DD format. (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.end_date="endDate_example"# str | Requested End Date for Range expressed in YYYY-MM-DD format. (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.frequency="M"# str | Controls the display frequency of the data returned.   * **D** = Daily   * **W** = Weekly, based on the last day of the week of the start date.   * **M** = Monthly, based on the last trading day of the month.   * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).   * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).   * **AY** = Actual Annual, based on the start date.   * **CY** = Calendar Annual, based on the last trading day of the calendar year.  (optional) if omitted the server will use the default value of "M"# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.calendar="FIVEDAY"# str | Calendar of data returned. SEVENDAY includes weekends. (optional) if omitted the server will use the default value of "FIVEDAY"try:# Gets the GICS Direct Classifications# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_gics(ids,start_date=start_date,end_date=end_date,frequency=frequency,calendar=calendar)pprint(api_response)exceptfds.sdk.Classifications.ApiExceptionase:print("Exception when calling GICSApi->get_gics:%s\n"%e)# # Get response, http status code and response headers# try:#     # Gets the GICS Direct Classifications#     api_response, http_status_code, response_headers = api_instance.get_gics_with_http_info(ids, start_date=start_date, end_date=end_date, frequency=frequency, calendar=calendar)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.Classifications.ApiException as e:#     print("Exception when calling GICSApi->get_gics: %s\n" % e)# # Get response asynchronous# try:#     # Gets the GICS Direct Classifications#     async_result = api_instance.get_gics_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, calendar=calendar)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.Classifications.ApiException as e:#     print("Exception when calling GICSApi->get_gics: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Gets the GICS Direct Classifications#     async_result = api_instance.get_gics_with_http_info_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, calendar=calendar)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.Classifications.ApiException as e:#     print("Exception when calling GICSApi->get_gics: %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.Classificationslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.Classifications.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.Classificationsconfiguration=fds.sdk.Classifications.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.Classificationsconfiguration=fds.sdk.Classifications.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionGICSApiget_gicsGET/classifications/v1/gicsGets the GICS Direct ClassificationsGICSApipost_gicsPOST/classifications/v1/gicsReturns the GICS classifications for the requested 'ids' and date range.Documentation For ModelsCalendarErrorResponseErrorResponseSubErrorsFrequencyGicsGicsRequestGicsResponseIdsDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.Classifications.apis and fds.sdk.Classifications.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.Classifications.api.default_api import DefaultApifrom fds.sdk.Classifications.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.Classifications
from fds.sdk.Classifications.apis import *
from fds.sdk.Classifications.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.