Package: fds.sdk.FactSetOwnership
FactSet Ownership client library for PythonFactSet's Fund Ownership API gives access to bothHoldingsandHoldersdata.Factset's Holdings endpoints gives access to all the underlying securities and their position detils held within a given fund. Fund Types supported include Open-End Mutual Funds, Closed-end Mutual Funds, and Exchange Traded Funds. Security Holders information retrieves all "holder types" and their positions across institutions, funds, insiders, and stakeholders.The FactSet Ownership and Mutual Funds database collects global equity ownership data for approximately 50,000 institutions, 60,000 unique Mutual Fund portfolios, and 400,000 Insider/Stake holders from around 110 countries.  For more details review ourData Collectionmethodology.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.1.0Package version: 1.0.8Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.FactSetOwnership==1.0.8pippipinstallfds.sdk.utilsfds.sdk.FactSetOwnership==1.0.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.FactSetOwnershipfromfds.sdk.FactSetOwnership.apiimportfund_holdings_apifromfds.sdk.FactSetOwnership.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.FactSetOwnership.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.FactSetOwnership.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.FactSetOwnership.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=fund_holdings_api.FundHoldingsApi(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=["VTI-USA"]# [str] | List of requested fund identifiers. <p>***ids limit** =  10 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="2019-12-31"# str | Date of holdings expressed in YYYY-MM-DD format. The fund-holdings endpoint will default to latest month-end close. (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.topn="5"# str | Limits number of holdings or holders displayed by the top *n* securities based on positions Market Value. Default is ALL, otherwise use number to limit number. (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.asset_type="EQ"# str | Filter holdings by the following major asset classes -   * **EQ**  = Equity   * **FI** = Fixed Income   * **ALL** = ALL  (optional) if omitted the server will use the default value of "EQ"# 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 prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470). (optional)try:# Get underlying holdings information for a requested fund identifer.# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_ownership_holdings(ids,date=date,topn=topn,asset_type=asset_type,currency=currency)pprint(api_response)exceptfds.sdk.FactSetOwnership.ApiExceptionase:print("Exception when calling FundHoldingsApi->get_ownership_holdings:%s\n"%e)# # Get response, http status code and response headers# try:#     # Get underlying holdings information for a requested fund identifer.#     api_response, http_status_code, response_headers = api_instance.get_ownership_holdings_with_http_info(ids, date=date, topn=topn, asset_type=asset_type, currency=currency)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.FactSetOwnership.ApiException as e:#     print("Exception when calling FundHoldingsApi->get_ownership_holdings: %s\n" % e)# # Get response asynchronous# try:#     # Get underlying holdings information for a requested fund identifer.#     async_result = api_instance.get_ownership_holdings_async(ids, date=date, topn=topn, asset_type=asset_type, currency=currency)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.FactSetOwnership.ApiException as e:#     print("Exception when calling FundHoldingsApi->get_ownership_holdings: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Get underlying holdings information for a requested fund identifer.#     async_result = api_instance.get_ownership_holdings_with_http_info_async(ids, date=date, topn=topn, asset_type=asset_type, 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.FactSetOwnership.ApiException as e:#     print("Exception when calling FundHoldingsApi->get_ownership_holdings: %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.FactSetOwnershiplogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.FactSetOwnership.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.FactSetOwnershipconfiguration=fds.sdk.FactSetOwnership.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.FactSetOwnershipconfiguration=fds.sdk.FactSetOwnership.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/contentClassMethodHTTP requestDescriptionFundHoldingsApiget_ownership_holdingsGET/factset-ownership/v1/fund-holdingsGet underlying holdings information for a requested fund identifer.FundHoldingsApipost_ownership_holdingsPOST/factset-ownership/v1/fund-holdingsGet holdings for a list of funds.SecurityHoldersApiget_security_holdersGET/factset-ownership/v1/security-holdersGet security ownership data for requested security identifers.SecurityHoldersApipost_security_holdersPOST/factset-ownership/v1/security-holdersGet security ownership data for a list of requested securities.Documentation For ModelsAssetTypeErrorResponseErrorResponseSubErrorsFundHoldingFundHoldingsRequestFundHoldingsResponseHolderTypeIdFundHoldingsIdHoldersSecurityHoldersSecurityHoldersRequestSecurityHoldersResponseDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.FactSetOwnership.apis and fds.sdk.FactSetOwnership.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.FactSetOwnership.api.default_api import DefaultApifrom fds.sdk.FactSetOwnership.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.FactSetOwnership
from fds.sdk.FactSetOwnership.apis import *
from fds.sdk.FactSetOwnership.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.