@factset/sdk-exchangedatafeeddatamodel v0.20.3
Exchange DataFeed Data Model client library for JavaScript
FactSet’s Exchange DataFeed products provide access to consolidated real-time and delayed global exchange data. Proprietary technology normalizes over 250 global venues, 18+ million instruments, and 150+ data fields. Asset types integrated include equities, futures, options, warrants, fixed income, mutual funds, ETFs, indices, commodities, and FX rates. Innovative technology ensures reliability and provides scalability that allows clients to make requests based on a symbol list or an exchange. Reduce development time by powering proprietary and third-party applications with exchange data from a unified data model. The Exchange DataFeed Data Model API provides mappings for enumerations used in our Real-Time DataFeed products and should be used in conjunction with the DataFeed Data Model documentation available for each product. The initial beta version of this API is limited to include mapping tables for the product codes only.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.20.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-exchangedatafeeddatamodel@0.20.3
yarn
yarn add @factset/sdk-utils @factset/sdk-exchangedatafeeddatamodel@0.20.3
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, FactSetProductCodesApi } = require('@factset/sdk-exchangedatafeeddatamodel');
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 FactSetProductCodesApi();
const opts = {
'format': "'json'" // String | The format of the output file.<p>**Try it Out** - All formats available</p>
};
// Call api endpoint
apiInstance.getProducts(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/RTDataModel
Class | Method | HTTP request | Description |
---|---|---|---|
exchangedatafeeddatamodel.FactSetProductCodesApi | getProducts | GET /products | Request the enumeration table for FactSet product codes. |
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.