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 🙏

© 2024 – Pkg Stats / Ryan Hefner

@factset/sdk-factsetfunds

v2.0.0

Published

FactSet Funds client library for JavaScript

Downloads

84

Vulnerabilities

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

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

FactSet Funds client library for JavaScript

API Version npm Apache-2 license

FactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage

  • Fund descriptions
  • A seven-tier classification system
  • Leverage information
  • Fees and expenses
  • Portfolio managers

FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage

  • Net asset value
  • Fund flows
  • Assets under management
  • Total return

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

  • API version: 1.1.0
  • SDK version: 2.0.0
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

Usage

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

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

      nvm install 18
nvm use 18

    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, DistributionsApi } = require('@factset/sdk-factsetfunds');
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
//
// The confidential client instance should be reused in production environments.
// 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 DistributionsApi();
const ids = ["MABAX-US"]; // [String] | The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <p>***ids limit** =  1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>* 
const opts = {
  'currency': USD // String | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. For a list of currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). 
};

// Call api endpoint
apiInstance.getFundsDistCurrent(ids, opts).then(
  data => {

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

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-factsetfunds');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetfunds.DistributionsApi | getFundsDistCurrent | GET /factset-funds/v1/distributions/current | Get Most Recent Fund Distributions factsetfunds.DistributionsApi | getFundsDistCurrentForList | POST /factset-funds/v1/distributions/current | Get Most Recent Fund Distributions factsetfunds.DistributionsApi | getFundsDistHistorical | GET /factset-funds/v1/distributions/historical | Get Historical Fund Distributions factsetfunds.DistributionsApi | getFundsDistHistoricalForList | POST /factset-funds/v1/distributions/historical | Get Historical Fund Distributions factsetfunds.FundFlowsAUMApi | getFundsAum | GET /factset-funds/v1/aum | Get Fund AUM for a requested date range and list of ids factsetfunds.FundFlowsAUMApi | getFundsAumForList | POST /factset-funds/v1/aum | Get Fund AUM for a requested date range and large list of ids factsetfunds.FundFlowsAUMApi | getFundsFlows | GET /factset-funds/v1/flows | Get Fund Flows for a requested date range and list of ids factsetfunds.FundFlowsAUMApi | getFundsFlowsForList | POST /factset-funds/v1/flows | Get Fund Flows for a requested date range and large list of ids factsetfunds.GroupHoldingsApi | getGroupHoldings | GET /factset-funds/v1/holdings/group | Get group holdings for a specific date and group. factsetfunds.GroupHoldingsApi | getGroupHoldingsForList | POST /factset-funds/v1/holdings/group | Get group holdings for a specific date and group. factsetfunds.HelperApi | getStatuses | GET /factset-funds/v1/status | Get Fund's current status and database availability factsetfunds.HelperApi | getStatusesForList | POST /factset-funds/v1/status | Get Fund's current status and database availability for large list of ids. factsetfunds.MarketAggregatesApi | getMarketAggregates | GET /factset-funds/v1/aggregates/market | Get market aggregates for a requested time series. factsetfunds.MarketAggregatesApi | getMarketAggregatesForList | POST /factset-funds/v1/aggregates/market | Get market aggregates for a requested time series. factsetfunds.PricesReturnsApi | getFundsPrices | GET /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested time-series factsetfunds.PricesReturnsApi | getFundsPricesForList | POST /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested date range and large list of ids. factsetfunds.PricesReturnsApi | getFundsReturns | GET /factset-funds/v1/returns | Get Fund Returns for a requested time-series factsetfunds.PricesReturnsApi | getFundsReturnsForList | POST /factset-funds/v1/returns | Get Fund Returns for a requested time-series and large list of ids factsetfunds.PricesReturnsApi | getFundsReturnsRange | GET /factset-funds/v1/returns-range | Get Fund Returns for a user-defined date range factsetfunds.PricesReturnsApi | getFundsReturnsRangeForList | POST /factset-funds/v1/returns-range | Get Fund Returns over pre-defined time horizons as of a specific date for large list of ids. factsetfunds.PricesReturnsApi | getFundsReturnsSnapshot | GET /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date. factsetfunds.PricesReturnsApi | getFundsReturnsSnapshotForList | POST /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date. factsetfunds.ReferenceApi | getFundsBenchmarkDetails | GET /factset-funds/v1/benchmark-details | Get the Fund's Primary and Segment Benchmark Details factsetfunds.ReferenceApi | getFundsBenchmarkDetailsForList | POST /factset-funds/v1/benchmark-details | Get the Fund's Primary and Segment Benchmark details for large list of ids. factsetfunds.ReferenceApi | getFundsClassifications | GET /factset-funds/v1/classifications | Get basic Fund Classifications factsetfunds.ReferenceApi | getFundsClassificationsForList | POST /factset-funds/v1/classifications | Get basic Fund Classifications for a large list of ids. factsetfunds.ReferenceApi | getFundsCostsFees | GET /factset-funds/v1/costs-fees | Get the Fund's Costs, Investment minimums and Risk, and Fees. factsetfunds.ReferenceApi | getFundsCostsFeesForList | POST /factset-funds/v1/costs-fees | Get the Fund's Costs, Investment minimums and Risk, and Fees for large list of ids. factsetfunds.ReferenceApi | getFundsManagers | GET /factset-funds/v1/managers | Get a list of Fund Managers and related details for a list of ids. factsetfunds.ReferenceApi | getFundsManagersForList | POST /factset-funds/v1/managers | Get a list of Fund Managers and related details for a large list of ids. factsetfunds.ReferenceApi | getFundsSummary | GET /factset-funds/v1/summary | Get basic reference summary data for a Fund. factsetfunds.ReferenceApi | getFundsSummaryForList | POST /factset-funds/v1/summary | Get basic reference data for a large list of Fund ids. factsetfunds.ReferenceApi | getRelatedFunds | GET /factset-funds/v1/related-funds | Get a list of Related Funds for a list of Fund ids. factsetfunds.ReferenceApi | getRelatedFundsForList | POST /factset-funds/v1/related-funds | Get a list of Related Funds for a large list of Fund ids.

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.