@factset/sdk-factsetrbics

FactSet RBICS client library for JavaScript

FactSet Revere Business Industry Classification System (RBICS) is a comprehensive structured taxonomy to classify companies by what they primarily do. It delivers a granular view for investors by classifying companies using a bottom-up approach according to the products and services they provide. By combining this approach with a top-level grouping based on companies' behavior similarities and stock co-movement, FactSet RBICS delivers unprecedented precision for 1,400+ sector groups.

RBICS Focus is a six level classification which highlights the companys main business. It is based on the company business line/s that stand for majority of a the revenue that the company generates. Updated monthly. For more details, visit Online Assitant Page #20710.

Rate limit is set to 40 requests per second.

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

• API version: 1.1.0
• SDK version: 2.0.1
• Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetrbics@2.0.1

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetrbics@2.0.1

Usage

1. Generate authentication credentials.
2. Setup Node.js environment

   1. Install and activate Node.js >=18. If you're using nvm:

      nvm install 18
      nvm use 18

   2. (optional) Install yarn.

3. Install dependencies.
4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, EntityFocusApi } = require('@factset/sdk-factsetrbics');
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 EntityFocusApi();
const ids = ["AAPL-US","0FPWZZ-E","TSLA-US"]; // [String] | List of Company identifiers. Accepted identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet Permanent Ids, such as -R, -L, or -E.<p>**ids limit = 2500 per request**</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 = {
  'date': 2017-07-24, // String | Effective date for data expressed in YYYY-MM-DD format. If no date is requested, the default behavior is to return the full history for the requested entity.
  'levels': [1,3,6], // [Number] | List of RBICS industry levels to include in the response. **By default if left blank, all levels are returned.**
  'includeNames': true // Boolean | Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names.
};

// Call api endpoint
apiInstance.getRbicsEntityFocus(ids, opts).then(
  data => {

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

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-factsetrbics');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[e-mail]:8080');

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
factsetrbics.EntityFocusApi	getRbicsEntityFocus	GET /factset-rbics/v1/entity-focus	Get RBICS classification for the Focus industry
factsetrbics.EntityFocusApi	getRbicsEntityFocusForList	POST /factset-rbics/v1/entity-focus	Get RBICS classification for the Focus industry
factsetrbics.StructureApi	getRbicsStructure	GET /factset-rbics/v1/structure	Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.
factsetrbics.StructureApi	getRbicsStructureForList	POST /factset-rbics/v1/structure	Get the full RBICS Taxonomy Structure Ids, Names, and effective periods.

Documentation for Models

• factsetrbics.EntityFocus
• factsetrbics.EntityFocusRequest
• factsetrbics.EntityFocusResponse
• factsetrbics.ErrorResponse
• factsetrbics.ErrorResponseSubErrors
• factsetrbics.Structure
• factsetrbics.StructureRequest
• factsetrbics.StructureResponse

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.