npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@factset/sdk-virtualportfolioapifordigitalportals

v0.9.5

Published

Virtual Portfolio API for Digital Portals client library for JavaScript

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

fdsfdstsouthmaydfdstsouthmaydfdsenterprisesdkenterprisesdkfbecker-fdsfbecker-fds

Keywords

FactSetAPISDK

Readme

Virtual Portfolio API for Digital Portals client library for JavaScript

npm 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 TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

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

Requirements

  • Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-virtualportfolioapifordigitalportals

yarn

yarn add @factset/sdk-utils @factset/sdk-virtualportfolioapifordigitalportals

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment

    1. Install and activate Node.js >=14. If you're using nvm:

      nvm install 16
nvm use 16

    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:
const { ApiClient, PortfolioApi } = require('@factset/sdk-virtualportfolioapifordigitalportals');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// 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-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new 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
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new PortfolioApi();
const id = "id_example"; // String | 
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getPortfolioGet(id, opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- virtualportfolioapifordigitalportals.PortfolioApi | getPortfolioGet | GET /portfolio/get | Details of a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | getPortfolioList | GET /portfolio/list | List of portfolios with keyfigures. virtualportfolioapifordigitalportals.PortfolioApi | getPortfolioNameList | GET /portfolio/name/list | List of portfolios. virtualportfolioapifordigitalportals.PortfolioApi | getPortfolioPositionList | GET /portfolio/position/list | List all open positions of a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | getPortfolioTransactionList | GET /portfolio/transaction/list | List of transactions in a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioCreate | POST /portfolio/create | Create a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioDelete | POST /portfolio/delete | Delete a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioEvaluationList | POST /portfolio/evaluation/list | Evaluate a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioModify | POST /portfolio/modify | Modify a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioPayoutCreate | POST /portfolio/payout/create | Add a payout to a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioPayoutDelete | POST /portfolio/payout/delete | Delete a payout of a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioPayoutList | POST /portfolio/payout/list | List of payouts in a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioPayoutModify | POST /portfolio/payout/modify | Modify a payout in a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioPositionClosedList | POST /portfolio/position/closed/list | List all closed positions of a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioTransactionCashCreate | POST /portfolio/transaction/cash/create | Add a cash transaction to a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioTransactionCashDelete | POST /portfolio/transaction/cash/delete | Delete a cash transaction. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioTransactionCreate | POST /portfolio/transaction/create | Add a transaction to a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioTransactionDelete | POST /portfolio/transaction/delete | Delete a transaction of a portfolio. virtualportfolioapifordigitalportals.PortfolioApi | postPortfolioTransactionModify | POST /portfolio/transaction/modify | Modify a transaction in a portfolio. virtualportfolioapifordigitalportals.WatchlistApi | getWatchlistGet | GET /watchlist/get | Details of a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | getWatchlistList | GET /watchlist/list | List of watchlists. virtualportfolioapifordigitalportals.WatchlistApi | getWatchlistPositionList | GET /watchlist/position/list | List of positions of a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistCreate | POST /watchlist/create | Create a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistDelete | POST /watchlist/delete | Delete a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistModify | POST /watchlist/modify | Modify a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistPositionCreate | POST /watchlist/position/create | Add a position to a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistPositionDelete | POST /watchlist/position/delete | Delete a position of a watchlist. virtualportfolioapifordigitalportals.WatchlistApi | postWatchlistPositionGet | POST /watchlist/position/get | Details of the position of a watchlist. virtualportfolioapifordigitalportals.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

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.