Cabot client library for JavaScript

Cabot Models API

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

• API version: 0.2.0
• SDK version: 0.12.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, 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);
  },
);

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-cabot');

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

Documentation for API Endpoints

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

Documentation for Models

• cabot.AddTrimModelAnalytics
• cabot.AddTrimResponseOptions
• cabot.AddTrimResponseRoot
• cabot.Attributes
• cabot.BuyContextModelAnalytics
• cabot.BuyContextModelAnalyticsContext
• cabot.BuyContextModelAnalyticsContextAttribute
• cabot.BuyContextModelAnalyticsItem
• cabot.BuyContextModelAnalyticsItemRange
• cabot.BuyContextResponseOptions
• cabot.BuyContextResponseRoot
• cabot.BuyTimingModelAnalytics
• cabot.BuyTimingResponseOptions
• cabot.BuyTimingResponseRoot
• cabot.ClientErrorResponse
• cabot.ConstructionModelAnalytics
• cabot.ConstructionModelAnalyticsActiveWeights
• cabot.ConstructionModelAnalyticsActiveWeightsMaxOver
• cabot.ConstructionModelAnalyticsPositionCount
• cabot.ConstructionResponseOptions
• cabot.ConstructionResponseRoot
• cabot.Error
• cabot.ErrorSource
• cabot.HitRateModelAnalytics
• cabot.HitRateModelAnalyticsLosers
• cabot.HitRateModelAnalyticsWinners
• cabot.HitRateResponseOptions
• cabot.HitRateResponseRoot
• cabot.RampDownModelAnalytics
• cabot.RampDownResponseOptions
• cabot.RampDownResponseRoot
• cabot.RampUpModelAnalytics
• cabot.RampUpResponseOptions
• cabot.RampUpResponseRoot
• cabot.Regions
• cabot.ResultsModelAnalytics
• cabot.ResultsModelAnalyticsCaptures
• cabot.ResultsModelAnalyticsRatios
• cabot.ResultsModelAnalyticsReturns
• cabot.ResultsModelAnalyticsRisk
• cabot.ResultsModelAnalyticsStatistics
• cabot.ResultsResponseOptions
• cabot.ResultsResponseRoot
• cabot.Sectors
• cabot.SellTimingModelAnalytics
• cabot.SellTimingResponseOptions
• cabot.SellTimingResponseRoot
• cabot.SkillsModelAnalytics
• cabot.SkillsResponseOptions
• cabot.SkillsResponseRoot
• cabot.StopLossModelAnalytics
• cabot.StopLossResponseOptions
• cabot.StopLossResponseRoot

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.