@factset/sdk-axiomaequityoptimizer

@factset/sdk-axiomaequityoptimizer

axiomaequityoptimizer - JavaScript client for @factset/sdk-axiomaequityoptimizer Allow clients to fetch Engines Analytics through APIs. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1
• Package version: 0.8.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://developer.factset.com/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @factset/sdk-axiomaequityoptimizer --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @factset/sdk-axiomaequityoptimizer from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

Getting Started

Please follow the installation instruction and execute the following JS code:

const { ApiClient, OptimizationsApi } = require('@factset/sdk-axiomaequityoptimizer');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// Configure HTTP basic authorization: FactSetApiKey
const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
FactSetApiKey.username = 'YOUR USERNAME';
FactSetApiKey.password = 'YOUR PASSWORD';

// Configure OAuth2 access token for authorization: FactSetOAuth2
const FactSetOAuth2 = apiClient.authentications['FactSetOAuth2'];
FactSetOAuth2.accessToken = 'YOUR ACCESS TOKEN';

// Configure OAuth2 access with ConfidentialClient
apiClient.factsetOauth2Client = new ConfidentialClient('./config.json');

const apiInstance = new OptimizationsApi();
const id = "id_example"; // String | from url, provided from the location header in the Run Optimization endpoint

// Call api endpoint
apiInstance.cancelAxiomaOptimizationById(id).then(
  () => {
    console.log('API called successfully.');
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
axiomaequityoptimizer.OptimizationsApi	cancelAxiomaOptimizationById	DELETE /analytics/engines/axp/v1/optimizations/{id}	Cancel Axioma optimization by id
axiomaequityoptimizer.OptimizationsApi	getAxiomaOptimizationById	GET /analytics/engines/axp/v1/optimizations/{id}	Get Axioma optimization by id
axiomaequityoptimizer.OptimizationsApi	runAxiomaOptimization	POST /analytics/engines/axp/v1/optimizations	Run Axioma optimization
axiomaequityoptimizer.StrategyDocumentsApi	getAxiomaEquityStrategyDocuments	GET /analytics/engines/axp/v1/strategies/{path}	Get Axioma Equity strategy documents and sub-directories in a directory

Documentation for Models

• axiomaequityoptimizer.AxiomaEquityOptimizationParameters
• axiomaequityoptimizer.DocumentDirectories
• axiomaequityoptimizer.OptimalPortfolio
• axiomaequityoptimizer.Optimization
• axiomaequityoptimizer.OptimizerAccount
• axiomaequityoptimizer.OptimizerAccountOverrides
• axiomaequityoptimizer.OptimizerOptimalHoldings
• axiomaequityoptimizer.OptimizerOutputTypes
• axiomaequityoptimizer.OptimizerStrategy
• axiomaequityoptimizer.OptimizerStrategyOverrides
• axiomaequityoptimizer.OptimizerTradesList

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A