@factset/sdk-formula/README.md

Formula client library for JavaScript

[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)

# Formula client library for JavaScript

[![API Version](https://img.shields.io/badge/api-v1.13.0-blue)](https://developer.factset.com/api-catalog/formula-api)
[![npm](https://img.shields.io/badge/npm-v5.0.0-orange)](https://www.npmjs.com/package/@factset/sdk-formula/v/5.0.0)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)


**FactSet Formula API**

FactSet's Formula API is a modern, flexible, formula-based API that enables users to access FactSet's wide range of financial data and content. The API offers two endpoints, one optimized for time-series analysis and one designed for cross-sectional analysis, providing users a simplified interface into FactSet's expansive offering. By providing two endpoints, it allows for the optimization of user workflows, while reducing complexity.

Leverage the power and flexibility of the Formula API to -
  * Pull data from across most content sets that a user has access to in a single request
  * Include business logic and mathematical operations in request
  * Submit a dynamic universe in both endpoints
  * Return the fsymId to easily combine with other FactSet content / products
  * Set the trading calendar
  * Define custom display names

**Formula API Request Builder**

The Formula API Request Builder provides users everything they need to form a Formula API request. In the Request Builder, you can select identifiers, build a universe expression, select FQL or Screening formulas, easily apply business logic and mathematical functions to the FQL or Screening formulas, specify optional parameters, and construct a GET or POST request. The Request Builder eliminates the need to have previous FQL and Screening knowledge and allows you to quickly find your desired data items and form the request.

The Formula API Request Builder can be accessed by navigating to [https://developer.factset.com/formula-api-request-builder](https://developer.factset.com/formula-api-request-builder) and logging in using your FactSet.net ID. When using the Request Builder to construct requests for the one of the Formula API's endpoints, be sure to toggle to the correct endpoint at the top of the page.

**How to Check the Health and Availability of the Formula API**

Please use the below endpoint to check the health and availability of the Formula API. You must be authorized for this API to use the Health endpoint.

[https://api.factset.com/formula-api/health](https://api.factset.com/formula-api/health)

**How to Programmatically Download API Specification File**

You can download the FactSet Formula API Specification File in .yaml. using the \"Download Spec\" button to the right of the version number. This specification can then be used for Codegen to create your own SDKs.


This TypeScript/JavaScript package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.13.0
- SDK version: 5.0.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)

## Requirements

* Node.js >= 18

## Installation

### npm

```shell
npm install @factset/sdk-utils @factset/sdk-formula@5.0.0
```

### yarn

```shell
yarn add @factset/sdk-utils @factset/sdk-formula@5.0.0
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Node.js environment
   1. Install and activate Node.js >=18. If you're using [nvm](https://github.com/nvm-sh/nvm):

      ```sh
      nvm install 18
      nvm use 18
      ```

   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, TimeSeriesApi } = require('@factset/sdk-formula');
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 TimeSeriesApi();
const timeSeriesRequest = {"data":{"ids":["IBM"],"formulas":["P_PRICE(0)"]}}; // TimeSeriesRequest | 

// Call api endpoint
apiInstance.getTimeSeriesDataForList(timeSeriesRequest).then(
  data => {

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

          case 200:
             // TimeSeriesResponse
             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:

```javascript
const { ApiClient } = require('@factset/sdk-formula');

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/formula-api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*formula.BatchProcessingApi* | [**cancelBatchJob**](docs/BatchProcessingApi.md#cancelBatchJob) | **DELETE** /batch-cancel | Cancels individual ongoing Batch Request
*formula.BatchProcessingApi* | [**getBatchData**](docs/BatchProcessingApi.md#getBatchData) | **GET** /batch-result | Returns the response for a Batch Request
*formula.BatchProcessingApi* | [**getBatchDataWithPost**](docs/BatchProcessingApi.md#getBatchDataWithPost) | **POST** /batch-result | Returns the response for a Batch Request
*formula.BatchProcessingApi* | [**getBatchList**](docs/BatchProcessingApi.md#getBatchList) | **GET** /batch-list | Returns a list of all available Batch Requests submitted by a user
*formula.BatchProcessingApi* | [**getBatchStatus**](docs/BatchProcessingApi.md#getBatchStatus) | **GET** /batch-status | Returns the status for a Batch Request
*formula.BatchProcessingApi* | [**getBatchStatusWithPost**](docs/BatchProcessingApi.md#getBatchStatusWithPost) | **POST** /batch-status | Returns the status for a Batch Request
*formula.CrossSectionalApi* | [**getCrossSectionalData**](docs/CrossSectionalApi.md#getCrossSectionalData) | **GET** /cross-sectional | Retrieve data items (Screening formulas) for a list of identifiers or defined universe.
*formula.CrossSectionalApi* | [**getCrossSectionalDataForList**](docs/CrossSectionalApi.md#getCrossSectionalDataForList) | **POST** /cross-sectional | Retrieve data items (Screening formulas) for a list of identifiers or defined universe.
*formula.TimeSeriesApi* | [**getTimeSeriesData**](docs/TimeSeriesApi.md#getTimeSeriesData) | **GET** /time-series | Retrieve data items (FQL formulas) for a list of identifiers or defined universe.
*formula.TimeSeriesApi* | [**getTimeSeriesDataForList**](docs/TimeSeriesApi.md#getTimeSeriesDataForList) | **POST** /time-series | Retrieve data items (FQL formulas) for a list of identifiers or defined universe.


## Documentation for Models

 - [formula.BatchData](docs/BatchData.md)
 - [formula.BatchDataRequest](docs/BatchDataRequest.md)
 - [formula.BatchDataRequestData](docs/BatchDataRequestData.md)
 - [formula.BatchDataResponse](docs/BatchDataResponse.md)
 - [formula.BatchList](docs/BatchList.md)
 - [formula.BatchListResponse](docs/BatchListResponse.md)
 - [formula.BatchListResponseMeta](docs/BatchListResponseMeta.md)
 - [formula.BatchStatus](docs/BatchStatus.md)
 - [formula.BatchStatusResponse](docs/BatchStatusResponse.md)
 - [formula.CrossSectionalRequest](docs/CrossSectionalRequest.md)
 - [formula.CrossSectionalRequestData](docs/CrossSectionalRequestData.md)
 - [formula.CrossSectionalResponse](docs/CrossSectionalResponse.md)
 - [formula.CrossSectionalResponseObjectItems](docs/CrossSectionalResponseObjectItems.md)
 - [formula.CrossSectionalResultObjectNonflattened](docs/CrossSectionalResultObjectNonflattened.md)
 - [formula.CrossSectionalResultObjectNonflattenedResultAttribute](docs/CrossSectionalResultObjectNonflattenedResultAttribute.md)
 - [formula.ErrorDetail](docs/ErrorDetail.md)
 - [formula.ErrorObject](docs/ErrorObject.md)
 - [formula.TimeSeriesRequest](docs/TimeSeriesRequest.md)
 - [formula.TimeSeriesRequestData](docs/TimeSeriesRequestData.md)
 - [formula.TimeSeriesResponse](docs/TimeSeriesResponse.md)
 - [formula.TimeSeriesResponseObjectItems](docs/TimeSeriesResponseObjectItems.md)
 - [formula.TimeSeriesResultObjectNonflattened](docs/TimeSeriesResultObjectNonflattened.md)
 - [formula.TimeSeriesResultObjectNonflattenedArray](docs/TimeSeriesResultObjectNonflattenedArray.md)
 - [formula.TimeSeriesResultObjectNonflattenedBase](docs/TimeSeriesResultObjectNonflattenedBase.md)
 - [formula.TimeSeriesResultObjectNonflattenedMatrix](docs/TimeSeriesResultObjectNonflattenedMatrix.md)
 - [formula.TimeSeriesResultObjectNonflattenedScalar](docs/TimeSeriesResultObjectNonflattenedScalar.md)
 - [formula.TimeSeriesResultObjectNonflattenedTimeseriesObject](docs/TimeSeriesResultObjectNonflattenedTimeseriesObject.md)
 - [formula.TimeSeriesScalarValue](docs/TimeSeriesScalarValue.md)
 - [formula.TimeSeriesTimeseriesObject](docs/TimeSeriesTimeseriesObject.md)
 - [formula.UnifiedResultObjectFlattened](docs/UnifiedResultObjectFlattened.md)
 - [formula.UnifiedResultObjectFlattenedAddl](docs/UnifiedResultObjectFlattenedAddl.md)
 - [formula.WarningsObject](docs/WarningsObject.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 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.