❤
npm
Sign UpSign In

@factset/sdk-realtimequotes

0.12.1 • Public • Published

FactSet

Real-Time Quotes 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: 3.0.0
  • Package version: 0.12.1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-realtimequotes@0.12.1

yarn

yarn add @factset/sdk-utils @factset/sdk-realtimequotes@0.12.1

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-realtimequotes');
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 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/v3

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

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.

Readme

Keywords

Package Sidebar

Install

npm i @factset/sdk-realtimequotes

Repository

github.com/factset/enterprise-sdk

Homepage

developer.factset.com/

Weekly Downloads

0

Version

0.12.1

License

Apache-2.0

Unpacked Size

3.22 MB

Total Files

592

Last publish

Collaborators

  • enterprisesdk
  • fds
  • tsouthmaydfds
Try on RunKit
Report malware