@factset/sdk-classifications v1.0.3
Classifications client library for JavaScript
The Classifications API gives access to various Industry Classifications for a given list of securities. Beginning first with GICS Direct, the service will then expand to offering NAICS, SIC, RBICS, and more.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.1
- Package version: 1.0.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-classifications@1.0.3
yarn
yarn add @factset/sdk-utils @factset/sdk-classifications@1.0.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, GICSApi } = require('@factset/sdk-classifications');
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 GICSApi();
const ids = ["null"]; // [String] | The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>*
const opts = {
'startDate': "startDate_example", // String | Requested start date expressed in YYYY-MM-DD format.
'endDate': "endDate_example", // String | Requested End Date for Range expressed in YYYY-MM-DD format.
'frequency': "'M'", // String | Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year.
'calendar': "'FIVEDAY'" // String | Calendar of data returned. SEVENDAY includes weekends.
};
// Call api endpoint
apiInstance.getGics(ids, 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/content
Class | Method | HTTP request | Description |
---|---|---|---|
classifications.GICSApi | getGics | GET /classifications/v1/gics | Gets the GICS Direct Classifications |
classifications.GICSApi | postGics | POST /classifications/v1/gics | Returns the GICS classifications for the requested 'ids' and date range. |
Documentation for Models
- classifications.Calendar
- classifications.ErrorResponse
- classifications.ErrorResponseSubErrors
- classifications.Frequency
- classifications.Gics
- classifications.GicsRequest
- classifications.GicsResponse
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.