Skip to content

Latest commit

 

History

History
176 lines (118 loc) · 8.16 KB

EntityFocusApi.md

File metadata and controls

176 lines (118 loc) · 8.16 KB
Raw

factsetrbics.EntityFocusApi

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

Method HTTP request Description
getRbicsEntityFocus GET /factset-rbics/v1/entity-focus Get RBICS classification for the Focus industry
getRbicsEntityFocusForList POST /factset-rbics/v1/entity-focus Get RBICS classification for the Focus industry

getRbicsEntityFocus

EntityFocusResponse getRbicsEntityFocus(ids, opts)

Get RBICS classification for the Focus industry

Gets RBICS classifications for the Focus industry for a short list of companies. Full history is included if date parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.

Example

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);
  },
);

Parameters

Name Type Description Notes
ids [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 &quot;POST&quot; method.</p>
date 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. [optional]
levels [Number] List of RBICS industry levels to include in the response. By default if left blank, all levels are returned. [optional]
includeNames Boolean Option to include or exclude industry Names and the L6 Description. true = Include Names; false = Exclude Names. [optional] [default to true]

Return type

EntityFocusResponse

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getRbicsEntityFocusForList

EntityFocusResponse getRbicsEntityFocusForList(entityFocusRequest)

Get RBICS classification for the Focus industry

Gets RBICS classifications for the Focus industry for a long list of companies. Full history is included if date parameter is not specified. RBICS Focus offers a single-sector mapping of about 48,000 of the most liquid and publicly-traded companies based on their primary lines of business; it uses revenues as the key factor in determining a company’s primary line of business, by mapping a company to the lowest-level sector from which it derives 50% or more of its revenues. The RBICS Extended Universe – Industry Group is not currently supported through the RBICS API.

Example

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 entityFocusRequest = new factsetrbics.EntityFocusRequest(); // EntityFocusRequest | Request Body to request a list of RBICS Entity Focus objects.

// Call api endpoint
apiInstance.getRbicsEntityFocusForList(entityFocusRequest).then(
  data => {

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

Parameters

Name Type Description Notes
entityFocusRequest EntityFocusRequest Request Body to request a list of RBICS Entity Focus objects.

Return type

EntityFocusResponse

Authorization

FactSetApiKey, FactSetOAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json