@factset/sdk-timeseriesapifordigitalportals v0.9.4
Time Series API for Digital Portals client library for JavaScript
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: v1
- Package version: 0.9.4
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-timeseriesapifordigitalportals
yarn
yarn add @factset/sdk-utils @factset/sdk-timeseriesapifordigitalportals
Usage
- Generate authentication credentials.
Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Run the following:
const { ApiClient, PricesApi } = require('@factset/sdk-timeseriesapifordigitalportals');
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 PricesApi();
const id = "id_example"; // String | Identifier of the notation.
const from = "from_example"; // String | Date and time of the start point of the subsample (inclusive). `from` must be aligned to `granularity`. That is, the numerical value is an integral multiple of the time span value represented by `granularity`. The data accessible in the past is limited to a few weeks at most. Dates in the future are not allowed.
const opts = {
'type': "'trade'", // String | Type of the price as configured for the customer.
'quality': "'DLY'", // String | Quality of the price.
'granularity': "'1h'", // String | Subsample granularities suitable for intraday data.
'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};
// Call api endpoint
apiInstance.getPricesTimeSeriesIntradaySubsampleGet(id, from, 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 http://api.factset.com/wealth/v1
Class | Method | HTTP request | Description |
---|---|---|---|
timeseriesapifordigitalportals.PricesApi | getPricesTimeSeriesIntradaySubsampleGet | GET /prices/timeSeries/intraday/subsample/get | Single subsample intraday data for a notation. |
timeseriesapifordigitalportals.PricesApi | postPricesTimeSeriesEodList | POST /prices/timeSeries/eod/list | End-of-day time series data for a notation. |
timeseriesapifordigitalportals.PricesApi | postPricesTimeSeriesEodSubsampleGet | POST /prices/timeSeries/eod/subsample/get | Single subsample end-of-day data for a notation. |
timeseriesapifordigitalportals.PricesApi | postPricesTimeSeriesEodSubsampleList | POST /prices/timeSeries/eod/subsample/list | Subsampled end-of-day time series data for a notation. |
timeseriesapifordigitalportals.PricesApi | postPricesTimeSeriesIntradayList | POST /prices/timeSeries/intraday/list | Intraday time series data for a notation. |
timeseriesapifordigitalportals.PricesApi | postPricesTimeSeriesIntradaySubsampleList | POST /prices/timeSeries/intraday/subsample/list | Subsampled intraday time series data for a notation. |
timeseriesapifordigitalportals.VendorApi | getVendorChartIQTimeSeriesIntradaySubsampleGet | GET /vendor/chartIQ/timeSeries/intraday/subsample/get | Single subsample intraday data for a notation. |
timeseriesapifordigitalportals.VendorApi | postVendorChartIQTimeSeriesEodList | POST /vendor/chartIQ/timeSeries/eod/list | End-of-day time series data for a notation. |
timeseriesapifordigitalportals.VendorApi | postVendorChartIQTimeSeriesEodSubsampleGet | POST /vendor/chartIQ/timeSeries/eod/subsample/get | Single subsample end-of-day data for a notation. |
timeseriesapifordigitalportals.VendorApi | postVendorChartIQTimeSeriesEodSubsampleList | POST /vendor/chartIQ/timeSeries/eod/subsample/list | Subsampled end-of-day time series data for a notation. |
timeseriesapifordigitalportals.VendorApi | postVendorChartIQTimeSeriesIntradaySubsampleList | POST /vendor/chartIQ/timeSeries/intraday/subsample/list | Subsampled intraday time series data for a notation. |
Documentation for Models
- timeseriesapifordigitalportals.CursorBasedPaginationOutputObject
- timeseriesapifordigitalportals.CursorBasedPaginationOutputObjectWithoutTotal
- timeseriesapifordigitalportals.ErrorMetaObject
- timeseriesapifordigitalportals.InlineObject
- timeseriesapifordigitalportals.InlineObject1
- timeseriesapifordigitalportals.InlineObject2
- timeseriesapifordigitalportals.InlineObject3
- timeseriesapifordigitalportals.InlineObject4
- timeseriesapifordigitalportals.InlineObject5
- timeseriesapifordigitalportals.InlineObject6
- timeseriesapifordigitalportals.InlineObject7
- timeseriesapifordigitalportals.InlineObject8
- timeseriesapifordigitalportals.InlineResponse200
- timeseriesapifordigitalportals.InlineResponse2001
- timeseriesapifordigitalportals.InlineResponse20010
- timeseriesapifordigitalportals.InlineResponse20010Data
- timeseriesapifordigitalportals.InlineResponse20010DataSubsamples
- timeseriesapifordigitalportals.InlineResponse2001Data
- timeseriesapifordigitalportals.InlineResponse2001Meta
- timeseriesapifordigitalportals.InlineResponse2002
- timeseriesapifordigitalportals.InlineResponse2002Data
- timeseriesapifordigitalportals.InlineResponse2003
- timeseriesapifordigitalportals.InlineResponse2003Data
- timeseriesapifordigitalportals.InlineResponse2004
- timeseriesapifordigitalportals.InlineResponse2004Data
- timeseriesapifordigitalportals.InlineResponse2004DataRange
- timeseriesapifordigitalportals.InlineResponse2005
- timeseriesapifordigitalportals.InlineResponse2005Data
- timeseriesapifordigitalportals.InlineResponse2005DataPrices
- timeseriesapifordigitalportals.InlineResponse2006
- timeseriesapifordigitalportals.InlineResponse2006Data
- timeseriesapifordigitalportals.InlineResponse2006DataSubsample
- timeseriesapifordigitalportals.InlineResponse2007
- timeseriesapifordigitalportals.InlineResponse2007Data
- timeseriesapifordigitalportals.InlineResponse2007DataSubsamples
- timeseriesapifordigitalportals.InlineResponse2008
- timeseriesapifordigitalportals.InlineResponse2008Data
- timeseriesapifordigitalportals.InlineResponse2008DataPrices
- timeseriesapifordigitalportals.InlineResponse2009
- timeseriesapifordigitalportals.InlineResponse2009Data
- timeseriesapifordigitalportals.InlineResponse2009DataSubsample
- timeseriesapifordigitalportals.InlineResponse200Data
- timeseriesapifordigitalportals.InlineResponse200DataRange
- timeseriesapifordigitalportals.InlineResponse200Meta
- timeseriesapifordigitalportals.OffsetBasedPaginationOutputObject
- timeseriesapifordigitalportals.OffsetBasedPaginationOutputObjectWithoutTotal
- timeseriesapifordigitalportals.PartialOutputObject
- timeseriesapifordigitalportals.PricesTimeSeriesEodSubsampleGetData
- timeseriesapifordigitalportals.PricesTimeSeriesEodSubsampleGetDataInterval
- timeseriesapifordigitalportals.PricesTimeSeriesEodSubsampleListData
- timeseriesapifordigitalportals.PricesTimeSeriesIntradayListData
- timeseriesapifordigitalportals.PricesTimeSeriesIntradayListDataRange
- timeseriesapifordigitalportals.PricesTimeSeriesIntradayListMeta
- timeseriesapifordigitalportals.PricesTimeSeriesIntradayListMetaPagination
- timeseriesapifordigitalportals.StatusObject
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodListData
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodListDataAdjustments
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodListDataRange
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodListMeta
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodListMetaPagination
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodSubsampleGetData
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodSubsampleGetDataInterval
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodSubsampleGetMeta
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesEodSubsampleListData
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesIntradaySubsampleListData
- timeseriesapifordigitalportals.VendorChartIQTimeSeriesIntradaySubsampleListDataRange
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.