Package: fds.sdk.FactSetFunds
FactSet Funds client library for PythonFactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States.FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverageFund descriptionsA seven-tier classification systemLeverage informationFees and expensesPortfolio managersFactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverageNet asset valueFund flowsAssets under managementTotal returnThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.1Package version: 1.1.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.FactSetFunds==1.1.0pippipinstallfds.sdk.utilsfds.sdk.FactSetFunds==1.1.0UsageGenerate 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:[!IMPORTANT]
The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.Example Codefromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.FactSetFundsfromfds.sdk.FactSetFunds.apiimportfund_flows__aum_apifromfds.sdk.FactSetFunds.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.FactSetFunds.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.FactSetFunds.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetFunds.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=fund_flows__aum_api.FundFlowsAUMApi(api_client)ids=["MABAX-US"]# [str] | The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <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>*start_date="2018-12-31"# str | The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)end_date="2019-12-31"# str | The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)frequency="M"# str | Controls the display frequency of the data returned.   * **MTD** = Month-To-Date   * **M** = Monthly, based on the last trading day of the month.   * **CQTD** = Calendar Quarter-to-Date   * **CQ** = Calendar Quarterly   * **CYTD** = Calendar Year-to-Date   * **CY** = Calendar Yearly  (optional) if omitted the server will use the default value of "M"currency="USD"# str | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. (optional) if omitted the server will use the default value of "LOCAL"data_type="ROLL"# str | The Data Type of the NAV expressed as Raw or Rolled values. (optional) if omitted the server will use the default value of "ROLL"try:# Get Fund AUM for a requested date range and list of ids# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_funds_aum(ids,start_date=start_date,end_date=end_date,frequency=frequency,currency=currency,data_type=data_type)pprint(api_response)exceptfds.sdk.FactSetFunds.ApiExceptionase:print("Exception when calling FundFlowsAUMApi->get_funds_aum:%s\n"%e)# # Get response, http status code and response headers# try:#     # Get Fund AUM for a requested date range and list of ids#     api_response, http_status_code, response_headers = api_instance.get_funds_aum_with_http_info(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetFunds.ApiException as e:#     print("Exception when calling FundFlowsAUMApi->get_funds_aum: %s\n" % e)# # Get response asynchronous# try:#     # Get Fund AUM for a requested date range and list of ids#     async_result = api_instance.get_funds_aum_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetFunds.ApiException as e:#     print("Exception when calling FundFlowsAUMApi->get_funds_aum: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Get Fund AUM for a requested date range and list of ids#     async_result = api_instance.get_funds_aum_with_http_info_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetFunds.ApiException as e:#     print("Exception when calling FundFlowsAUMApi->get_funds_aum: %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.FactSetFundslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetFunds.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.FactSetFundsconfiguration=fds.sdk.FactSetFunds.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.FactSetFundsconfiguration=fds.sdk.FactSetFunds.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionFundFlowsAUMApiget_funds_aumGET/factset-funds/v1/aumGet Fund AUM for a requested date range and list of idsFundFlowsAUMApiget_funds_aum_for_listPOST/factset-funds/v1/aumGet Fund AUM for a requested date range and large list of idsFundFlowsAUMApiget_funds_flowsGET/factset-funds/v1/flowsGet Fund Flows for a requested date range and list of idsFundFlowsAUMApiget_funds_flows_for_listPOST/factset-funds/v1/flowsGet Fund Flows for a requested date range and large list of idsHelperApiget_statusesGET/factset-funds/v1/statusGet Fund's current status and database availabilityHelperApiget_statuses_for_listPOST/factset-funds/v1/statusGet Fund's current status and database availability for large list of ids.PricesReturnsApiget_funds_pricesGET/factset-funds/v1/pricesGet Fund Prices (NAV) for a requested time-seriesPricesReturnsApiget_funds_prices_for_listPOST/factset-funds/v1/pricesGet Fund Prices (NAV) for a requested date range and large list of ids.PricesReturnsApiget_funds_returnsGET/factset-funds/v1/returnsGet Fund Returns for a requested time-seriesPricesReturnsApiget_funds_returns_for_listPOST/factset-funds/v1/returnsGet Fund Returns for a requested time-series and large list of idsPricesReturnsApiget_funds_returns_rangeGET/factset-funds/v1/returns-rangeGet Fund Returns for a user-defined date rangePricesReturnsApiget_funds_returns_range_for_listPOST/factset-funds/v1/returns-rangeGet Fund Returns over pre-defined time horizons as of a specific date for large list of ids.PricesReturnsApiget_funds_returns_snapshotGET/factset-funds/v1/returns-snapshotGet Fund Returns over pre-defined time horizons as of a specific date.PricesReturnsApiget_funds_returns_snapshot_for_listPOST/factset-funds/v1/returns-snapshotGet Fund Returns over pre-defined time horizons as of a specific date.ReferenceApiget_funds_benchmark_detailsGET/factset-funds/v1/benchmark-detailsGet the Fund's Primary and Segment Benchmark DetailsReferenceApiget_funds_benchmark_details_for_listPOST/factset-funds/v1/benchmark-detailsGet the Fund's Primary and Segment Benchmark details for large list of ids.ReferenceApiget_funds_classificationsGET/factset-funds/v1/classificationsGet basic Fund ClassificationsReferenceApiget_funds_classifications_for_listPOST/factset-funds/v1/classificationsGet basic Fund Classifications for a large list of ids.ReferenceApiget_funds_costs_feesGET/factset-funds/v1/costs-feesGet the Fund's Costs, Investment minimums and Risk, and Fees.ReferenceApiget_funds_costs_fees_for_listPOST/factset-funds/v1/costs-feesGet the Fund's Costs, Investment minimums and Risk, and Fees for large list of ids.ReferenceApiget_funds_managersGET/factset-funds/v1/managersGet a list of Fund Managers and related details for a list of ids.ReferenceApiget_funds_managers_for_listPOST/factset-funds/v1/managersGet a list of Fund Managers and related details for a large list of ids.ReferenceApiget_funds_summaryGET/factset-funds/v1/summaryGet basic reference summary data for a Fund.ReferenceApiget_funds_summary_for_listPOST/factset-funds/v1/summaryGet basic reference data for a large list of Fund ids.ReferenceApiget_related_fundsGET/factset-funds/v1/related-fundsGet a list of Related Funds for a list of Fund ids.ReferenceApiget_related_funds_for_listPOST/factset-funds/v1/related-fundsGet a list of Related Funds for a large list of Fund ids.Documentation For ModelsAumAumRequestAumResponseBenchmarkDetailsBenchmarkDetailsRequestBenchmarkDetailsResponseClassificationsClassificationsRequestClassificationsResponseCostsFeesCostsFeesIdsCostsFeesRequestCostsFeesResponseDataTypeDividendAdjustErrorResponseErrorResponseSubErrorsFlowsFlowsRequestFlowsResponseFrequencyFrequencyAumFundsPricesRequestFundsPricesResponseFundsReturnsRequestFundsReturnsResponseFundsReturnsSnapshotRequestFundsReturnsSnapshotResponseIdsManagersManagersRequestManagersResponsePricesRelatedFundsRelatedFundsRequestRelatedFundsResponseReturnsReturnsRangeReturnsRangeRequestReturnsRangeResponseReturnsSnapshotSplitAdjustStatusesStatusesRequestStatusesResponseSummariesSummariesRequestSummariesResponseDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetFunds.apis and fds.sdk.FactSetFunds.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.FactSetFunds.api.default_api import DefaultApifrom fds.sdk.FactSetFunds.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.FactSetFunds
from fds.sdk.FactSetFunds.apis import *
from fds.sdk.FactSetFunds.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.