@factset/sdk-factsetestimatesreportbuilder v1.0.3
FactSet Estimates Report Builder client library for JavaScript
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- 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-factsetestimatesreportbuilder@1.0.3
yarn
yarn add @factset/sdk-utils @factset/sdk-factsetestimatesreportbuilder@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, AllEstimatesApi } = require('@factset/sdk-factsetestimatesreportbuilder');
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 AllEstimatesApi();
const id = FDS; // String | Company Ticker
const opts = {
'periodicity': "'ANN'", // String | Periodicity or frequency of the fiscal periods.
'schema': "'table_parent_child_columns'" // String | The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns
};
// Call api endpoint
apiInstance.getEstimatesBalanceSheet(id, 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/report/estimates/v1
Class | Method | HTTP request | Description |
---|---|---|---|
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesBalanceSheet | GET /balance-sheet | Balance Sheet |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesCashFlow | GET /cash-flow | Cash Flow |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesGeographicSegments | GET /geographic-segments | Geographic Segments |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesIncomeStatement | GET /income-statement | Income Statement |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesIndustryMetrics | GET /industry-metrics | Industry Metrics |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesPerShare | GET /per-share | Per Share |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesProductSegments | GET /product-segments | Product Segments |
factsetestimatesreportbuilder.AllEstimatesApi | getEstimatesValuation | GET /valuation | Valuation |
factsetestimatesreportbuilder.EstimateTablesApi | getEstimateTablesTable | GET /table | Interim/Annual Estimate Table |
Documentation for Models
- factsetestimatesreportbuilder.Category
- factsetestimatesreportbuilder.CategoryCategory
- factsetestimatesreportbuilder.CurrencyCode
- factsetestimatesreportbuilder.CurrencyCodeCurrencyCode
- factsetestimatesreportbuilder.CurrencySymbol
- factsetestimatesreportbuilder.CurrencySymbolCurrencySymbol
- factsetestimatesreportbuilder.Description
- factsetestimatesreportbuilder.DescriptionDescription
- factsetestimatesreportbuilder.ErrorObject
- factsetestimatesreportbuilder.ErrorObjectLinks
- factsetestimatesreportbuilder.ErrorObjectSource
- factsetestimatesreportbuilder.ErrorResponse
- factsetestimatesreportbuilder.Frequency
- factsetestimatesreportbuilder.FrequencyFrequency
- factsetestimatesreportbuilder.MetadataEntry
- factsetestimatesreportbuilder.MetricEstimates
- factsetestimatesreportbuilder.MetricEstimatesMetricEstimates
- factsetestimatesreportbuilder.Response
- factsetestimatesreportbuilder.Scale
- factsetestimatesreportbuilder.ScaleScale
- factsetestimatesreportbuilder.ValueType
- factsetestimatesreportbuilder.ValueTypeValueType
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.