FactSet Private Company client library for JavaScript

FactSet Private Company API encompasses Private Company Financials and includes some Private Company non-periodic data. Additional Private Company firmographics can be found in the FactSet Entity API. Rate limit is set to 10 requests per second and 10 concurrent requests per user.

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

• API version: 1.0.0
• SDK version: 1.0.1
• 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, CompanyReportsApi } = require('@factset/sdk-factsetprivatecompany');
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 CompanyReportsApi();
const ids = ["0H3R4Y-E"]; // [String] | The requested list of Factset Private Company identifiers in XXXXXX-E format <p>***ids limit** =  50 per request*</p> 
const statementType = BS; // String | The type of financial statement being requested
const opts = {
  'currency': USD, // String | Currency code for currency values. For a list of currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470).  Giving input as \"DOC\" would give the values in reporting currency for the requested ids. 
  'numberAnnualPeriods': 4 // Number | The number of annual periods for the returned data which will be displayed in descending order from most recent annual period for the number of annual periods specified. </br>Within range of 1 to 100. If not specified default will be 4.      
};

// Call api endpoint
apiInstance.getFinancialsReport(ids, statementType, 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-factsetprivatecompany');

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/private-company/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetprivatecompany.CompanyReportsApi | getFinancialsReport | GET /company-reports/financial-statement | Returns Private Company Financial Data factsetprivatecompany.CompanyReportsApi | getProfileReport | GET /company-reports/profile | Returns Private Company Non-Periodic Data factsetprivatecompany.FinancialsApi | getFinancials | GET /financials | Returns Private Company Financial Data. factsetprivatecompany.FinancialsApi | getFinancialsForList | POST /financials | Returns Private Company Financial Data. factsetprivatecompany.MetricsApi | getMetrics | GET /metrics | Returns available private company metrics, and ratios. factsetprivatecompany.NonPeriodicApi | getNonPeriodic | GET /non-periodic | Returns Private Company Reference Data. factsetprivatecompany.NonPeriodicApi | getNonPeriodicForList | POST /non-periodic | Returns Private Company Reference Data. factsetprivatecompany.UniverseApi | getUniverse | GET /universe | Returns Entity Candidates and Matches for a single name and attributes. factsetprivatecompany.UniverseApi | getUniverseForList | POST /universe | Returns Entity Candidates and Matches for a requested list of up to 25 names and attributes.

Documentation for Models

• factsetprivatecompany.EntityMatch
• factsetprivatecompany.EntityMatchRequest
• factsetprivatecompany.EntityMatchRequestBody
• factsetprivatecompany.EntityMatchesResponse
• factsetprivatecompany.ErrorObject
• factsetprivatecompany.ErrorObjectLinks
• factsetprivatecompany.ErrorResponse
• factsetprivatecompany.FinancialStatements
• factsetprivatecompany.FinancialStatementsResponse
• factsetprivatecompany.Financials
• factsetprivatecompany.FinancialsRequest
• factsetprivatecompany.FinancialsRequestBody
• factsetprivatecompany.FinancialsResponse
• factsetprivatecompany.Metric
• factsetprivatecompany.MetricsResponse
• factsetprivatecompany.NonPeriodic
• factsetprivatecompany.NonPeriodicRequest
• factsetprivatecompany.NonPeriodicRequestBody
• factsetprivatecompany.NonPeriodicResponse
• factsetprivatecompany.NonPeriodicValue
• factsetprivatecompany.Profile
• factsetprivatecompany.ProfileResponse
• factsetprivatecompany.StatementItem

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 2025 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.