fds.sdk.ModelPortfolio 0.21.0

Model Portfolio client library for Python

Model Portfolio client library for Python

Allow clients to fetch ModelAccounts Analytics through APIs.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3
• Package version: 0.21.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.ModelPortfolio

pip

pip install fds.sdk.utils fds.sdk.ModelPortfolio

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.ModelPortfolio
from fds.sdk.ModelPortfolio.api import model_accounts_api
from fds.sdk.ModelPortfolio.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# 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
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.ModelPortfolio.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.ModelPortfolio.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.ModelPortfolio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = model_accounts_api.ModelAccountsApi(api_client)
    name = "name_example" # str | The path and filename of the model account to create or update
    model_account_fields_root = ModelAccountFieldsRoot(
        data=ModelAccountFields(
            iterative={
                "key": {
                    "key": {
                        "key": {},
                    },
                },
            },
            non_iterative={
                "key": {
                    "key": {},
                },
            },
            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
        api_instance.create_or_update_model_account(name, model_account_fields_root=model_account_fields_root)
    except fds.sdk.ModelPortfolio.ApiException as e:
        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.ModelPortfolio.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.ModelPortfolio.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.ModelPortfolio.ApiException as e:
    #     print("Exception when calling ModelAccountsApi->create_or_update_model_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.factset.com

Class	Method	HTTP request	Description
ModelAccountsApi	create_or_update_model_account	PUT /analytics/accounts/v3/models/{name}	Create or update an existing model account
ModelAccountsApi	delete_a_model_account	DELETE /analytics/accounts/v3/models/{name}	Delete model account, takes an account path and name and deletes it.
ModelAccountsApi	get_account_for_date	GET /analytics/accounts/v3/models/{name}/dates/{date}	Get account endpoint, takes an account name, date and returns underlying data for that date
ModelAccountsApi	get_account_for_date_and_symbol	GET /analytics/accounts/v3/models/{name}/dates/{date}/symbols/{symbol}	Get account endpoint, takes an account name and returns underlying data
ModelAccountsApi	get_account_for_symbol	GET /analytics/accounts/v3/models/{name}/symbols/{symbol}	Get account endpoint, takes an account name, symbol and returns underlying data for that symbol
ModelAccountsApi	get_account_schema	GET /analytics/accounts/v3/models/{name}/schema	Get account schema endpoint, takes an account name and returns its schema

Documentation For Models

• ModelAccountAdditionalField
• ModelAccountFields
• ModelAccountFieldsRoot
• ProblemDetails

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.ModelPortfolio.apis and fds.sdk.ModelPortfolio.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.ModelPortfolio.api.default_api import DefaultApi
• from fds.sdk.ModelPortfolio.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.ModelPortfolio
from fds.sdk.ModelPortfolio.apis import *
from fds.sdk.ModelPortfolio.models import *

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed 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 at

http://www.apache.org/licenses/LICENSE-2.0

Unless 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.