npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@factset/sdk-factsetprices

v2.0.0

Published

FactSet Prices client library for JavaScript

Downloads

107

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

FactSet Prices client library for JavaScript

API Version npm Apache-2 license

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.Rate limit is set to 25 requests per second.

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

  • API version: 1.3.0
  • SDK version: 2.0.0
  • Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

  • Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment

    1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
nvm use 18

    2. (optional) Install yarn.

  3. Install dependencies.
  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

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

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-factsetprices');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

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

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.