[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com) # FactSet Global Prices client library for JavaScript [![API Version](https://img.shields.io/badge/api-v1.8.0-blue)]() [![npm](https://img.shields.io/badge/npm-v3.1.1-orange)](https://www.npmjs.com/package/@factset/sdk-factsetglobalprices/v/3.1.1) [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) The FactSet Global Prices API provides end of day market pricing content using cloud and microservices technology, encompassing both pricing as well as corporate actions and events data.

This TypeScript/JavaScript package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.8.0 - SDK version: 3.1.1 - Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen ## Requirements * Node.js >= 18 ## Installation ### npm ```shell npm install @factset/sdk-utils @factset/sdk-factsetglobalprices@3.1.1 ``` ### yarn ```shell yarn add @factset/sdk-utils @factset/sdk-factsetglobalprices@3.1.1 ``` ## 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, BatchProcessingApi } = require('@factset/sdk-factsetglobalprices'); 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: ```javascript const { ApiClient } = require('@factset/sdk-factsetglobalprices'); 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/content* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *factsetglobalprices.BatchProcessingApi* | [**getBatchData**](docs/BatchProcessingApi.md#getBatchData) | **GET** /factset-global-prices/v1/batch-result | Returns the response for a Batch Request *factsetglobalprices.BatchProcessingApi* | [**getBatchStatus**](docs/BatchProcessingApi.md#getBatchStatus) | **GET** /factset-global-prices/v1/batch-status | Returns the status for a Batch Request *factsetglobalprices.CorporateActionsApi* | [**getGPDCorporateActions**](docs/CorporateActionsApi.md#getGPDCorporateActions) | **GET** /factset-global-prices/v1/corporate-actions | Gets Corporate Actions information. *factsetglobalprices.CorporateActionsApi* | [**getannualizedDividends**](docs/CorporateActionsApi.md#getannualizedDividends) | **GET** /factset-global-prices/v1/annualized-dividends | Gets Indicated Annualized Dividend information. *factsetglobalprices.CorporateActionsApi* | [**getannualizedDividendsForList**](docs/CorporateActionsApi.md#getannualizedDividendsForList) | **POST** /factset-global-prices/v1/annualized-dividends | Gets Indicated Annualized Dividend information. *factsetglobalprices.CorporateActionsApi* | [**postCorporateActions**](docs/CorporateActionsApi.md#postCorporateActions) | **POST** /factset-global-prices/v1/corporate-actions | Requests Corporate Actions information. *factsetglobalprices.PricesApi* | [**getGPDPrices**](docs/PricesApi.md#getGPDPrices) | **GET** /factset-global-prices/v1/prices | Gets end-of-day Open, High, Low, Close for a list of securities. *factsetglobalprices.PricesApi* | [**getSecurityPricesForList**](docs/PricesApi.md#getSecurityPricesForList) | **POST** /factset-global-prices/v1/prices | Requests end-of-day Open, High, Low, Close for a large list of securities. *factsetglobalprices.ReturnsApi* | [**getReturns**](docs/ReturnsApi.md#getReturns) | **GET** /factset-global-prices/v1/returns | Gets Returns for a list of `ids` as of given date range. *factsetglobalprices.ReturnsApi* | [**getReturnsForList**](docs/ReturnsApi.md#getReturnsForList) | **POST** /factset-global-prices/v1/returns | Gets Returns for a list of `ids` as of given date range. *factsetglobalprices.SharesOutstandingApi* | [**getSharesOutstanding**](docs/SharesOutstandingApi.md#getSharesOutstanding) | **GET** /factset-global-prices/v1/security-shares | Gets Shares Outstanding information for securities. *factsetglobalprices.SharesOutstandingApi* | [**postSharesOutstanding**](docs/SharesOutstandingApi.md#postSharesOutstanding) | **POST** /factset-global-prices/v1/security-shares | Gets Shares Outstanding information for securities. ## Documentation for Models - [factsetglobalprices.Adjust](docs/Adjust.md) - [factsetglobalprices.AnnualizedDividendResponse](docs/AnnualizedDividendResponse.md) - [factsetglobalprices.AnnualizedDividendsObject](docs/AnnualizedDividendsObject.md) - [factsetglobalprices.AnnualizedDividendsRequest](docs/AnnualizedDividendsRequest.md) - [factsetglobalprices.Batch](docs/Batch.md) - [factsetglobalprices.BatchErrorObject](docs/BatchErrorObject.md) - [factsetglobalprices.BatchErrorObjectLinks](docs/BatchErrorObjectLinks.md) - [factsetglobalprices.BatchErrorResponse](docs/BatchErrorResponse.md) - [factsetglobalprices.BatchResult](docs/BatchResult.md) - [factsetglobalprices.BatchResultResponse](docs/BatchResultResponse.md) - [factsetglobalprices.BatchStatus](docs/BatchStatus.md) - [factsetglobalprices.BatchStatusResponse](docs/BatchStatusResponse.md) - [factsetglobalprices.Calendar](docs/Calendar.md) - [factsetglobalprices.CancelledDividend](docs/CancelledDividend.md) - [factsetglobalprices.CashDividendsResponse](docs/CashDividendsResponse.md) - [factsetglobalprices.CorporateAction](docs/CorporateAction.md) - [factsetglobalprices.CorporateActionsRequest](docs/CorporateActionsRequest.md) - [factsetglobalprices.CorporateActionsResponse](docs/CorporateActionsResponse.md) - [factsetglobalprices.Distribution](docs/Distribution.md) - [factsetglobalprices.Dividend](docs/Dividend.md) - [factsetglobalprices.DividendAdjust](docs/DividendAdjust.md) - [factsetglobalprices.ErrorResponse](docs/ErrorResponse.md) - [factsetglobalprices.ErrorResponseSubErrors](docs/ErrorResponseSubErrors.md) - [factsetglobalprices.EventCategory](docs/EventCategory.md) - [factsetglobalprices.Frequency](docs/Frequency.md) - [factsetglobalprices.GlobalPricesRequest](docs/GlobalPricesRequest.md) - [factsetglobalprices.GlobalPricesResponse](docs/GlobalPricesResponse.md) - [factsetglobalprices.Price](docs/Price.md) - [factsetglobalprices.Returns](docs/Returns.md) - [factsetglobalprices.ReturnsRequest](docs/ReturnsRequest.md) - [factsetglobalprices.ReturnsResponse](docs/ReturnsResponse.md) - [factsetglobalprices.RightsIssueResponse](docs/RightsIssueResponse.md) - [factsetglobalprices.SharesOutstandingRequest](docs/SharesOutstandingRequest.md) - [factsetglobalprices.SharesOutstandingRequestBody](docs/SharesOutstandingRequestBody.md) - [factsetglobalprices.SharesOutstandingResponse](docs/SharesOutstandingResponse.md) - [factsetglobalprices.SharesOutstandingResponseObject](docs/SharesOutstandingResponseObject.md) - [factsetglobalprices.SoErrorObject](docs/SoErrorObject.md) - [factsetglobalprices.SoErrorObjectLinks](docs/SoErrorObjectLinks.md) - [factsetglobalprices.SoErrorResponse](docs/SoErrorResponse.md) - [factsetglobalprices.SpinoffsResponse](docs/SpinoffsResponse.md) - [factsetglobalprices.Split](docs/Split.md) - [factsetglobalprices.SplitsResponse](docs/SplitsResponse.md) - [factsetglobalprices.StockDistributionsResponse](docs/StockDistributionsResponse.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 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.