@factset/sdk-factsetfundamentals

FactSet Fundamentals client library for JavaScript

Gain access to current, comprehensive, and comparative information on securities in worldwide developed and emerging markets. Composed of annual and interim/quarterly data, detailed historical financial statement content, per-share data, and calculated ratios, FactSet Fundamentals provides you with the information you need for a global investment perspective.

This API is rate-limited 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: 2.2.0
• SDK version: 3.1.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-factsetfundamentals@3.1.0

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetfundamentals@3.1.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, BatchProcessingApi } = require('@factset/sdk-factsetfundamentals');
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 BatchProcessingApi();
const id = "id_example"; // String | Batch Request identifier.

// Call api endpoint
apiInstance.getBatchData(id).then(
  data => {

      // data is a responsewrapper: GetBatchDataResponseWrapper
      switch (data.statusCode) {

          case 200:
             // BatchResultResponse
             console.log(data.getResponse200());
             break;

          case 202:
             // BatchStatusResponse
             console.log(data.getResponse202());
             break;

      }

  },
  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-factsetfundamentals');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[e-mail]:8080');

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
factsetfundamentals.BatchProcessingApi	getBatchData	GET /batch-result	Returns the response for a Batch Request
factsetfundamentals.BatchProcessingApi	getBatchStatus	GET /batch-status	Returns the status for a Batch Request
factsetfundamentals.CompanyReportsApi	getFdsProfiles	GET /company-reports/profile	Returns company profile information for a specified list of identifiers.
factsetfundamentals.CompanyReportsApi	getFinancials	GET /company-reports/financial-statement	Returns company financial data.
factsetfundamentals.CompanyReportsApi	getFundamentals	GET /company-reports/fundamentals	Returns company fundamentals for a given list of identifiers.
factsetfundamentals.FactSetFundamentalsApi	getFdsFundamentals	GET /fundamentals	Returns Company Fundamental Data.
factsetfundamentals.FactSetFundamentalsApi	getFdsFundamentalsForList	POST /fundamentals	Returns Company Fundamental Data.
factsetfundamentals.MetricsApi	getFdsFundamentalsMetrics	GET /metrics	Returns available FactSet Fundamental metrics and ratios.
factsetfundamentals.SegmentsApi	getFdsSegments	GET /segments	Returns Company Segments data.
factsetfundamentals.SegmentsApi	getFdsSegmentsForList	POST /segments	Returns Company Segment Data.

Documentation for Models

• factsetfundamentals.Address
• factsetfundamentals.Batch
• factsetfundamentals.BatchErrorObject
• factsetfundamentals.BatchResult
• factsetfundamentals.BatchResultResponse
• factsetfundamentals.BatchStatus
• factsetfundamentals.BatchStatusResponse
• factsetfundamentals.CompanyFundamentalsResponse
• factsetfundamentals.CompanyReportErrorObject
• factsetfundamentals.Dividend
• factsetfundamentals.ErrorObject
• factsetfundamentals.ErrorObjectLinks
• factsetfundamentals.ErrorResponse
• factsetfundamentals.Exchange
• factsetfundamentals.FinancialResponse
• factsetfundamentals.Financials
• factsetfundamentals.FiscalPeriod
• factsetfundamentals.Fundamental
• factsetfundamentals.FundamentalRequestBody
• factsetfundamentals.FundamentalValue
• factsetfundamentals.Fundamentals
• factsetfundamentals.FundamentalsRequest
• factsetfundamentals.FundamentalsResponse
• factsetfundamentals.Item
• factsetfundamentals.Metric
• factsetfundamentals.MetricsResponse
• factsetfundamentals.PerShare
• factsetfundamentals.Periodicity
• factsetfundamentals.Profile
• factsetfundamentals.ProfileResponse
• factsetfundamentals.Ratios
• factsetfundamentals.Segment
• factsetfundamentals.SegmentRequestBody
• factsetfundamentals.SegmentType
• factsetfundamentals.SegmentValue
• factsetfundamentals.SegmentsPeriodicity
• factsetfundamentals.SegmentsRequest
• factsetfundamentals.SegmentsResponse
• factsetfundamentals.UpdateType

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.