❤
npm
Sign UpSign In

@factset/sdk-cabot

0.13.0 • Public • Published

FactSet

Cabot client library for JavaScript

API Version npm Apache-2 license

Cabot Models API

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

  • API version: 0.4.0
  • SDK version: 0.13.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/sdk-cabot@0.13.0

yarn

yarn add @factset/sdk-utils @factset/sdk-cabot@0.13.0

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 buyContextRequestBodyRoot = new cabot.BuyContextRequestBodyRoot(); // BuyContextRequestBodyRoot | 

// Call api endpoint
apiInstance.getBuyContextModelAnalytic(buyContextRequestBodyRoot).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:password@proxy.example.com: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 POST /models/buy-context Cabot main path for Buy Context API
cabot.BuyingModelsApi getBuyTimingModelAnalytic POST /models/buy-timing Cabot main path for Buy Timing API
cabot.ClassificationsApi getPortfolioClassifications GET /classifications Cabot main path for Classifications API
cabot.OverviewModelsApi getConstructionModelAnalytic POST /models/construction Cabot main path for Construction API
cabot.OverviewModelsApi getHitRateModelAnalytic POST /models/hit-rate Cabot main path for Hit Rate API
cabot.OverviewModelsApi getResultsModelAnalytic POST /models/results Cabot main path for Results API
cabot.OverviewModelsApi getSkillsModelAnalytic POST /models/skills Cabot main path for Skills API
cabot.SellingModelsApi getSellTimingModelAnalytic POST /models/sell-timing Cabot main path for Sell Timing API
cabot.SellingModelsApi getStopLossModelAnalytic POST /models/stop-loss Cabot main path for Stop Loss API
cabot.SizingModelsApi getAddTrimModelAnalytic POST /models/add-trim Cabot main path for Add Trim API
cabot.SizingModelsApi getRampDownModelAnalytic POST /models/ramp-down Cabot main path for Ramp Down API
cabot.SizingModelsApi getRampUpModelAnalytic POST /models/ramp-up Cabot main path for Ramp Up API

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-cabot

Repository

github.com/factset/enterprise-sdk

Homepage

developer.factset.com/

Weekly Downloads

7

Version

0.13.0

License

Apache-2.0

Unpacked Size

335 kB

Total Files

98

Last publish

Collaborators

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