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

v0.11.1

Published

Quotes API for Digital Portals client library for JavaScript

Downloads

17

Vulnerabilities

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

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

Quotes API for Digital Portals client library for JavaScript

npm Apache-2 license

The Quotes API combines endpoints for retrieving security end-of-day, delayed, and realtime prices with performance key figures and basic reference data on the security and market level.

The API supports over 20 different price types for each quote and comes with basic search endpoints based on security identifiers and instrument names. Market coverage is included in the Sample Use Cases section below.

The Digital Portal use case is focused on high-performance applications that are

  • serving millions of end-users,
  • accessible by client browsers via the internet,
  • supporting subscriptions for streamed updates out-of-the-box,
  • typically combining a wide variety of for Digital Portals-APIs into a highly use-case specific solution for customers,
  • integrated into complex infrastructures such as existing frontend frameworks, authentication services.

All APIs labelled for Digital Portals have been designed for direct use by client web applications and feature extreme low latency: The average response time across all endpoints is 30 ms whereas 99% of all requests are answered in close to under 300ms.

See the Time Series API for Digital Portals for direct access to price histories, and the News API for Digital Portals for searching and fetching related news.

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

  • API version: 2
  • Package version: 0.11.1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

  • Node.js >= 14

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 >=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, BasicApi } = require('@factset/sdk-quotesapifordigitalportals');
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
// 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 BasicApi();
const opts = {
  'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};

// Call api endpoint
apiInstance.getBasicAssetClassList(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- quotesapifordigitalportals.BasicApi | getBasicAssetClassList | GET /basic/assetClass/list | List of asset classes. quotesapifordigitalportals.BasicApi | getBasicBenchmarkTypeList | GET /basic/benchmark/type/list | List of benchmark types. quotesapifordigitalportals.BasicApi | getBasicFrequencyTypeList | GET /basic/frequency/type/list | List of frequency types. quotesapifordigitalportals.BasicApi | getBasicLanguageGet | GET /basic/language/get | Details for a language. quotesapifordigitalportals.BasicApi | getBasicLanguageGetByCode | GET /basic/language/getByCode | Details for a language identified by code. quotesapifordigitalportals.BasicApi | getBasicLanguageList | GET /basic/language/list | List of languages. quotesapifordigitalportals.BasicApi | getBasicMarketGet | GET /basic/market/get | Details of a market. quotesapifordigitalportals.BasicApi | getBasicMarketGroupList | GET /basic/market/group/list | List of market groups. quotesapifordigitalportals.BasicApi | getBasicMarketTypeList | GET /basic/market/type/list | List of market types. quotesapifordigitalportals.BasicApi | getBasicMediaKindList | GET /basic/media/kind/list | List of media kinds. quotesapifordigitalportals.BasicApi | getBasicRegionContinentGet | GET /basic/region/continent/get | Details for a continent. quotesapifordigitalportals.BasicApi | getBasicRegionContinentList | GET /basic/region/continent/list | List of continents. quotesapifordigitalportals.BasicApi | getBasicRegionCountryGet | GET /basic/region/country/get | Details for a country. quotesapifordigitalportals.BasicApi | getBasicRegionCountryGetByCode | GET /basic/region/country/getByCode | Details for a country identified by code. quotesapifordigitalportals.BasicApi | getBasicRegionCountryList | GET /basic/region/country/list | List of countries. quotesapifordigitalportals.BasicApi | getBasicRegionGet | GET /basic/region/get | Details for a region. quotesapifordigitalportals.BasicApi | getBasicRegionList | GET /basic/region/list | List of regions. quotesapifordigitalportals.BasicApi | getBasicTimezoneGet | GET /basic/timezone/get | Details of a timezone. quotesapifordigitalportals.BasicApi | getBasicTimezoneGetByName | GET /basic/timezone/getByName | Details of a timezone identified by name. quotesapifordigitalportals.BasicApi | getBasicValueUnitAlternativeList | GET /basic/valueUnit/alternative/list | List of alternative units. quotesapifordigitalportals.BasicApi | getBasicValueUnitCurrencyFractionalGet | GET /basic/valueUnit/currency/fractional/get | Details of a fractional currency. quotesapifordigitalportals.BasicApi | getBasicValueUnitCurrencyFractionalList | GET /basic/valueUnit/currency/fractional/list | List of fractional currencies. quotesapifordigitalportals.BasicApi | getBasicValueUnitGet | GET /basic/valueUnit/get | Details of a value unit. quotesapifordigitalportals.BasicApi | postBasicBackgroundTextTypeList | POST /basic/backgroundText/type/list | List of background text types. quotesapifordigitalportals.BasicApi | postBasicDeliveryList | POST /basic/delivery/list | List of deliveries. quotesapifordigitalportals.BasicApi | postBasicMarketList | POST /basic/market/list | List of markets. quotesapifordigitalportals.BasicApi | postBasicMediaTypeList | POST /basic/media/type/list | List of Internet media types. quotesapifordigitalportals.BasicApi | postBasicMicOperatingList | POST /basic/mic/operating/list | List of operating market identifier codes (MIC). quotesapifordigitalportals.BasicApi | postBasicTimezoneList | POST /basic/timezone/list | List of timezones. quotesapifordigitalportals.BasicApi | postBasicValueUnitCurrencyList | POST /basic/valueUnit/currency/list | List of currencies. quotesapifordigitalportals.BasicApi | postBasicValueUnitCurrencyMainList | POST /basic/valueUnit/currency/main/list | List of main currencies. quotesapifordigitalportals.BasicApi | postBasicValueUnitList | POST /basic/valueUnit/list | List of value units. quotesapifordigitalportals.CategoryApi | getCategoryDatasetList | GET /category/dataset/list | List of entitled category datasets. quotesapifordigitalportals.CategoryApi | getCategoryGet | GET /category/get | Details of a category. quotesapifordigitalportals.CategoryApi | getCategoryInstrumentList | GET /category/instrument/list | List of instruments where a specific dataset has assigned a given category. quotesapifordigitalportals.CategoryApi | getCategoryLevelGet | GET /category/level/get | Details of a category level. quotesapifordigitalportals.CategoryApi | getCategoryList | GET /category/list | List of categories. quotesapifordigitalportals.CategoryApi | getCategoryListByLevel | GET /category/listByLevel | List of categories assigned to a category level. quotesapifordigitalportals.CategoryApi | getCategoryListBySystem | GET /category/listBySystem | List of categories assigned to a category system. quotesapifordigitalportals.CategoryApi | getCategoryPathGet | GET /category/path/get | Path from the first level to the level of a specific category. quotesapifordigitalportals.CategoryApi | getCategorySystemGet | GET /category/system/get | Details of an entitled category system. quotesapifordigitalportals.CategoryApi | getCategorySystemList | GET /category/system/list | List of entitled category systems. quotesapifordigitalportals.CategoryApi | getCategorySystemTypeList | GET /category/system/type/list | List of category system types. quotesapifordigitalportals.InstrumentApi | getInstrumentBackgroundTextListByInstrument | GET /instrument/backgroundText/listByInstrument | Background texts of an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCompliancePropertyListByInstrument | GET /instrument/complianceProperty/listByInstrument | Compliance properties of an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCompositeGet | GET /instrument/composite/get | Composite instrument and its components. quotesapifordigitalportals.InstrumentApi | getInstrumentCouponDayCountConventionTypeList | GET /instrument/coupon/dayCountConvention/type/list | List of day count convention types. quotesapifordigitalportals.InstrumentApi | getInstrumentCouponInterestRateTypeList | GET /instrument/coupon/interestRate/type/list | List of interest rate types. quotesapifordigitalportals.InstrumentApi | getInstrumentCouponKeyDataGet | GET /instrument/coupon/keyData/get | Interest rate details for selected periods of an interest-bearing instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCouponList | GET /instrument/coupon/list | List of coupons for an interest-bearing instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCrossReferenceGetByISIN | GET /instrument/crossReference/getByISIN | Translate ISIN to instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCrossReferenceGetByWKN | GET /instrument/crossReference/getByWKN | Translate WKN to instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentCrossReferenceHistoryGetByISIN | GET /instrument/crossReference/history/getByISIN | ISIN to instrument translation history. quotesapifordigitalportals.InstrumentApi | getInstrumentCrossReferenceHistoryGetByWKN | GET /instrument/crossReference/history/getByWKN | WKN to instrument translation history. quotesapifordigitalportals.InstrumentApi | getInstrumentExchangeRateGet | GET /instrument/exchangeRate/get | Retrieve an exchange rate instrument identifier. quotesapifordigitalportals.InstrumentApi | getInstrumentExchangeRateGetByISOCode | GET /instrument/exchangeRate/getByISOCode | Retrieve an exchange rate instrument identifier. quotesapifordigitalportals.InstrumentApi | getInstrumentGet | GET /instrument/get | Basic data for an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentGetByNotation | GET /instrument/getByNotation | Basic data for an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentLegalEntityBackgroundTextListByInstrument | GET /instrument/legalEntity/backgroundText/listByInstrument | Role-specific background texts of legal entities related to an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentLegalEntityCompliancePropertyListByInstrument | GET /instrument/legalEntity/complianceProperty/listByInstrument | Role-specific compliance properties of legal entities related to an instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentMifidGet | GET /instrument/mifid/get | MiFID II data for a financial instrument. quotesapifordigitalportals.InstrumentApi | getInstrumentSearchBasic | GET /instrument/search/basic | Basic search for instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentBackgroundTextTypeList | POST /instrument/backgroundText/type/list | List of background text types for instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentBenchmarkList | POST /instrument/benchmark/list | List of benchmarks of a financial instrument. quotesapifordigitalportals.InstrumentApi | postInstrumentCategoryList | POST /instrument/category/list | List of categories assigned to a specific instrument the application is entitled to see. quotesapifordigitalportals.InstrumentApi | postInstrumentCompliancePropertyList | POST /instrument/complianceProperty/list | List of compliance properties for instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentCrossReferenceListByISIN | POST /instrument/crossReference/listByISIN | Translate a list of ISINs to instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentCrossReferenceListByWKN | POST /instrument/crossReference/listByWKN | Translate a list of WKNs to instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentNotationList | POST /instrument/notation/list | List of active, entitled notations for a set of instruments. quotesapifordigitalportals.InstrumentApi | postInstrumentRatingGradeList | POST /instrument/rating/grade/list | List of rating grades for a list of instruments. quotesapifordigitalportals.NotationApi | getNotationCrossReferenceFactSetIdentifierGet | GET /notation/crossReference/factSetIdentifier/get | Retrieve FactSet identifiers for a given notation. quotesapifordigitalportals.NotationApi | getNotationCrossReferenceGetByFactSetMarketSymbol | GET /notation/crossReference/getByFactSetMarketSymbol | Translate a FactSet market symbol to a notation. quotesapifordigitalportals.NotationApi | getNotationGet | GET /notation/get | Basic data for a notation. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth1Get | GET /notation/keyFigures/month/1/get | End-of-day (EOD) key figures for the time range of one month. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth1List | GET /notation/keyFigures/month/1/list | End-of-day (EOD) key figures for the time range of one month, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth3Get | GET /notation/keyFigures/month/3/get | End-of-day (EOD) key figures for the time range of three months. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth3List | GET /notation/keyFigures/month/3/list | End-of-day (EOD) key figures for the time range of three months, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth6Get | GET /notation/keyFigures/month/6/get | End-of-day (EOD) key figures for the time range of six months. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresMonth6List | GET /notation/keyFigures/month/6/list | End-of-day (EOD) key figures for the time range of six months, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresTradingDayAverageGet | GET /notation/keyFigures/tradingDay/average/get | Average end-of-day (EOD) key figures for different trading days periods. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresWeek1Get | GET /notation/keyFigures/week/1/get | End-of-day (EOD) key figures for the time range of one week. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresWeek1List | GET /notation/keyFigures/week/1/list | End-of-day (EOD) key figures for the time range of one week, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear10Get | GET /notation/keyFigures/year/10/get | End-of-day (EOD) key figures for the time range of ten years. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear10List | GET /notation/keyFigures/year/10/list | End-of-day (EOD) key figures for the time range of ten years, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear1Get | GET /notation/keyFigures/year/1/get | End-of-day (EOD) key figures for the time range of one year. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear1List | GET /notation/keyFigures/year/1/list | End-of-day (EOD) key figures for the time range of one year, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear3Get | GET /notation/keyFigures/year/3/get | End-of-day (EOD) key figures for the time range of three years. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear3List | GET /notation/keyFigures/year/3/list | End-of-day (EOD) key figures for the time range of three years, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear5Get | GET /notation/keyFigures/year/5/get | End-of-day (EOD) key figures for the time range of five years. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear5List | GET /notation/keyFigures/year/5/list | End-of-day (EOD) key figures for the time range of five years, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear7Get | GET /notation/keyFigures/year/7/get | End-of-day (EOD) key figures for the time range of seven years. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYear7List | GET /notation/keyFigures/year/7/list | End-of-day (EOD) key figures for the time range of seven years, for a list of notations. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYearToDateGet | GET /notation/keyFigures/yearToDate/get | End-of-day (EOD) key figures for the time range year-to-date (YTD).. quotesapifordigitalportals.NotationApi | getNotationKeyFiguresYearToDateList | GET /notation/keyFigures/yearToDate/list | End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations.. quotesapifordigitalportals.NotationApi | getNotationList | GET /notation/list | Basic data for a list of notations. quotesapifordigitalportals.NotationApi | getNotationSearchBasic | GET /notation/search/basic | Basic search for notations. quotesapifordigitalportals.NotationApi | getNotationSearchByTextRankedByVolume | GET /notation/searchByTextRankedByVolume | Basic search for notations. quotesapifordigitalportals.NotationApi | getNotationStatusGet | GET /notation/status/get | Intraday trading status of a notation. quotesapifordigitalportals.NotationApi | postNotationCategoryList | POST /notation/category/list | List of categories assigned to a specific notation the application is entitled to see. quotesapifordigitalportals.NotationApi | postNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier | POST /notation/crossReference/factSetIdentifier/listByFactSetIdentifier | Retrieve a list of notations for a given FactSet identifier. quotesapifordigitalportals.NotationApi | postNotationCrossReferenceFactSetIdentifierListByInstrument | POST /notation/crossReference/factSetIdentifier/listByInstrument | Retrieve a list of FactSet identifiers for a given instrument. quotesapifordigitalportals.NotationApi | postNotationCrossReferenceListByISIN | POST /notation/crossReference/listByISIN | List of entitled notations. quotesapifordigitalportals.NotationApi | postNotationCrossReferenceListByInstrument | POST /notation/crossReference/listByInstrument | List of entitled notations. quotesapifordigitalportals.NotationApi | postNotationCrossReferenceListBySymbol | POST /notation/crossReference/listBySymbol | List of entitled notations. quotesapifordigitalportals.NotationApi | postNotationMarketList | POST /notation/market/list | List of markets with entitled notations. quotesapifordigitalportals.NotationApi | postNotationSearchByText | POST /notation/searchByText | Text-based search for notations. quotesapifordigitalportals.PricesApi | getPricesBidAskGet | GET /prices/bidAsk/get | Most recent bid and ask prices (best bid / offer) for a notation. quotesapifordigitalportals.PricesApi | getPricesBidAskList | GET /prices/bidAsk/list | Most recent bid and ask prices (best bid / offer) for a list of notations. quotesapifordigitalportals.PricesApi | getPricesGet | GET /prices/get | Overview of trading on the most recent trading day, including the latest price, for a notation. quotesapifordigitalportals.PricesApi | getPricesList | GET /prices/list | Overview of trading on the most recent trading day, including the latest price, for a list of notations. quotesapifordigitalportals.PricesApi | getPricesOrderbookAggregatedGet | GET /prices/orderbook/aggregated/get | Orderbook aggregated by price. quotesapifordigitalportals.PricesApi | getPricesOrderbookFullGet | GET /prices/orderbook/full/get | Full orderbook quotesapifordigitalportals.PricesApi | getPricesTradingScheduleEventTypeList | GET /prices/tradingSchedule/event/type/list | Trading schedule event types. quotesapifordigitalportals.PricesApi | postPricesTradingScheduleEventList | POST /prices/tradingSchedule/event/list | Sequence of market-related events.

Documentation for Models