FactSet.SDK.VirtualPortfolioAPIforDigitalPortals 0.9.5

Prefix Reserved
.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package FactSet.SDK.VirtualPortfolioAPIforDigitalPortals --version 0.9.5                

                    
                

            
NuGet\Install-Package FactSet.SDK.VirtualPortfolioAPIforDigitalPortals -Version 0.9.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FactSet.SDK.VirtualPortfolioAPIforDigitalPortals" Version="0.9.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add FactSet.SDK.VirtualPortfolioAPIforDigitalPortals --version 0.9.5                

                    
                

            
#r "nuget: FactSet.SDK.VirtualPortfolioAPIforDigitalPortals, 0.9.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install FactSet.SDK.VirtualPortfolioAPIforDigitalPortals as a Cake Addin
#addin nuget:?package=FactSet.SDK.VirtualPortfolioAPIforDigitalPortals&version=0.9.5

// Install FactSet.SDK.VirtualPortfolioAPIforDigitalPortals as a Cake Tool
#tool nuget:?package=FactSet.SDK.VirtualPortfolioAPIforDigitalPortals&version=0.9.5

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

Nuget Apache-2 license

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 .NET package is automatically generated by the OpenAPI Generator project:

  • API version: 2
  • Package version: 0.9.5
  • Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

  • .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.VirtualPortfolioAPIforDigitalPortals

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.VirtualPortfolioAPIforDigitalPortals

Usage

  1. Generate authentication credentials.
  2. Setup .NET Standard 2.0 compatible environment.
  3. Install dependencies.
  4. Run the following:

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.VirtualPortfolioAPIforDigitalPortals.Api;
using FactSet.SDK.VirtualPortfolioAPIforDigitalPortals.Client;
using FactSet.SDK.VirtualPortfolioAPIforDigitalPortals.Model;

namespace Example
{
    public static class GetPortfolioGetExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.VirtualPortfolioAPIforDigitalPortals.Client.Configuration();

            // 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-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new PortfolioApi(config);
            var id = "id_example";  // string | 
            var attributes = new List<string>(); // List<string> | Limit the attributes returned in the response to the specified set. (optional) 

            try
            {
                // Details of a portfolio.
                InlineResponse2001 result = apiInstance.GetPortfolioGet(id, attributes);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling PortfolioApi.GetPortfolioGet: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

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

Class Method HTTP request Description
PortfolioApi GetPortfolioGet GET /portfolio/get Details of a portfolio.
PortfolioApi GetPortfolioList GET /portfolio/list List of portfolios with keyfigures.
PortfolioApi GetPortfolioNameList GET /portfolio/name/list List of portfolios.
PortfolioApi GetPortfolioPositionList GET /portfolio/position/list List all open positions of a portfolio.
PortfolioApi GetPortfolioTransactionList GET /portfolio/transaction/list List of transactions in a portfolio.
PortfolioApi PostPortfolioCreate POST /portfolio/create Create a portfolio.
PortfolioApi PostPortfolioDelete POST /portfolio/delete Delete a portfolio.
PortfolioApi PostPortfolioEvaluationList POST /portfolio/evaluation/list Evaluate a portfolio.
PortfolioApi PostPortfolioModify POST /portfolio/modify Modify a portfolio.
PortfolioApi PostPortfolioPayoutCreate POST /portfolio/payout/create Add a payout to a portfolio.
PortfolioApi PostPortfolioPayoutDelete POST /portfolio/payout/delete Delete a payout of a portfolio.
PortfolioApi PostPortfolioPayoutList POST /portfolio/payout/list List of payouts in a portfolio.
PortfolioApi PostPortfolioPayoutModify POST /portfolio/payout/modify Modify a payout in a portfolio.
PortfolioApi PostPortfolioPositionClosedList POST /portfolio/position/closed/list List all closed positions of a portfolio.
PortfolioApi PostPortfolioTransactionCashCreate POST /portfolio/transaction/cash/create Add a cash transaction to a portfolio.
PortfolioApi PostPortfolioTransactionCashDelete POST /portfolio/transaction/cash/delete Delete a cash transaction.
PortfolioApi PostPortfolioTransactionCreate POST /portfolio/transaction/create Add a transaction to a portfolio.
PortfolioApi PostPortfolioTransactionDelete POST /portfolio/transaction/delete Delete a transaction of a portfolio.
PortfolioApi PostPortfolioTransactionModify POST /portfolio/transaction/modify Modify a transaction in a portfolio.
WatchlistApi GetWatchlistGet GET /watchlist/get Details of a watchlist.
WatchlistApi GetWatchlistList GET /watchlist/list List of watchlists.
WatchlistApi GetWatchlistPositionList GET /watchlist/position/list List of positions of a watchlist.
WatchlistApi PostWatchlistCreate POST /watchlist/create Create a watchlist.
WatchlistApi PostWatchlistDelete POST /watchlist/delete Delete a watchlist.
WatchlistApi PostWatchlistModify POST /watchlist/modify Modify a watchlist.
WatchlistApi PostWatchlistPositionCreate POST /watchlist/position/create Add a position to a watchlist.
WatchlistApi PostWatchlistPositionDelete POST /watchlist/position/delete Delete a position of a watchlist.
WatchlistApi PostWatchlistPositionGet POST /watchlist/position/get Details of the position of a watchlist.
WatchlistApi PostWatchlistPositionModify 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

Contributing

Please refer to the contributing guide.

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.9.5 400 8/31/2022
0.9.3 383 7/21/2022
0.9.2 402 5/24/2022
0.9.1 415 2/14/2022
0.9.0 414 2/2/2022

Refer to Changelog on GitHub source repository