Package: fds.sdk.Portfolio
Portfolio client library for PythonAllow clients to fetch ModelAccounts Analytics through APIs.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 3Package version: 0.21.9Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.Portfolio==0.21.9pippipinstallfds.sdk.utilsfds.sdk.Portfolio==0.21.9UsageGenerate 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.Portfoliofromfds.sdk.Portfolio.apiimportmodel_accounts_apifromfds.sdk.Portfolio.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.Portfolio.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.Portfolio.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.Portfolio.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=model_accounts_api.ModelAccountsApi(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.name="name_example"# str | The path and filename of the model account to create or update# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.model_account_fields_root=ModelAccountFieldsRoot(data=ModelAccountFields(iterative={"key":{"key":{"key":"key_example",},},},non_iterative={"key":{"key":"key_example",},},additional_fields=[ModelAccountAdditionalField(iteration=True,name="name_example",type="type_example",description="description_example",split_direction="split_direction_example",size=1,code_page_flag="code_page_flag_example",),],),meta={"key":"key_example",},)# ModelAccountFieldsRoot | The object containing the input values (optional)try:# Create or update an existing model account# example passing only required values which don't have defaults set# and optional valuesapi_instance.create_or_update_model_account(name,model_account_fields_root=model_account_fields_root)exceptfds.sdk.Portfolio.ApiExceptionase:print("Exception when calling ModelAccountsApi->create_or_update_model_account:%s\n"%e)# # Get response, http status code and response headers# try:#     # Create or update an existing model account#     api_response, http_status_code, response_headers = api_instance.create_or_update_model_account_with_http_info(name, model_account_fields_root=model_account_fields_root)# except fds.sdk.Portfolio.ApiException as e:#     print("Exception when calling ModelAccountsApi->create_or_update_model_account: %s\n" % e)# # Get response asynchronous# try:#     # Create or update an existing model account#     async_result = api_instance.create_or_update_model_account_async(name, model_account_fields_root=model_account_fields_root)# except fds.sdk.Portfolio.ApiException as e:#     print("Exception when calling ModelAccountsApi->create_or_update_model_account: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Create or update an existing model account#     async_result = api_instance.create_or_update_model_account_with_http_info_async(name, model_account_fields_root=model_account_fields_root)# except fds.sdk.Portfolio.ApiException as e:#     print("Exception when calling ModelAccountsApi->create_or_update_model_account: %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.Portfoliologging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.Portfolio.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.Portfolioconfiguration=fds.sdk.Portfolio.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.Portfolioconfiguration=fds.sdk.Portfolio.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.comClassMethodHTTP requestDescriptionModelAccountsApicreate_or_update_model_accountPUT/analytics/accounts/v3/models/{name}Create or update an existing model accountModelAccountsApidelete_a_model_accountDELETE/analytics/accounts/v3/models/{name}Delete model account, takes an account path and name and deletes it.ModelAccountsApidelete_model_account_by_dateDELETE/analytics/accounts/v3/models/{name}/dates/{date}Delete all entries for a date or specific symbol entries for a date from a previously created account.ModelAccountsApidelete_model_account_by_symbolDELETE/analytics/accounts/v3/models/{name}/symbols/{symbol}Delete all entries for a symbol or specific date entries for a symbol from a previously created account.ModelAccountsApiget_accountGET/analytics/accounts/v3/models/{name}Get account endpoint, takes an account name and returns underlying dataModelAccountsApiget_account_for_dateGET/analytics/accounts/v3/models/{name}/dates/{date}Get account endpoint, takes an account name, date and returns underlying data for that dateModelAccountsApiget_account_for_date_and_symbolGET/analytics/accounts/v3/models/{name}/dates/{date}/symbols/{symbol}Get account endpoint, takes an account name and returns underlying dataModelAccountsApiget_account_for_symbolGET/analytics/accounts/v3/models/{name}/symbols/{symbol}Get account endpoint, takes an account name, symbol and returns underlying data for that symbolModelAccountsApiget_account_schemaGET/analytics/accounts/v3/models/{name}/schemaGet account schema endpoint, takes an account name and returns its schemaDocumentation For ModelsClientErrorResponseDataAndMetaModelErrorErrorSourceModelAccountAdditionalFieldModelAccountFieldsModelAccountFieldsRootDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.Portfolio.apis and fds.sdk.Portfolio.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.Portfolio.api.default_api import DefaultApifrom fds.sdk.Portfolio.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.Portfolio
from fds.sdk.Portfolio.apis import *
from fds.sdk.Portfolio.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.