@factset/sdk-factsetglobalprices NPM

FactSet Global Prices client library for JavaScript

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

API version: 1.7.0
Package version: 2.1.0
Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetglobalprices@2.1.0

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetglobalprices@2.1.0

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:

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
factsetglobalprices.BatchProcessingApi	getBatchData	GET /factset-global-prices/v1/batch-result	Returns the response for a Batch Request
factsetglobalprices.BatchProcessingApi	getBatchStatus	GET /factset-global-prices/v1/batch-status	Returns the status for a Batch Request
factsetglobalprices.CorporateActionsApi	getGPDCorporateActions	GET /factset-global-prices/v1/corporate-actions	Gets Corporate Actions information.
factsetglobalprices.CorporateActionsApi	getannualizedDividends	GET /factset-global-prices/v1/annualized-dividends	Gets Indicated Annualized Dividend information.
factsetglobalprices.CorporateActionsApi	getannualizedDividendsForList	POST /factset-global-prices/v1/annualized-dividends	Gets Indicated Annualized Dividend information.
factsetglobalprices.CorporateActionsApi	postCorporateActions	POST /factset-global-prices/v1/corporate-actions	Requests Corporate Actions information.
factsetglobalprices.PricesApi	getGPDPrices	GET /factset-global-prices/v1/prices	Gets end-of-day Open, High, Low, Close for a list of securities.
factsetglobalprices.PricesApi	getSecurityPricesForList	POST /factset-global-prices/v1/prices	Requests end-of-day Open, High, Low, Close for a large list of securities.
factsetglobalprices.ReturnsApi	getReturns	GET /factset-global-prices/v1/returns	Gets Returns for a list of `ids` as of given date range.
factsetglobalprices.ReturnsApi	getReturnsForList	POST /factset-global-prices/v1/returns	Gets Returns for a list of `ids` as of given date range.
factsetglobalprices.SharesOutstandingApi	getSharesOutstanding	GET /factset-global-prices/v1/security-shares	Gets Shares Outstanding information for securities.
factsetglobalprices.SharesOutstandingApi	postSharesOutstanding	POST /factset-global-prices/v1/security-shares	Gets Shares Outstanding information for securities.

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

7 months ago

8 months ago

6 months ago

6 months ago