Metadata-Version: 2.1
Name: fds.sdk.VirtualPortfolioAPIforDigitalPortals
Version: 0.9.2
Summary: Virtual Portfolio API for Digital Portals client library for Python
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VirtualPortfolioAPIforDigitalPortals/v1
Author: FactSet Research Systems
License: Apache-2.0
Keywords: FactSet,API,SDK
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3 (>=1.25.3)
Requires-Dist: python-dateutil
Requires-Dist: fds.sdk.utils (>=1.0.0)

<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">

# Virtual Portfolio API for Digital Portals client library for Python

[![PyPi](https://img.shields.io/pypi/v/fds.sdk.VirtualPortfolioAPIforDigitalPortals)](https://pypi.org/project/fds.sdk.VirtualPortfolioAPIforDigitalPortals/)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 0.9.2
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements

* Python >= 3.6

## Installation

### Poetry

```shell
poetry add fds.sdk.utils fds.sdk.VirtualPortfolioAPIforDigitalPortals
```

### pip

```shell
pip install fds.sdk.utils fds.sdk.VirtualPortfolioAPIforDigitalPortals
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Python environment.
   1. Install and activate python 3.6+. If you're using [pyenv](https://github.com/pyenv/pyenv):

      ```sh
      pyenv install 3.9.7
      pyenv shell 3.9.7
      ```

   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
3. [Install dependencies](#installation).
4. Run the following:

```python

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.VirtualPortfolioAPIforDigitalPortals
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.api import portfolio_api
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object1 import InlineObject1
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object2 import InlineObject2
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object3 import InlineObject3
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object4 import InlineObject4
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object5 import InlineObject5
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object6 import InlineObject6
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object7 import InlineObject7
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_object8 import InlineObject8
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2004 import InlineResponse2004
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2005 import InlineResponse2005
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2006 import InlineResponse2006
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2007 import InlineResponse2007
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2008 import InlineResponse2008
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2009 import InlineResponse2009
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response201 import InlineResponse201
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.model.inline_response2011 import InlineResponse2011
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.VirtualPortfolioAPIforDigitalPortals.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.VirtualPortfolioAPIforDigitalPortals.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = portfolio_api.PortfolioApi(api_client)
    body = InlineObject(
        data=PortfolioCreateData(
            name="H",
            currency=PortfolioCreateDataCurrency(
                iso_code="EUR",
            ),
        ),
        meta=PortfolioCreateMeta(
            attributes=AttributesMember([
                "attributes_example",
            ]),
        ),
    ) # InlineObject | 

    # Get response
    try:
        # Create a portfolio.
        api_response = api_instance.portfolio_create_post(body)
        pprint(api_response)
    except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
        print("Exception when calling PortfolioApi->portfolio_create_post: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Create a portfolio.
    #     api_response, http_status_code, response_headers = api_instance.portfolio_create_post_with_http_info(body)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PortfolioApi->portfolio_create_post: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Create a portfolio.
    #     async_result = api_instance.portfolio_create_post_async(body)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PortfolioApi->portfolio_create_post: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Create a portfolio.
    #     async_result = api_instance.portfolio_create_post_with_http_info_async(body)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PortfolioApi->portfolio_create_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://api-sandbox.factset.com/wealth/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PortfolioApi* | [**portfolio_create_post**](docs/PortfolioApi.md#portfolio_create_post) | **POST** /portfolio/create | Create a portfolio.
*PortfolioApi* | [**portfolio_delete_post**](docs/PortfolioApi.md#portfolio_delete_post) | **POST** /portfolio/delete | Delete a portfolio.
*PortfolioApi* | [**portfolio_evaluation_list_post**](docs/PortfolioApi.md#portfolio_evaluation_list_post) | **POST** /portfolio/evaluation/list | Evaluate a portfolio.
*PortfolioApi* | [**portfolio_get_get**](docs/PortfolioApi.md#portfolio_get_get) | **GET** /portfolio/get | Details of a portfolio.
*PortfolioApi* | [**portfolio_list_get**](docs/PortfolioApi.md#portfolio_list_get) | **GET** /portfolio/list | List of portfolios with keyfigures.
*PortfolioApi* | [**portfolio_modify_post**](docs/PortfolioApi.md#portfolio_modify_post) | **POST** /portfolio/modify | Modify a portfolio.
*PortfolioApi* | [**portfolio_name_list_get**](docs/PortfolioApi.md#portfolio_name_list_get) | **GET** /portfolio/name/list | List of portfolios.
*PortfolioApi* | [**portfolio_position_list_get**](docs/PortfolioApi.md#portfolio_position_list_get) | **GET** /portfolio/position/list | List all positions of a portfolio.
*PortfolioApi* | [**portfolio_transaction_cash_create_post**](docs/PortfolioApi.md#portfolio_transaction_cash_create_post) | **POST** /portfolio/transaction/cash/create | Add a cash transaction to a portfolio.
*PortfolioApi* | [**portfolio_transaction_cash_delete_post**](docs/PortfolioApi.md#portfolio_transaction_cash_delete_post) | **POST** /portfolio/transaction/cash/delete | Delete a cash transaction.
*PortfolioApi* | [**portfolio_transaction_create_post**](docs/PortfolioApi.md#portfolio_transaction_create_post) | **POST** /portfolio/transaction/create | Add a transaction to a portfolio.
*PortfolioApi* | [**portfolio_transaction_delete_post**](docs/PortfolioApi.md#portfolio_transaction_delete_post) | **POST** /portfolio/transaction/delete | Delete a transaction of a portfolio.
*PortfolioApi* | [**portfolio_transaction_list_get**](docs/PortfolioApi.md#portfolio_transaction_list_get) | **GET** /portfolio/transaction/list | List of transactions in a portfolio.
*PortfolioApi* | [**portfolio_transaction_modify_post**](docs/PortfolioApi.md#portfolio_transaction_modify_post) | **POST** /portfolio/transaction/modify | Modify a transaction in a portfolio.
*WatchlistApi* | [**watchlist_create_post**](docs/WatchlistApi.md#watchlist_create_post) | **POST** /watchlist/create | Create a watchlist.
*WatchlistApi* | [**watchlist_delete_post**](docs/WatchlistApi.md#watchlist_delete_post) | **POST** /watchlist/delete | Delete a watchlist.
*WatchlistApi* | [**watchlist_list_get**](docs/WatchlistApi.md#watchlist_list_get) | **GET** /watchlist/list | List of watchlists.
*WatchlistApi* | [**watchlist_modify_post**](docs/WatchlistApi.md#watchlist_modify_post) | **POST** /watchlist/modify | Modify a watchlist.
*WatchlistApi* | [**watchlist_position_create_post**](docs/WatchlistApi.md#watchlist_position_create_post) | **POST** /watchlist/position/create | Add a position to a watchlist.
*WatchlistApi* | [**watchlist_position_delete_post**](docs/WatchlistApi.md#watchlist_position_delete_post) | **POST** /watchlist/position/delete | Delete a position of a watchlist.
*WatchlistApi* | [**watchlist_position_list_get**](docs/WatchlistApi.md#watchlist_position_list_get) | **GET** /watchlist/position/list | List of positions of a watchlist.
*WatchlistApi* | [**watchlist_position_modify_post**](docs/WatchlistApi.md#watchlist_position_modify_post) | **POST** /watchlist/position/modify | Modify a position in a watchlist.


## Documentation For Models

 - [AttributesMember](docs/AttributesMember.md)
 - [CursorBasedPaginationOutputObject](docs/CursorBasedPaginationOutputObject.md)
 - [CursorBasedPaginationOutputObjectWithoutTotal](docs/CursorBasedPaginationOutputObjectWithoutTotal.md)
 - [ErrorMetaObject](docs/ErrorMetaObject.md)
 - [ErrorObject](docs/ErrorObject.md)
 - [InlineObject](docs/InlineObject.md)
 - [InlineObject1](docs/InlineObject1.md)
 - [InlineObject10](docs/InlineObject10.md)
 - [InlineObject11](docs/InlineObject11.md)
 - [InlineObject12](docs/InlineObject12.md)
 - [InlineObject13](docs/InlineObject13.md)
 - [InlineObject14](docs/InlineObject14.md)
 - [InlineObject2](docs/InlineObject2.md)
 - [InlineObject3](docs/InlineObject3.md)
 - [InlineObject4](docs/InlineObject4.md)
 - [InlineObject5](docs/InlineObject5.md)
 - [InlineObject6](docs/InlineObject6.md)
 - [InlineObject7](docs/InlineObject7.md)
 - [InlineObject8](docs/InlineObject8.md)
 - [InlineObject9](docs/InlineObject9.md)
 - [InlineResponse200](docs/InlineResponse200.md)
 - [InlineResponse2001](docs/InlineResponse2001.md)
 - [InlineResponse20010](docs/InlineResponse20010.md)
 - [InlineResponse20010Data](docs/InlineResponse20010Data.md)
 - [InlineResponse20011](docs/InlineResponse20011.md)
 - [InlineResponse20011Data](docs/InlineResponse20011Data.md)
 - [InlineResponse20011Notation](docs/InlineResponse20011Notation.md)
 - [InlineResponse2001Data](docs/InlineResponse2001Data.md)
 - [InlineResponse2001DataCurrency](docs/InlineResponse2001DataCurrency.md)
 - [InlineResponse2001DataProfitLoss](docs/InlineResponse2001DataProfitLoss.md)
 - [InlineResponse2001DataProfitLossPotential](docs/InlineResponse2001DataProfitLossPotential.md)
 - [InlineResponse2001DataProfitLossRealized](docs/InlineResponse2001DataProfitLossRealized.md)
 - [InlineResponse2001DataProfitLossToday](docs/InlineResponse2001DataProfitLossToday.md)
 - [InlineResponse2001DataProfitLossTotal](docs/InlineResponse2001DataProfitLossTotal.md)
 - [InlineResponse2001DataRiskKeyFigures](docs/InlineResponse2001DataRiskKeyFigures.md)
 - [InlineResponse2001DataSummary](docs/InlineResponse2001DataSummary.md)
 - [InlineResponse2001DataSummaryCash](docs/InlineResponse2001DataSummaryCash.md)
 - [InlineResponse2001DataSummaryTransactions](docs/InlineResponse2001DataSummaryTransactions.md)
 - [InlineResponse2001DataSummaryTransactionsBuy](docs/InlineResponse2001DataSummaryTransactionsBuy.md)
 - [InlineResponse2001DataSummaryTransactionsSell](docs/InlineResponse2001DataSummaryTransactionsSell.md)
 - [InlineResponse2001DataSummaryTransactionsTotal](docs/InlineResponse2001DataSummaryTransactionsTotal.md)
 - [InlineResponse2002](docs/InlineResponse2002.md)
 - [InlineResponse2002Currency](docs/InlineResponse2002Currency.md)
 - [InlineResponse2002Data](docs/InlineResponse2002Data.md)
 - [InlineResponse2002ProfitLoss](docs/InlineResponse2002ProfitLoss.md)
 - [InlineResponse2002Summary](docs/InlineResponse2002Summary.md)
 - [InlineResponse2002SummaryTransactions](docs/InlineResponse2002SummaryTransactions.md)
 - [InlineResponse2003](docs/InlineResponse2003.md)
 - [InlineResponse2004](docs/InlineResponse2004.md)
 - [InlineResponse2004Data](docs/InlineResponse2004Data.md)
 - [InlineResponse2004DataKeyfigures](docs/InlineResponse2004DataKeyfigures.md)
 - [InlineResponse2004DataPeriod](docs/InlineResponse2004DataPeriod.md)
 - [InlineResponse2004DataPeriodProfitLoss](docs/InlineResponse2004DataPeriodProfitLoss.md)
 - [InlineResponse2004DataProfitLoss](docs/InlineResponse2004DataProfitLoss.md)
 - [InlineResponse2005](docs/InlineResponse2005.md)
 - [InlineResponse2005Data](docs/InlineResponse2005Data.md)
 - [InlineResponse2006](docs/InlineResponse2006.md)
 - [InlineResponse2006Data](docs/InlineResponse2006Data.md)
 - [InlineResponse2006DataCurrency](docs/InlineResponse2006DataCurrency.md)
 - [InlineResponse2006DataInstrument](docs/InlineResponse2006DataInstrument.md)
 - [InlineResponse2006DataNotation](docs/InlineResponse2006DataNotation.md)
 - [InlineResponse2006DataNotationPrice](docs/InlineResponse2006DataNotationPrice.md)
 - [InlineResponse2006DataPositions](docs/InlineResponse2006DataPositions.md)
 - [InlineResponse2006DataProfitLoss](docs/InlineResponse2006DataProfitLoss.md)
 - [InlineResponse2006DataPurchase](docs/InlineResponse2006DataPurchase.md)
 - [InlineResponse2006DataShares](docs/InlineResponse2006DataShares.md)
 - [InlineResponse2007](docs/InlineResponse2007.md)
 - [InlineResponse2008](docs/InlineResponse2008.md)
 - [InlineResponse2008Data](docs/InlineResponse2008Data.md)
 - [InlineResponse2008Notation](docs/InlineResponse2008Notation.md)
 - [InlineResponse2009](docs/InlineResponse2009.md)
 - [InlineResponse201](docs/InlineResponse201.md)
 - [InlineResponse2011](docs/InlineResponse2011.md)
 - [InlineResponse2011Data](docs/InlineResponse2011Data.md)
 - [InlineResponse2012](docs/InlineResponse2012.md)
 - [InlineResponse2012Data](docs/InlineResponse2012Data.md)
 - [InlineResponse2013](docs/InlineResponse2013.md)
 - [InlineResponse2013Data](docs/InlineResponse2013Data.md)
 - [InlineResponse201Data](docs/InlineResponse201Data.md)
 - [InlineResponse201Meta](docs/InlineResponse201Meta.md)
 - [LanguageMember](docs/LanguageMember.md)
 - [OffsetBasedPaginationOutputObject](docs/OffsetBasedPaginationOutputObject.md)
 - [OffsetBasedPaginationOutputObjectWithoutTotal](docs/OffsetBasedPaginationOutputObjectWithoutTotal.md)
 - [PartialOutputObject](docs/PartialOutputObject.md)
 - [PortfolioCreateData](docs/PortfolioCreateData.md)
 - [PortfolioCreateDataCurrency](docs/PortfolioCreateDataCurrency.md)
 - [PortfolioCreateMeta](docs/PortfolioCreateMeta.md)
 - [PortfolioDeleteData](docs/PortfolioDeleteData.md)
 - [PortfolioEvaluationListData](docs/PortfolioEvaluationListData.md)
 - [PortfolioEvaluationListDataRange](docs/PortfolioEvaluationListDataRange.md)
 - [PortfolioModifyData](docs/PortfolioModifyData.md)
 - [PortfolioTransactionCashCreateData](docs/PortfolioTransactionCashCreateData.md)
 - [PortfolioTransactionCashDeleteData](docs/PortfolioTransactionCashDeleteData.md)
 - [PortfolioTransactionCreateData](docs/PortfolioTransactionCreateData.md)
 - [PortfolioTransactionCreateDataNotation](docs/PortfolioTransactionCreateDataNotation.md)
 - [PortfolioTransactionCreateDataParentTransaction](docs/PortfolioTransactionCreateDataParentTransaction.md)
 - [PortfolioTransactionDeleteData](docs/PortfolioTransactionDeleteData.md)
 - [PortfolioTransactionDeleteDataNotation](docs/PortfolioTransactionDeleteDataNotation.md)
 - [PortfolioTransactionDeleteDataTransaction](docs/PortfolioTransactionDeleteDataTransaction.md)
 - [PortfolioTransactionModifyData](docs/PortfolioTransactionModifyData.md)
 - [PortfolioTransactionModifyDataTransaction](docs/PortfolioTransactionModifyDataTransaction.md)
 - [StatusObject](docs/StatusObject.md)
 - [SubscriptionMember](docs/SubscriptionMember.md)
 - [WatchlistCreateData](docs/WatchlistCreateData.md)
 - [WatchlistDeleteData](docs/WatchlistDeleteData.md)
 - [WatchlistModifyData](docs/WatchlistModifyData.md)
 - [WatchlistPositionCreateData](docs/WatchlistPositionCreateData.md)
 - [WatchlistPositionDeleteData](docs/WatchlistPositionDeleteData.md)
 - [WatchlistPositionDeleteDataPosition](docs/WatchlistPositionDeleteDataPosition.md)
 - [WatchlistPositionModifyData](docs/WatchlistPositionModifyData.md)
 - [WatchlistPositionModifyDataPosition](docs/WatchlistPositionModifyDataPosition.md)


## 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.VirtualPortfolioAPIforDigitalPortals.apis and fds.sdk.VirtualPortfolioAPIforDigitalPortals.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.VirtualPortfolioAPIforDigitalPortals.api.default_api import DefaultApi`
- `from fds.sdk.VirtualPortfolioAPIforDigitalPortals.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.VirtualPortfolioAPIforDigitalPortals
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.apis import *
from fds.sdk.VirtualPortfolioAPIforDigitalPortals.models import *
```

## Contributing

Please refer to the [contributing guide](../../../../CONTRIBUTING.md).

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



