Virtual Portfolio API for Digital Portals client library for Python

Project description

Virtual Portfolio API for Digital Portals client library for Python

The virtual portfolio enables the analysis of the current allocation, broken down by asset classes, currencies, regions, sectors, style, capitalization, style, maturity, risk, and more.

Relative performance and monthly returns can be measured against benchmarks, using portfolio position transaction (buy/sell) data. Both the realized profit/loss (resulting from closed transactions) and the potential profit/loss (resulting from positions that have not been sold yet) can be queried.

Portfolio endpoints allow creation and managing a transaction-based portfolio. A transaction-based portfolio contains a gapless history of all transactions to be able to accurately reproduce the investment record of the portfolio.

An instrument added to a portfolio is called a position. Each position consists of multiple buy and sell events called transactions. Portfolios are limited to 100 positions and 1000 transactions; adding more will result in an error.

A transaction-based portfolio can consist of the following transactions:

A buy transaction opens or adds to a position in the portfolio, decreasing the cash value by the purchase price at the same time. If there is not enough cash in the portfolio to cover the transaction, the cash value becomes negative.
A sell transaction decreases or closes a position in the portfolio, increasing the cash value by the sale price at the same time. A sell transaction can only be created if the number of shares of a given position exceeds the number being sold.
A cash transaction increases or decreases the cash position of the portfolio. A portfolio can have only one cash position. The cash position is tracked automatically as each buy or sell transaction implicitly affects it. The cash position can be negative as a buy transaction does not check whether enough cash is available. The cash position does not generate interest; its performance is always 0%.

The chosen prices and key figures in the endpoints are using the same quality, which is configurable per application. Possible values are delayed (DLY), best (BST), end-of-day (EOD) or realtime (RLT). The default value for the price quality is BST.

The portfolio endpoints use different methods to calculate key figures. All key figures except the risk in /portfolio/detail/list, /portfolio/get, and /portfolio/position/list are calculated on-the-fly with current prices. The risk key figures are calculated on-the-fly with current prices, but the result is cached for 24 hours. The key figures in /portfolio/evaluation/list are calculated on end-of-day basis.

The Virtual Portfolio API for Digital Portals is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments in a watchlist. This also supports basic security identifier cross-reference. To complement the Watchlist API and Virtual Portfolio API with direct access to price histories, please refer to the Time Series API for Digital Portals.

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

API version: 2
Package version: 0.9.5
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python >= 3.7

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.7+. 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.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.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)
    id = "id_example" # str | 
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)

    try:
        # Details of a portfolio.
        api_response = api_instance.get_portfolio_get(id, attributes=attributes)
        pprint(api_response)
    except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
        print("Exception when calling PortfolioApi->get_portfolio_get: %s\n" % e)

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

    # Get response asynchronous
    # try:
    #     # Details of a portfolio.
    #     async_result = api_instance.get_portfolio_get_async(id, attributes=attributes)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.VirtualPortfolioAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PortfolioApi->get_portfolio_get: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Details of a portfolio.
    #     async_result = api_instance.get_portfolio_get_with_http_info_async(id, attributes=attributes)
    #     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->get_portfolio_get: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PortfolioApi	get_portfolio_get	GET /portfolio/get	Details of a portfolio.
PortfolioApi	get_portfolio_list	GET /portfolio/list	List of portfolios with keyfigures.
PortfolioApi	get_portfolio_name_list	GET /portfolio/name/list	List of portfolios.
PortfolioApi	get_portfolio_position_list	GET /portfolio/position/list	List all open positions of a portfolio.
PortfolioApi	get_portfolio_transaction_list	GET /portfolio/transaction/list	List of transactions in a portfolio.
PortfolioApi	post_portfolio_create	POST /portfolio/create	Create a portfolio.
PortfolioApi	post_portfolio_delete	POST /portfolio/delete	Delete a portfolio.
PortfolioApi	post_portfolio_evaluation_list	POST /portfolio/evaluation/list	Evaluate a portfolio.
PortfolioApi	post_portfolio_modify	POST /portfolio/modify	Modify a portfolio.
PortfolioApi	post_portfolio_payout_create	POST /portfolio/payout/create	Add a payout to a portfolio.
PortfolioApi	post_portfolio_payout_delete	POST /portfolio/payout/delete	Delete a payout of a portfolio.
PortfolioApi	post_portfolio_payout_list	POST /portfolio/payout/list	List of payouts in a portfolio.
PortfolioApi	post_portfolio_payout_modify	POST /portfolio/payout/modify	Modify a payout in a portfolio.
PortfolioApi	post_portfolio_position_closed_list	POST /portfolio/position/closed/list	List all closed positions of a portfolio.
PortfolioApi	post_portfolio_transaction_cash_create	POST /portfolio/transaction/cash/create	Add a cash transaction to a portfolio.
PortfolioApi	post_portfolio_transaction_cash_delete	POST /portfolio/transaction/cash/delete	Delete a cash transaction.
PortfolioApi	post_portfolio_transaction_create	POST /portfolio/transaction/create	Add a transaction to a portfolio.
PortfolioApi	post_portfolio_transaction_delete	POST /portfolio/transaction/delete	Delete a transaction of a portfolio.
PortfolioApi	post_portfolio_transaction_modify	POST /portfolio/transaction/modify	Modify a transaction in a portfolio.
WatchlistApi	get_watchlist_get	GET /watchlist/get	Details of a watchlist.
WatchlistApi	get_watchlist_list	GET /watchlist/list	List of watchlists.
WatchlistApi	get_watchlist_position_list	GET /watchlist/position/list	List of positions of a watchlist.
WatchlistApi	post_watchlist_create	POST /watchlist/create	Create a watchlist.
WatchlistApi	post_watchlist_delete	POST /watchlist/delete	Delete a watchlist.
WatchlistApi	post_watchlist_modify	POST /watchlist/modify	Modify a watchlist.
WatchlistApi	post_watchlist_position_create	POST /watchlist/position/create	Add a position to a watchlist.
WatchlistApi	post_watchlist_position_delete	POST /watchlist/position/delete	Delete a position of a watchlist.
WatchlistApi	post_watchlist_position_get	POST /watchlist/position/get	Details of the position of a watchlist.
WatchlistApi	post_watchlist_position_modify	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

This version

0.9.5

Aug 31, 2022

0.9.3

Jul 21, 2022

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.5-py3-none-any.whl (696.4 kB view details)

Uploaded Aug 31, 2022 Python 3

File details

Details for the file fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.5-py3-none-any.whl.

File metadata

Download URL: fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.5-py3-none-any.whl
Upload date: Aug 31, 2022
Size: 696.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.0 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for fds.sdk.VirtualPortfolioAPIforDigitalPortals-0.9.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`e73553e992cf149b212bf231a92a93b0c3f5e5f833af577a018e105fba297874`
MD5	`58ac76424c249baee0086d1a5e783365`
BLAKE2b-256	`54ec0fe42fe48cb2cafde7ec16450f39fa4fbfc38e87581c0ccc140d96589fc4`