Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@factset/sdk-axiomaequityoptimizer

Package Overview
Dependencies
Maintainers
3
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@factset/sdk-axiomaequityoptimizer

Allow_clients_to_fetch_Analytics_through_APIs_

  • 0.9.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5
increased by66.67%
Maintainers
3
Weekly downloads
 
Created
Source

@factset/sdk-axiomaequityoptimizer

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

  • API version: 3
  • Package version: 0.9.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, AXPOptimizerApi } = 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 AXPOptimizerApi();
const id = "id_example"; // String | from url, provided from the location header in the Create and Run Axioma optimization endpoint

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

Documentation for API Endpoints

All URIs are relative to https://api.factset.com

ClassMethodHTTP requestDescription
axiomaequityoptimizer.AXPOptimizerApicancelOptimizationByIdDELETE /analytics/engines/axp/v3/optimizations/{id}Cancel Axioma optimization by id
axiomaequityoptimizer.AXPOptimizerApigetOptimizationParametersGET /analytics/engines/axp/v3/optimizations/{id}Get Axioma optimization parameters by id
axiomaequityoptimizer.AXPOptimizerApigetOptimizationResultGET /analytics/engines/axp/v3/optimizations/{id}/resultGet Axioma optimization result by id
axiomaequityoptimizer.AXPOptimizerApigetOptimizationStatusByIdGET /analytics/engines/axp/v3/optimizations/{id}/statusGet Axioma optimization status by id
axiomaequityoptimizer.AXPOptimizerApipostAndOptimizePOST /analytics/engines/axp/v3/optimizationsCreate and Run Axioma optimization
axiomaequityoptimizer.AXPOptimizerApiputAndOptimizePUT /analytics/engines/axp/v3/optimizations/{id}Create or Update Axioma optimization and run it.
axiomaequityoptimizer.AccountsApigetAccountsGET /analytics/lookups/v3/accounts/{path}Get accounts and sub-directories in a directory
axiomaequityoptimizer.CurrenciesApigetCurrenciesGET /analytics/lookups/v3/currenciesGet currencies
axiomaequityoptimizer.StrategyDocumentsApigetAxiomaEquityStrategyDocumentsGET /analytics/engines/axp/v3/strategies/{path}Get Axioma Equity strategy documents and sub-directories in a directory

Documentation for Models

Documentation for Authorization

FactSetApiKey

  • Type: HTTP basic authentication

FactSetOAuth2

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

Keywords

FAQs

Package last updated on 02 Feb 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc