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-fundsapifordigitalportals

v0.10.0

Published

Funds API for Digital Portals client library for JavaScript

Downloads

6

Readme

Funds API for Digital Portals client library for JavaScript

npm Apache-2 license

Search for mutual funds and ETFs using one single consolidated API, including a criteria-based screener. The API provides also base data, key figures, and holdings.

A separate endpoint returns the possible values and value range for the parameters that the endpoint /fund/notation/screener/search accepts: Application developers can request the values and value range only for a restricted set of notations that match predefined parameters. This functionality may be used to pre-fill the values and value ranges of the parameters of the /fund/notation/screener/search endpoint so that performing a search always leads to a non-empty set of notations.

This API is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments, as well as basic security identifier cross-reference. For direct access to price histories, please refer to the Time Series API for Digital Portals.

Similar criteria based screener APIs exist for equity instruments and securitized derivatives: See the Stocks API and the Securitized Derivatives API for details.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

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

Requirements

  • Node.js >= 12

Installation

npm

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

yarn

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

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment
    1. Install and activate Node.js >=12. If you're using nvm:

      nvm install 16
      nvm use 16
    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:
const { ApiClient, FundApi } = require('@factset/sdk-fundsapifordigitalportals');
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 FundApi();
const id = "id_example"; // String | Identifier of an instrument of a fund share class.
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'sort': ["null"] // [String] | Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed.
};

// Call api endpoint
apiInstance.getFundHoldingListByInstrument(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 http://api.factset.com/wealth/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- fundsapifordigitalportals.FundApi | getFundHoldingListByInstrument | GET /fund/holding/listByInstrument | Holdings of a fund. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkMonth1Get | GET /fund/notation/keyFigures/benchmark/month/1/get | End-of-day (EOD) benchmark key figures of a fund for the time range of one month. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkMonth3Get | GET /fund/notation/keyFigures/benchmark/month/3/get | End-of-day (EOD) benchmark key figures of a fund for the time range of three months. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkWeek1Get | GET /fund/notation/keyFigures/benchmark/week/1/get | End-of-day (EOD) benchmark key figures of a fund for the time range of one week. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkYear1Get | GET /fund/notation/keyFigures/benchmark/year/1/get | End-of-day (EOD) benchmark key figures of a fund for the time range of one year. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkYear3Get | GET /fund/notation/keyFigures/benchmark/year/3/get | End-of-day (EOD) benchmark key figures of a fund for the time range of three years. fundsapifordigitalportals.FundApi | getFundNotationKeyFiguresBenchmarkYear5Get | GET /fund/notation/keyFigures/benchmark/year/5/get | End-of-day (EOD) benchmark key figures of a fund for the time range of five years. fundsapifordigitalportals.FundApi | getFundShareClassGet | GET /fund/shareClass/get | Fundamental data for a share class of a fund. fundsapifordigitalportals.FundApi | postFundIssuerSearch | POST /fund/issuer/search | Search for issuers of funds. fundsapifordigitalportals.FundApi | postFundNotationScreenerSearch | POST /fund/notation/screener/search | Screener for notations of share classes of mutual and exchange traded funds based on fund-specific parameters. fundsapifordigitalportals.FundApi | postFundNotationScreenerValueRangesGet | POST /fund/notation/screener/valueRanges/get | Possible values and value ranges for the parameters used in the endpoint `/fund/notation/screener/search`.

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.