Package: fds.sdk.FactSetGeoRev
FactSet GeoRev client library for PythonFactSet Revere Geographic Revenue ("GeoRev") Exposure data provides a highly structured and normalized display of companies’ revenues by geography. Using a four level taxonomy structure, understand the companies' Super-Region-->Region-->Area-->Country revenue breakdowns. Quickly understand a company’s revenue exposure in countries impacted by geopolitical, macroeconomic, and market risk. Understand the geographic footprint of a company based on sources of revenue versus country of domicile, and analyze global revenue exposures at the company, index, or portfolio level.Geographic revenue has historically been difficult to analyze due to companies’ non-standard and incomplete reporting. Investors relying solely on this as-reported data are limited in their ability to compare, aggregate or screen exposures across a universe or portfolio of companies. To achieve normalization, FactSet GeoRev captures data through a proprietary four-level geographic classification structure. An estimation algorithm based on GDP weighting and accounting logic is then applied to solve for any non-explicit disclosures. The result is a consistent, accurate, and flexible dataset that can take a company’s revenues and break them down into any geographic country or region categories.As markets become more integrated and companies expand operations beyond their domestic markets, GeoRev provides a new and valuable country factor to help investors discover alpha, model risk exposure, optimize portfolio weighting, and improve fund administration and reporting.Data Frequency -  Annual; Update Frequency - Daily. 49,000+ Publically Listed Companies. All Russell 3000 and MSCI ACWI Index Consituents. U.S. Data is available from 2003, with Non-US data from 2007. For more details, visitOA 17555This 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.FactSetGeoRev==1.0.7pippipinstallfds.sdk.utilsfds.sdk.FactSetGeoRev==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.FactSetGeoRevfromfds.sdk.FactSetGeoRev.apiimportcountries_apifromfds.sdk.FactSetGeoRev.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.FactSetGeoRev.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.FactSetGeoRev.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetGeoRev.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=countries_api.CountriesApi(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-USA"]# [str] | Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. <p>***ids limit** =  300 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.country_ids=["US","CN"]# [str] | The Country ISO2 Codes representing the Country requested. By default, the service will request *ALL* Countries. To limit the Countries returned in the response, provide a comma-separated list of the ISO2 Country Codes. Visit [OA 8754](https://my.apps.factset.com/oa/pages/8754) for a full list of ISO2 codes.  (optional) if omitted the server will use the default value of ["ALL"]# 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="2018-12-31"# str | The start date requested for a given date range in **YYYY-MM-DD** format. Data is available on a Fiscal Annual periodicity and updated Daily. If left blank, the API will default to latest available fiscal period. Future dates (T+1) are not accepted in this endpoint.  (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="2019-12-31"# str | The end date requested for a given date range in **YYYY-MM-DD** format. Data is available on a Fiscal Annual periodicity and updated daily. If left blank, the API will default to latest available fiscal period. Future dates (T+1) are not accepted in this endpoint.  (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="FY"# 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).   * **FQ** = Fiscal Quarter of the company.   * **AY** = Actual Annual, based on the start date.   * **CY** = Calendar Annual, based on the last trading day of the calendar year.   * **FY** = Fiscal Annual, based on the last trading day of the company's fiscal year.     (optional) if omitted the server will use the default value of "FY"# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.currency="USD"# str | Currency code for adjusting the data. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470). (optional)try:# Gets the revenue details for the requested Countries.# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_countries(ids,country_ids=country_ids,start_date=start_date,end_date=end_date,frequency=frequency,currency=currency)pprint(api_response)exceptfds.sdk.FactSetGeoRev.ApiExceptionase:print("Exception when calling CountriesApi->get_countries:%s\n"%e)# # Get response, http status code and response headers# try:#     # Gets the revenue details for the requested Countries.#     api_response, http_status_code, response_headers = api_instance.get_countries_with_http_info(ids, country_ids=country_ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetGeoRev.ApiException as e:#     print("Exception when calling CountriesApi->get_countries: %s\n" % e)# # Get response asynchronous# try:#     # Gets the revenue details for the requested Countries.#     async_result = api_instance.get_countries_async(ids, country_ids=country_ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetGeoRev.ApiException as e:#     print("Exception when calling CountriesApi->get_countries: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Gets the revenue details for the requested Countries.#     async_result = api_instance.get_countries_with_http_info_async(ids, country_ids=country_ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetGeoRev.ApiException as e:#     print("Exception when calling CountriesApi->get_countries: %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.FactSetGeoRevlogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetGeoRev.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.FactSetGeoRevconfiguration=fds.sdk.FactSetGeoRev.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.FactSetGeoRevconfiguration=fds.sdk.FactSetGeoRev.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionCountriesApiget_countriesGET/factset-georev/v1/countriesGets the revenue details for the requested Countries.CountriesApiget_countries_for_listPOST/factset-georev/v1/countriesGets the revenue details for the requested Countries. Use for large lists of ids.RegionsApiget_regionsGET/factset-georev/v1/regionsGets the revenue details for the requested RegionsRegionsApiget_regions_for_listPOST/factset-georev/v1/regionsGets the revenue details for the requested Regions. Use for large lists of company ids.Documentation For ModelsCountryCountryIdsCountryRequestCountryResponseErrorResponseErrorResponseSubErrorsFrequencyIdsRegionRegionIdsRegionRequestRegionResponseDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetGeoRev.apis and fds.sdk.FactSetGeoRev.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.FactSetGeoRev.api.default_api import DefaultApifrom fds.sdk.FactSetGeoRev.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.FactSetGeoRev
from fds.sdk.FactSetGeoRev.apis import *
from fds.sdk.FactSetGeoRev.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.