@factset/sdk-investmentresearch
v1.0.0
Published
Investment Research client library for JavaScript
Downloads
172
Readme
Investment Research client library for JavaScript
The Investment Research API provides a comprehensive set of functionalities for searching and retrieving research reports and documents from various contributors.
This API is designed to expose document search and document retrieval functionality. A document search will allow a request to query FactSet document databases based on certain search criteria specified in the request.
FactSet collects research reports and models from brokers, independent research providers, market research firms, rating agencies, and other publishers of research. These documents are processed and made available to clients within about two minutes of receipt.
FactSet delivers this content through the FactSet Research Connect product, which enables real-time research for investment managers entitled by the contributors to access the content
The meta endpoints namely time-zones, categories, research-contributors, research-analysts, security-types and asset-types provide comprehensive lists of data that is used in the research endpoints."
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- SDK version: 1.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
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18(optional) Install yarn.
- Install dependencies.
- 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, MetaApi } = require('@factset/sdk-investmentresearch');
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 MetaApi();
// Call api endpoint
apiInstance.getAssetTypes().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-investmentresearch');
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/investment-research/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- investmentresearch.MetaApi | getAssetTypes | GET /meta/asset-types | Returns the codes indicating asset types. investmentresearch.MetaApi | getCategories | GET /meta/categories | Returns the categories. investmentresearch.MetaApi | getResearchAnalyst | GET /meta/research-analysts | Returns the research analysts' details. investmentresearch.MetaApi | getResearchContributor | GET /meta/research-contributors | Returns the research contributors' details. investmentresearch.MetaApi | getSecurityTypes | GET /meta/security-types | Returns the codes indicating security types. investmentresearch.MetaApi | getTimezones | GET /meta/time-zones | Returns the time zones. investmentresearch.ResearchApi | getCount | POST /count | Returns the count of documents for specified source. investmentresearch.ResearchApi | getInvestmentResearchData | POST /search | Retrieve investment research documents and related metadata within FactSet coverage.
Documentation for Models
- investmentresearch.AssetResponse
- investmentresearch.AssetTypesResponse
- investmentresearch.CategoriesResponse
- investmentresearch.CategoriesResponseObject
- investmentresearch.CountRequest
- investmentresearch.CountRequestBody
- investmentresearch.CountResponse
- investmentresearch.CountResponseObject
- investmentresearch.Document
- investmentresearch.ErrorExample
- investmentresearch.ErrorResponse
- investmentresearch.InvalidIdErrorObject
- investmentresearch.InvestmentResearchResponse
- investmentresearch.InvestmentResearchResponseItems
- investmentresearch.InvestmentResearchResponseMeta
- investmentresearch.InvestmentResearchResponseMetaPagination
- investmentresearch.ResearchAnalystResponse
- investmentresearch.ResearchAnalystResponseObject
- investmentresearch.ResearchContributorResponse
- investmentresearch.ResearchContributorResponseObject
- investmentresearch.SearchRequest
- investmentresearch.SearchRequestBody
- investmentresearch.SearchRequestMeta
- investmentresearch.SearchRequestMetaPagination
- investmentresearch.SecurityResponse
- investmentresearch.SecurityTypesResponse
- investmentresearch.TimeZoneResponse
- investmentresearch.TimeZonesResponse
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 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.0Unless 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.
