@factset/sdk-factsetfunds v2.0.0

FactSet Funds client library for JavaScript

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/sdk-factsetfunds@2.0.0

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetfunds@2.0.0

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:password@proxy.example.com:8080');

Documentation for API Endpoints

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

Documentation for Models

• factsetfunds.Aum
• factsetfunds.AumRequest
• factsetfunds.AumResponse
• factsetfunds.BenchmarkDetails
• factsetfunds.BenchmarkDetailsRequest
• factsetfunds.BenchmarkDetailsResponse
• factsetfunds.Classifications
• factsetfunds.ClassificationsRequest
• factsetfunds.ClassificationsResponse
• factsetfunds.CostsFees
• factsetfunds.CostsFeesRequest
• factsetfunds.CostsFeesResponse
• factsetfunds.DataType
• factsetfunds.DistCurrent
• factsetfunds.DistCurrentRequest
• factsetfunds.DistCurrentResponse
• factsetfunds.DistHistorical
• factsetfunds.DistHistoricalRequest
• factsetfunds.DistHistoricalResponse
• factsetfunds.DividendAdjust
• factsetfunds.ErrorResponse
• factsetfunds.ErrorResponseSubErrors
• factsetfunds.Flows
• factsetfunds.FlowsRequest
• factsetfunds.FlowsResponse
• factsetfunds.Frequency
• factsetfunds.FrequencyAum
• factsetfunds.FundsPricesRequest
• factsetfunds.FundsPricesResponse
• factsetfunds.FundsReturnsRequest
• factsetfunds.FundsReturnsResponse
• factsetfunds.FundsReturnsSnapshotRequest
• factsetfunds.FundsReturnsSnapshotResponse
• factsetfunds.Group
• factsetfunds.GroupHolding
• factsetfunds.GroupHoldingsRequest
• factsetfunds.GroupHoldingsResponse
• factsetfunds.Managers
• factsetfunds.ManagersRequest
• factsetfunds.ManagersResponse
• factsetfunds.MarketAggregate
• factsetfunds.MarketAggregatesRequest
• factsetfunds.MarketAggregatesResponse
• factsetfunds.Prices
• factsetfunds.RelatedFunds
• factsetfunds.RelatedFundsRequest
• factsetfunds.RelatedFundsResponse
• factsetfunds.Returns
• factsetfunds.ReturnsRange
• factsetfunds.ReturnsRangeRequest
• factsetfunds.ReturnsRangeResponse
• factsetfunds.ReturnsSnapshot
• factsetfunds.SplitAdjust
• factsetfunds.Statuses
• factsetfunds.StatusesRequest
• factsetfunds.StatusesResponse
• factsetfunds.Summaries
• factsetfunds.SummariesRequest
• factsetfunds.SummariesResponse

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.