FactSet Ownership Report Builder client library for JavaScript

description.md

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

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

For more information, please visit https://developer.factset.com/contact

Requirements

• Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

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, OwnershipApi } = require('@factset/sdk-factsetownershipreportbuilder');
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 OwnershipApi();
const id = FDS-US; // String | Company or Fund Identifier
const opts = {
  'assetType': "'EQUITY'", // String | Controls the Asset Type of the data returned
  'holderType': "'INSTITUTIONS'", // String | Controls the Holder Type of the data returned
  'entityType': "'SECURITY'", // String | Controls the type of Entity data returned. Defaults to Security data, but can also be used to display Company data.
  'topn': ALL, // String | Limits the number of holders returned based on their Market Value position in the security. Default is ALL, otherwise use a valid number above 0. 
  'date': Tue Dec 31 00:00:00 UTC 2019 // Date | Top Holders as of date expressed in YYYY-MM-DD format. Defaults to latest month-end close; non-month-end dates are converted to month-end dates.
};

// Call api endpoint
apiInstance.getOwnershipHolders(id, 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-factsetownershipreportbuilder');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/report/ownership/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetownershipreportbuilder.OwnershipApi | getOwnershipHolders | GET /holders | Holders of a company or fund factsetownershipreportbuilder.OwnershipApi | getOwnershipUltimateParent | GET /ultimate-parent | Get FactSet's ownership breakdown about a specific security. The returned table will display the institutions, insiders, funds, and beneficial owners that comprise the ownership of the provided security. These holders will be grouped by the ultimate parent in their entity structure.

Documentation for Models

• factsetownershipreportbuilder.ErrorObject
• factsetownershipreportbuilder.ErrorObjectLinks
• factsetownershipreportbuilder.ErrorObjectSource
• factsetownershipreportbuilder.ErrorResponse
• factsetownershipreportbuilder.ErrorWithMetaResponse
• factsetownershipreportbuilder.Meta
• factsetownershipreportbuilder.ResponseHolders
• factsetownershipreportbuilder.ResponseUltimateParent

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.