Virtual Portfolio API for Digital Portals client library for Python

Project description

Virtual Portfolio API for Digital Portals client library for Python

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

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

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

Requirements

Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.VirtualPortfolioAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.VirtualPortfolioAPIforDigitalPortals

Usage

Generate authentication credentials.
Setup Python environment.
1. Install and activate python 3.6+. If you're using pyenv:
```
pyenv install 3.9.7
pyenv shell 3.9.7
```
2. (optional) Install poetry.
Install dependencies.
Run the following:

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	POST /portfolio/create	Create a portfolio.
PortfolioApi	portfolio_delete_post	POST /portfolio/delete	Delete a portfolio.
PortfolioApi	portfolio_evaluation_list_post	POST /portfolio/evaluation/list	Evaluate a portfolio.
PortfolioApi	portfolio_get_get	GET /portfolio/get	Details of a portfolio.
PortfolioApi	portfolio_list_get	GET /portfolio/list	List of portfolios with keyfigures.
PortfolioApi	portfolio_modify_post	POST /portfolio/modify	Modify a portfolio.
PortfolioApi	portfolio_name_list_get	GET /portfolio/name/list	List of portfolios.
PortfolioApi	portfolio_position_list_get	GET /portfolio/position/list	List all positions of a portfolio.
PortfolioApi	portfolio_transaction_cash_create_post	POST /portfolio/transaction/cash/create	Add a cash transaction to a portfolio.
PortfolioApi	portfolio_transaction_cash_delete_post	POST /portfolio/transaction/cash/delete	Delete a cash transaction.
PortfolioApi	portfolio_transaction_create_post	POST /portfolio/transaction/create	Add a transaction to a portfolio.
PortfolioApi	portfolio_transaction_delete_post	POST /portfolio/transaction/delete	Delete a transaction of a portfolio.
PortfolioApi	portfolio_transaction_list_get	GET /portfolio/transaction/list	List of transactions in a portfolio.
PortfolioApi	portfolio_transaction_modify_post	POST /portfolio/transaction/modify	Modify a transaction in a portfolio.
WatchlistApi	watchlist_create_post	POST /watchlist/create	Create a watchlist.
WatchlistApi	watchlist_delete_post	POST /watchlist/delete	Delete a watchlist.
WatchlistApi	watchlist_list_get	GET /watchlist/list	List of watchlists.
WatchlistApi	watchlist_modify_post	POST /watchlist/modify	Modify a watchlist.
WatchlistApi	watchlist_position_create_post	POST /watchlist/position/create	Add a position to a watchlist.
WatchlistApi	watchlist_position_delete_post	POST /watchlist/position/delete	Delete a position of a watchlist.
WatchlistApi	watchlist_position_list_get	GET /watchlist/position/list	List of positions of a watchlist.
WatchlistApi	watchlist_position_modify_post	POST /watchlist/position/modify	Modify a position in a watchlist.

Documentation For Models

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.

Copyright

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.

Project details

Release history Release notifications | RSS feed

0.9.5

Aug 31, 2022

0.9.3

Jul 21, 2022

This version

0.9.2

May 24, 2022

0.9.1

Feb 14, 2022

0.9.0

Feb 2, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.2-py3-none-any.whl (353.7 kB view hashes)

Uploaded May 24, 2022 Python 3

Hashes for fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.2-py3-none-any.whl

Hashes for fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`28aded58f2e97cdb731df7ac91cbacb75e587d5138170a541bed3c9d27a3492e`
MD5	`381e634bc318ce2721beb947f45f7097`
BLAKE2b-256	`3d39bea0f931e3effb0dfd8edba8a582a5afdadebb676190debfbc973b3da155`