Package: fds.sdk.FactSetBenchmarks
FactSet Benchmarks client library for PythonFactSet Benchmarks API gives access to Index Constituents, Prices, Returns, and Ratios. For a sample list of identifiers, use the /metrics endpoint. Equity Only - Fixed Income Benchmark support coming soon.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.8.0Package version: 1.2.2Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.FactSetBenchmarks==1.2.2pippipinstallfds.sdk.utilsfds.sdk.FactSetBenchmarks==1.2.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.FactSetBenchmarksfromfds.sdk.FactSetBenchmarks.apiimportbenchmark_constituents_apifromfds.sdk.FactSetBenchmarks.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.FactSetBenchmarks.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.FactSetBenchmarks.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetBenchmarks.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=benchmark_constituents_api.BenchmarkConstituentsApi(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] | Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of  valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error. <p>***ids limit** =  1 per request*</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="date_example"# str | Date of holding 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.currency="currency_example"# str | Currency for response. (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.calendar="FIVEDAY"# str | Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays. (optional)try:# Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_benchmark_constituents(ids,date=date,currency=currency,calendar=calendar)pprint(api_response)exceptfds.sdk.FactSetBenchmarks.ApiExceptionase:print("Exception when calling BenchmarkConstituentsApi->get_benchmark_constituents:%s\n"%e)# # Get response, http status code and response headers# try:#     # Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.#     api_response, http_status_code, response_headers = api_instance.get_benchmark_constituents_with_http_info(ids, date=date, currency=currency, calendar=calendar)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetBenchmarks.ApiException as e:#     print("Exception when calling BenchmarkConstituentsApi->get_benchmark_constituents: %s\n" % e)# # Get response asynchronous# try:#     # Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.#     async_result = api_instance.get_benchmark_constituents_async(ids, date=date, currency=currency, calendar=calendar)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetBenchmarks.ApiException as e:#     print("Exception when calling BenchmarkConstituentsApi->get_benchmark_constituents: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.#     async_result = api_instance.get_benchmark_constituents_with_http_info_async(ids, date=date, currency=currency, 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.FactSetBenchmarks.ApiException as e:#     print("Exception when calling BenchmarkConstituentsApi->get_benchmark_constituents: %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.FactSetBenchmarkslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetBenchmarks.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.FactSetBenchmarksconfiguration=fds.sdk.FactSetBenchmarks.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.FactSetBenchmarksconfiguration=fds.sdk.FactSetBenchmarks.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionBenchmarkConstituentsApiget_benchmark_constituentsGET/factset-benchmarks/v1/constituentsReturns the requested Benchmark Constituents and respective Weights, Price and Market Value.BenchmarkConstituentsApiget_benchmark_constituents_for_listPOST/factset-benchmarks/v1/constituentsReturns the requested Benchmark Constituents and respective Weights, Price and Market Value.BenchmarkConstituentsApiget_fi_benchmark_constituentsGET/factset-benchmarks/v1/fixed-income-constituentsReturns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value.BenchmarkConstituentsApiget_fi_benchmark_constituents_for_listPOST/factset-benchmarks/v1/fixed-income-constituentsReturns the requested Benchmark Constituents and respective Weights, Price and Market Value.HelperApiget_benchmark_idsGET/factset-benchmarks/v1/id-listReturns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.HelperApiget_benchmark_ids_for_listPOST/factset-benchmarks/v1/id-listReturns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.IndexLevelApiget_benchmark_ratiosGET/factset-benchmarks/v1/ratiosReturns the aggregated ratios of a requested benchmarkIndexLevelApiget_benchmark_ratios_for_listPOST/factset-benchmarks/v1/ratiosReturns the aggregated ratios of a requested benchmarkIndexLevelApiget_index_historyGET/factset-benchmarks/v1/index-historyRetrieves Index Level Prices and Returns information for a list of identifiers and historical date range.IndexLevelApiget_index_history_for_listPOST/factset-benchmarks/v1/index-historyRetrieves Index Level Prices and Returns information for a list of identifiers and historical date range.IndexLevelApiget_index_snapshotGET/factset-benchmarks/v1/index-snapshotIndex Level Prices, Returns, and related information as of a single date.IndexLevelApiget_index_snapshot_for_listPOST/factset-benchmarks/v1/index-snapshotRetrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date.Documentation For ModelsBenchmarkConstituentBenchmarkConstituentsRequestBenchmarkConstituentsResponseBenchmarkIdListBenchmarkIdListRequestBenchmarkIdListResponseBenchmarkRatiosBenchmarkRatiosRequestBenchmarkRatiosResponseCalendarConstituentIdsErrorResponseErrorResponseSubErrorsFIConstituentIdsFamilyFilterFixedIncomeBenchmarkConstituentFixedIncomeBenchmarkConstituentsRequestFixedIncomeBenchmarkConstituentsResponseFrequencyHedgeTypeImpliedDateIndexHistoryIndexHistoryRequestIndexHistoryResponseIndexIdsIndexSnapshotIndexSnapshotRequestIndexSnapshotResponseMetricsPeriodicityReturnTypeDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetBenchmarks.apis and fds.sdk.FactSetBenchmarks.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.FactSetBenchmarks.api.default_api import DefaultApifrom fds.sdk.FactSetBenchmarks.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.FactSetBenchmarks
from fds.sdk.FactSetBenchmarks.apis import *
from fds.sdk.FactSetBenchmarks.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.