# @factset/sdk-factsetbenchmarks > FactSet Benchmarks client library for JavaScript Latest version **3.0.0** (published 2026-11-06) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @factset/sdk-factsetbenchmarks pnpm add @factset/sdk-factsetbenchmarks yarn add @factset/sdk-factsetbenchmarks bun add @factset/sdk-factsetbenchmarks ``` ## Health **Score 55/100 (C)** — status: active. Positive: no vulnerabilities; recently updated; high maintenance score. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 3.0.0 | | Published | 2026-11-06 | | First published | 2022-02-02 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=22 | | Dependencies | 3 | | Unpacked size | 227.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 55 | | Author | FactSet Research Systems | | Maintainers | fds, tsouthmaydfds, enterprisesdk, fbecker-fds | | Keywords | FactSet, API, SDK | ## Links - npm: https://www.npmjs.com/package/@factset/sdk-factsetbenchmarks - Repository: https://github.com/factset/enterprise-sdk - Homepage: https://developer.factset.com/ - Issues: https://developer.factset.com/ - npm.io page: https://npm.io/package/@factset/sdk-factsetbenchmarks ## Dependencies (3) - [superagent](https://npm.io/package/superagent.md) ^10.0.0 - [proxy-agent](https://npm.io/package/proxy-agent.md) ^6.0.0 - [@factset/sdk-utils](https://npm.io/package/@factset/sdk-utils.md) ^3.0.0 ## Recent versions - 3.0.0 (latest) — 2026-11-06 - 2.3.1 — 2026-06-17 - 2.3.0 — 2026-04-24 - 2.2.0 — 2025-04-30 - 2.1.1 — 2025-03-06 - 2.1.0 — 2025-01-10 - 2.0.0 — 2024-11-01 - 1.3.0 — 2024-09-20 - 1.2.2 — 2023-10-25 - 1.2.1 — 2023-08-30 - 1.2.0 — 2023-06-22 - 1.1.1 — 2023-06-06 - 1.1.0 — 2022-09-23 - 1.0.0 — 2022-08-31 - 0.21.0 — 2022-07-21 - … 3 more at https://npm.io/package/@factset/sdk-factsetbenchmarks/versions ## README [![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com) # FactSet Benchmarks client library for JavaScript [![API Version](https://img.shields.io/badge/api-v1.11.0-blue)]() [![npm](https://img.shields.io/badge/npm-v3.0.0-orange)](https://www.npmjs.com/package/@factset/sdk-factsetbenchmarks/v/3.0.0) [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) FactSet Benchmarks API gives access to Index Constituents, Prices, Returns, and Ratios. For a sample list of identifiers, use the /metrics endpoint. Equity Only - Fixed Income Benchmark support coming soon. This TypeScript/JavaScript package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.11.0 - SDK version: 3.0.0 - Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen ## Requirements * Node.js >= 22 ## Installation ### npm ```shell npm install @factset/sdk-utils @factset/sdk-factsetbenchmarks@3.0.0 ``` ### yarn ```shell yarn add @factset/sdk-utils @factset/sdk-factsetbenchmarks@3.0.0 ``` ## Usage 1. [Generate authentication credentials](../../../../README.md#authentication). 2. Setup Node.js environment 1. Install and activate Node.js >=22. If you're using [nvm](https://github.com/nvm-sh/nvm): ```sh nvm install 22 nvm use 22 ``` 2. (optional) [Install yarn](https://yarnpkg.com/getting-started/install). 3. [Install dependencies](#installation). 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 ```javascript const { ApiClient, BenchmarkConstituentsApi } = require('@factset/sdk-factsetbenchmarks'); 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 BenchmarkConstituentsApi(); const ids = SP50; // [String] | Benchmark Identifiers. Reference the helper endpoint **_/id-list** to get a sample list of valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error.

***ids limit** = 1 per request*

const opts = { 'date': "date_example", // String | Date of holding expressed in YYYY-MM-DD format. 'currency': "currency_example", // String | Currency for response. Currency code (ISO 4217). For a list of currency codes, see [OA Page 1470](https://my.apps.factset.com/oa/pages/1470). 'calendar': FIVEDAY // String | Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays. }; // Call api endpoint apiInstance.getBenchmarkConstituents(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: ```javascript const { ApiClient } = require('@factset/sdk-factsetbenchmarks'); 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* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *factsetbenchmarks.BenchmarkConstituentsApi* | [**getBenchmarkConstituents**](docs/BenchmarkConstituentsApi.md#getBenchmarkConstituents) | **GET** /factset-benchmarks/v1/constituents | Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. *factsetbenchmarks.BenchmarkConstituentsApi* | [**getBenchmarkConstituentsForList**](docs/BenchmarkConstituentsApi.md#getBenchmarkConstituentsForList) | **POST** /factset-benchmarks/v1/constituents | Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. *factsetbenchmarks.BenchmarkConstituentsApi* | [**getFIBenchmarkConstituents**](docs/BenchmarkConstituentsApi.md#getFIBenchmarkConstituents) | **GET** /factset-benchmarks/v1/fixed-income-constituents | Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value. *factsetbenchmarks.BenchmarkConstituentsApi* | [**getFIBenchmarkConstituentsForList**](docs/BenchmarkConstituentsApi.md#getFIBenchmarkConstituentsForList) | **POST** /factset-benchmarks/v1/fixed-income-constituents | Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. *factsetbenchmarks.HelperApi* | [**getBenchmarkIds**](docs/HelperApi.md#getBenchmarkIds) | **GET** /factset-benchmarks/v1/id-list | Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints. *factsetbenchmarks.HelperApi* | [**getBenchmarkIdsForList**](docs/HelperApi.md#getBenchmarkIdsForList) | **POST** /factset-benchmarks/v1/id-list | Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints. *factsetbenchmarks.IndexLevelApi* | [**getBenchmarkRatios**](docs/IndexLevelApi.md#getBenchmarkRatios) | **GET** /factset-benchmarks/v1/ratios | Returns the aggregated ratios of a requested benchmark *factsetbenchmarks.IndexLevelApi* | [**getBenchmarkRatiosForList**](docs/IndexLevelApi.md#getBenchmarkRatiosForList) | **POST** /factset-benchmarks/v1/ratios | Returns the aggregated ratios of a requested benchmark *factsetbenchmarks.IndexLevelApi* | [**getIndexHistory**](docs/IndexLevelApi.md#getIndexHistory) | **GET** /factset-benchmarks/v1/index-history | Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range. *factsetbenchmarks.IndexLevelApi* | [**getIndexHistoryForList**](docs/IndexLevelApi.md#getIndexHistoryForList) | **POST** /factset-benchmarks/v1/index-history | Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range. *factsetbenchmarks.IndexLevelApi* | [**getIndexReturns**](docs/IndexLevelApi.md#getIndexReturns) | **GET** /factset-benchmarks/v1/index-returns | Retrieves cumulative index returns over a specified date range for a list of benchmark identifiers via query parameters *factsetbenchmarks.IndexLevelApi* | [**getIndexReturnsForList**](docs/IndexLevelApi.md#getIndexReturnsForList) | **POST** /factset-benchmarks/v1/index-returns | Retrieves cumulative index returns over a specified date range for a list of benchmark identifiers via JSON Request body *factsetbenchmarks.IndexLevelApi* | [**getIndexSnapshot**](docs/IndexLevelApi.md#getIndexSnapshot) | **GET** /factset-benchmarks/v1/index-snapshot | Index Level Prices, Returns, and related information as of a single date. *factsetbenchmarks.IndexLevelApi* | [**getIndexSnapshotForList**](docs/IndexLevelApi.md#getIndexSnapshotForList) | **POST** /factset-benchmarks/v1/index-snapshot | Retrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date. ## Documentation for Models - [factsetbenchmarks.BenchmarkConstituent](docs/BenchmarkConstituent.md) - [factsetbenchmarks.BenchmarkConstituentsRequest](docs/BenchmarkConstituentsRequest.md) - [factsetbenchmarks.BenchmarkConstituentsResponse](docs/BenchmarkConstituentsResponse.md) - [factsetbenchmarks.BenchmarkIdList](docs/BenchmarkIdList.md) - [factsetbenchmarks.BenchmarkIdListRequest](docs/BenchmarkIdListRequest.md) - [factsetbenchmarks.BenchmarkIdListResponse](docs/BenchmarkIdListResponse.md) - [factsetbenchmarks.BenchmarkRatios](docs/BenchmarkRatios.md) - [factsetbenchmarks.BenchmarkRatiosRequest](docs/BenchmarkRatiosRequest.md) - [factsetbenchmarks.BenchmarkRatiosResponse](docs/BenchmarkRatiosResponse.md) - [factsetbenchmarks.Calendar](docs/Calendar.md) - [factsetbenchmarks.ErrorResponse](docs/ErrorResponse.md) - [factsetbenchmarks.ErrorResponseSubErrors](docs/ErrorResponseSubErrors.md) - [factsetbenchmarks.FamilyFilter](docs/FamilyFilter.md) - [factsetbenchmarks.FixedIncomeBenchmarkConstituent](docs/FixedIncomeBenchmarkConstituent.md) - [factsetbenchmarks.FixedIncomeBenchmarkConstituentsRequest](docs/FixedIncomeBenchmarkConstituentsRequest.md) - [factsetbenchmarks.FixedIncomeBenchmarkConstituentsResponse](docs/FixedIncomeBenchmarkConstituentsResponse.md) - [factsetbenchmarks.Frequency](docs/Frequency.md) - [factsetbenchmarks.HedgeType](docs/HedgeType.md) - [factsetbenchmarks.ImpliedDate](docs/ImpliedDate.md) - [factsetbenchmarks.IndexHistory](docs/IndexHistory.md) - [factsetbenchmarks.IndexHistoryRequest](docs/IndexHistoryRequest.md) - [factsetbenchmarks.IndexHistoryResponse](docs/IndexHistoryResponse.md) - [factsetbenchmarks.IndexReturns](docs/IndexReturns.md) - [factsetbenchmarks.IndexReturnsRequest](docs/IndexReturnsRequest.md) - [factsetbenchmarks.IndexReturnsResponse](docs/IndexReturnsResponse.md) - [factsetbenchmarks.IndexSnapshot](docs/IndexSnapshot.md) - [factsetbenchmarks.IndexSnapshotRequest](docs/IndexSnapshotRequest.md) - [factsetbenchmarks.IndexSnapshotResponse](docs/IndexSnapshotResponse.md) - [factsetbenchmarks.Periodicity](docs/Periodicity.md) - [factsetbenchmarks.ReturnType](docs/ReturnType.md) ## 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](../../../../CONTRIBUTING.md). # Copyright Copyright 2026 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. --- _Source: https://npm.io/package/@factset/sdk-factsetbenchmarks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._