@factset/sdk-formula NPM

Formula client library for JavaScript

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

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 project:

API version: 1.7.1
Package version: 2.2.2
Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-formula@2.2.2

yarn

yarn add @factset/sdk-utils @factset/sdk-formula@2.2.2

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=14. If you're using nvm:
```
nvm install 16
nvm use 16
```
2. (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, BatchProcessingApi } = 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 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:
             // BatchDataResponse
             console.log(data.getResponse200());
             break;

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

      }

  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/formula-api

Class	Method	HTTP request	Description
formula.BatchProcessingApi	getBatchData	GET /v1/batch-result	Returns the response for a Batch Request
formula.BatchProcessingApi	getBatchDataWithPost	POST /v1/batch-result	Returns the status for a Batch Request
formula.BatchProcessingApi	getBatchStatus	GET /v1/batch-status	Returns the status for a Batch Request
formula.BatchProcessingApi	getBatchStatusWithPost	POST /v1/batch-status	Returns the status for a Batch Request
formula.CrossSectionalApi	getCrossSectionalData	GET /v1/cross-sectional	Retrieve data items (Screening formulas) for a list of identifiers or defined universe.
formula.CrossSectionalApi	getCrossSectionalDataForList	POST /v1/cross-sectional	Retrieve data items (Screening formulas) for a list of identifiers or defined universe.
formula.TimeSeriesApi	getTimeSeriesData	GET /v1/time-series	Retrieve data items (FQL formulas) for a list of identifiers or defined universe.
formula.TimeSeriesApi	getTimeSeriesDataForList	POST /v1/time-series	Retrieve data items (FQL formulas) for a list of identifiers or defined universe.

Documentation for Models

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

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

3 months ago

7 months ago

8 months ago

8 months ago