❤
npm
Sign UpSign In

@factset/sdk-overviewreportbuilder

2.1.1 • Public • Published

FactSet

Overview Report Builder client library for JavaScript

API Version npm Apache-2 license

Get relevant industry-specific data for high level analysis of public and private companies

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

  • API version: 1.1.0
  • SDK version: 2.1.1
  • 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/sdk-overviewreportbuilder@2.1.1

yarn

yarn add @factset/sdk-utils @factset/sdk-overviewreportbuilder@2.1.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, CompanyApi } = require('@factset/sdk-overviewreportbuilder');
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 CompanyApi();
const id = FDS; // String | Company ticker

// Call api endpoint
apiInstance.getCurrentCap(id).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-overviewreportbuilder');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');

Documentation for API Endpoints

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

Class Method HTTP request Description
overviewreportbuilder.CompanyApi getCurrentCap GET /current-cap Current Capitalization
overviewreportbuilder.CompanyApi getFinancialHighlights GET /financial-highlights Financial / Estimate Highlights
overviewreportbuilder.CompanyApi getKeyStats GET /key-stats Key Stats
overviewreportbuilder.CompanyApi getPeerlist GET /peer-list Peer List
overviewreportbuilder.CompanyApi getProfileProfile GET /profile Overview Profile
overviewreportbuilder.CompanyApi getTrasactions GET /transactions Transactions

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.

Readme

Keywords

Package Sidebar

Install

npm i @factset/sdk-overviewreportbuilder

Repository

github.com/factset/enterprise-sdk

Homepage

developer.factset.com/

Weekly Downloads

6

Version

2.1.1

License

Apache-2.0

Unpacked Size

507 kB

Total Files

118

Last publish

Collaborators

  • fds
  • tsouthmaydfds
  • enterprisesdk
  • fbecker-fds
Try on RunKit
Report malware