@factset/sdk-factsetprices

FactSet Prices client library for JavaScript

Gain access to comprehensive global coverage for Equities & Fixed Income. Perform quick analytics by controlling the date ranges, currencies, and rolling periods, or simply request Open, High, Low, and Close prices. Easily connect pricing data with other core company data or alternative content sets using FactSet's hub and spoke symbology.

Equity and Fund Security types include Common Stock, ADR, GDR, Preferred, Closed-ended Fund, Exchange Traded Fund, Unit, Open-ended Fund, Exchange Traded Fund UVI, Exchange Traded Fund NAV, Preferred Equity, Non-Voting Depositary Receipt/Certificate, Alien/Foreign, Structured Product, and Temporary Instruments. Reference over 180,000+ active and inactive securities.

Fixed Income Security Types include Corporate Bonds, Treasury and Agency bonds, Government Bonds, and Municipals.

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

• API version: 1.3.0
• Package version: 1.1.3
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

• Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetprices@1.1.3

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetprices@1.1.3

Usage

1. Generate authentication credentials.
2. 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.

3. Install dependencies.
4. Run the following:

const { ApiClient, BatchProcessingApi } = require('@factset/sdk-factsetprices');
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/content

Class	Method	HTTP request	Description
factsetprices.BatchProcessingApi	getBatchData	GET /batch/v1/result	Returns the response for a Batch Request
factsetprices.BatchProcessingApi	getBatchDataWithPost	POST /batch/v1/result	Returns the response for a Batch Request
factsetprices.BatchProcessingApi	getBatchStatus	GET /batch/v1/status	Returns the status for a Batch Request
factsetprices.BatchProcessingApi	getBatchStatusWithPost	POST /batch/v1/status	Returns the status for a Batch Request
factsetprices.DatabaseRolloverApi	getDatabaseRollover	GET /factset-prices/v1/database-rollover	Gets the latest relative rollover date for the database.
factsetprices.DatabaseRolloverApi	getDatabaseRolloverForList	POST /factset-prices/v1/database-rollover	Gets the latest relative rollover date for the database.
factsetprices.DividendsApi	getSecurityDividends	GET /factset-prices/v1/dividends	Gets dividend information for a given date range and list of securities
factsetprices.DividendsApi	getSecurityDividendsForList	POST /factset-prices/v1/dividends	Requests dividend information for a given date range and list of securities
factsetprices.HighLowApi	getHighLow	GET /factset-prices/v1/high-low	Gets the price high and price low of securities for a list of `ids` as of given date, period and frequency.
factsetprices.HighLowApi	getHighLowForList	POST /factset-prices/v1/high-low	Requests the price high and price low of securities for a list of `ids` as of given date, period and frequency.
factsetprices.MarketValueApi	getMarketValue	GET /factset-prices/v1/market-value	Gets the security level and company level market values for a list of `ids` as of given date range and frequency.
factsetprices.MarketValueApi	getMarketValueForList	POST /factset-prices/v1/market-value	Requests the market value for a list of `ids` as of given date range.
factsetprices.PricesApi	getFixedSecurityPrices	GET /factset-prices/v1/fixed-income	Gets pricing for a list of Fixed Income securities
factsetprices.PricesApi	getFixedSecurityPricesForList	POST /factset-prices/v1/fixed-income	Requests pricing for a list of Fixed Income securities for date range requested
factsetprices.PricesApi	getSecurityPrices	GET /factset-prices/v1/prices	Gets end-of-day Open, High, Low, Close for a list of securities.
factsetprices.PricesApi	getSecurityPricesForList	POST /factset-prices/v1/prices	Requests end-of-day Open, High, Low, Close for a large list of securities.
factsetprices.ReferenceApi	getSecurityReferenceForList	POST /factset-prices/v1/references	Requests security reference details a list of securities
factsetprices.ReferenceApi	getSecurityReferences	GET /factset-prices/v1/references	Gets security reference details for a list of securities
factsetprices.ReturnsApi	getReturnsSnapshot	GET /factset-prices/v1/returns-snapshot	Returns the price performance of the security and annualized compound total returns.
factsetprices.ReturnsApi	getReturnsSnapshotForList	POST /factset-prices/v1/returns-snapshot	Returns the price performance of the security and annualized compound total returns.
factsetprices.ReturnsApi	getSecurityReturns	GET /factset-prices/v1/returns	Gets Returns for a list of `ids` as of given date range and rolling Period
factsetprices.ReturnsApi	getSecurityReturnsForList	POST /factset-prices/v1/returns	Requests security returns for the given date range and rollingPeriod.
factsetprices.SharesApi	getSecurityShares	GET /factset-prices/v1/shares	Gets shares for a list of `ids` as of given date range.
factsetprices.SharesApi	getSecuritySharesForList	POST /factset-prices/v1/shares	Requests shares for a list of `ids` as of given date range.
factsetprices.SplitsApi	getSecuritySplits	GET /factset-prices/v1/splits	Gets full history of security Splits for a list of `ids`
factsetprices.SplitsApi	getSecuritySplitsForList	POST /factset-prices/v1/splits	Requests splits for a list of `ids`

Documentation for Models

• factsetprices.Adjust
• factsetprices.Batch
• factsetprices.BatchDataRequest
• factsetprices.BatchDataResponse
• factsetprices.BatchStatus
• factsetprices.BatchStatusRequest
• factsetprices.BatchStatusResponse
• factsetprices.Calendar
• factsetprices.Dividend
• factsetprices.DividendAdjust
• factsetprices.DividendAdjustSnapshot
• factsetprices.DividendsRequest
• factsetprices.DividendsResponse
• factsetprices.ErrorResponse
• factsetprices.ErrorResponseSubErrors
• factsetprices.FixedIncomePrice
• factsetprices.Frequency
• factsetprices.FrequencyFi
• factsetprices.HighLow
• factsetprices.HighLowRequest
• factsetprices.HighLowResponse
• factsetprices.MarketValue
• factsetprices.MarketValueRequest
• factsetprices.MarketValueResponse
• factsetprices.Period
• factsetprices.Price
• factsetprices.PriceType
• factsetprices.PricesFixedIncomeRequest
• factsetprices.PricesFixedIncomeResponse
• factsetprices.PricesRequest
• factsetprices.PricesResponse
• factsetprices.References
• factsetprices.ReferencesRequest
• factsetprices.ReferencesResponse
• factsetprices.Return
• factsetprices.ReturnsRequest
• factsetprices.ReturnsResponse
• factsetprices.ReturnsSnapshot
• factsetprices.ReturnsSnapshotRequest
• factsetprices.ReturnsSnapshotResponse
• factsetprices.RollingPeriod
• factsetprices.Rollover
• factsetprices.RolloverResponse
• factsetprices.Shares
• factsetprices.SharesRequest
• factsetprices.SharesResponse
• factsetprices.SplitAdjust
• factsetprices.Splits
• factsetprices.SplitsRequest
• factsetprices.SplitsResponse

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.