@factset/sdk-cabot
Advanced tools
Cabot Models API
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
For more information, please visit https://developer.factset.com/contact
npm install @factset/sdk-utils @factset/sdk-cabot@0.12.0
yarn add @factset/sdk-utils @factset/sdk-cabot@0.12.0
Install and activate Node.js >=18. If you're using nvm:
nvm install 18
nvm use 18
(optional) Install yarn.
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
const { ApiClient, BuyingModelsApi } = require('@factset/sdk-cabot');
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 BuyingModelsApi();
const accountPath = "accountPath_example"; // String | The account path of the portfolio you want to retrieve the data for.
const benchmarkPath = BENCH:SP50; // String | The path of the benchmark you want to retrieve the data for.<br /><br />
const period = "period_example"; // String | For which period you want to retrieve the data.<br />There are four options available as follows:<br /><br />1 -> YYYY (Repeating One Year)<br /><br />2 -> YYYY-YYYY (Repeating Three/Five/Ten Year)<br /><br />3 -> 1M_TRAILING, 3M_TRAILING, 1Y_TRAILING, 3Y_TRAILING, 5Y_TRAILING (Trailing Periods (If available for your portfolio))<br /><br />4 -> INCEPTION_TO_DATE<br /><br />You can only get the data for one period per request.<br /><br />
const attribute = QFL_EY; // Attributes | The attribute represents the different factors.<br />You can choose which of them (if any) you want to see analytics for.<br /><br />If provided, the API response will contain both \"LOW\" and \"HIGH\" values for it.<br /><br />
const opts = {
'sector': energy, // Sectors | Sector represents the sector based on the company's industry breakdown.<br />You can choose which of them (if any) you want to see analytics for.<br /><br />
'region': northAmerica // Regions | Region of domicile represents the region based on the company's primary listing.<br />You can choose which of them (if any) you want to see analytics for.<br /><br />
};
// Call api endpoint
apiInstance.getBuyContextModelAnalytic(accountPath, benchmarkPath, period, attribute, opts).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
const { ApiClient } = require('@factset/sdk-cabot');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');
All URIs are relative to https://api.factset.com/analytics/cabot/v0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| cabot.BuyingModelsApi | getBuyContextModelAnalytic | GET /models/buy-context | Cabot main path for Buy Context API |
| cabot.BuyingModelsApi | getBuyTimingModelAnalytic | GET /models/buy-timing | Cabot main path for Buy Timing API |
| cabot.OverviewModelsApi | getConstructionModelAnalytic | GET /models/construction | Cabot main path for Construction API |
| cabot.OverviewModelsApi | getHitRateModelAnalytic | GET /models/hit-rate | Cabot main path for Hit Rate API |
| cabot.OverviewModelsApi | getResultsModelAnalytic | GET /models/results | Cabot main path for Results API |
| cabot.OverviewModelsApi | getSkillsModelAnalytic | GET /models/skills | Cabot main path for Skills API |
| cabot.SellingModelsApi | getSellTimingModelAnalytic | GET /models/sell-timing | Cabot main path for Sell Timing API |
| cabot.SellingModelsApi | getStopLossModelAnalytic | GET /models/stop-loss | Cabot main path for Stop Loss API |
| cabot.SizingModelsApi | getAddTrimModelAnalytic | GET /models/add-trim | Cabot main path for Add Trim API |
| cabot.SizingModelsApi | getRampDownModelAnalytic | GET /models/ramp-down | Cabot main path for Ramp Down API |
| cabot.SizingModelsApi | getRampUpModelAnalytic | GET /models/ramp-up | Cabot main path for Ramp Up API |
Please refer to the contributing guide.
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.
FAQs
Cabot client library for JavaScript
We found that @factset/sdk-cabot demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.