@factset/sdk-barraportfoliooptimizer
v0.21.4
Published
Barra Portfolio Optimizer client library for JavaScript
Downloads
12
Readme
Barra Portfolio Optimizer client library for JavaScript
Allow clients to fetch Analytics through APIs.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 3
- Package version: 0.21.4
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/[email protected]
yarn
yarn add @factset/sdk-utils @factset/[email protected]
Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Install dependencies.
- Run the following:
const { ApiClient, AccountsApi } = require('@factset/sdk-barraportfoliooptimizer');
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 AccountsApi();
const path = "'Client:Foo/Bar'"; // String | The directory to get the accounts and sub-directories in
// Call api endpoint
apiInstance.getAccounts(path).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Documentation for API Endpoints
All URIs are relative to https://api.factset.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- barraportfoliooptimizer.AccountsApi | getAccounts | GET /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory barraportfoliooptimizer.BPMOptimizerApi | cancelOptimizationById | DELETE /analytics/engines/bpm/v3/optimizations/{id} | Cancel BPM optimization by id barraportfoliooptimizer.BPMOptimizerApi | getOptimizationParameters | GET /analytics/engines/bpm/v3/optimizations/{id} | Get BPM optimization parameters by id barraportfoliooptimizer.BPMOptimizerApi | getOptimizationResult | GET /analytics/engines/bpm/v3/optimizations/{id}/result | Get BPM optimization result by id barraportfoliooptimizer.BPMOptimizerApi | getOptimizationStatusById | GET /analytics/engines/bpm/v3/optimizations/{id}/status | Get BPM optimization status by id barraportfoliooptimizer.BPMOptimizerApi | postAndOptimize | POST /analytics/engines/bpm/v3/optimizations | Create and Run BPM optimization barraportfoliooptimizer.BPMOptimizerApi | putAndOptimize | PUT /analytics/engines/bpm/v3/optimizations/{id} | Create or Update BPM optimization and run it. barraportfoliooptimizer.CurrenciesApi | getCurrencies | GET /analytics/lookups/v3/currencies | Get currencies barraportfoliooptimizer.StrategyDocumentsApi | getBarraStrategyDocuments | GET /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory
Documentation for Models
- barraportfoliooptimizer.AccountDirectories
- barraportfoliooptimizer.AccountDirectoriesRoot
- barraportfoliooptimizer.BPMOptimization
- barraportfoliooptimizer.BPMOptimizationParameters
- barraportfoliooptimizer.BPMOptimizationParametersRoot
- barraportfoliooptimizer.BPMOptimizerStrategy
- barraportfoliooptimizer.BPMOptimizerStrategyAlphaOverride
- barraportfoliooptimizer.BPMOptimizerStrategyOverrides
- barraportfoliooptimizer.CalculationInfo
- barraportfoliooptimizer.CalculationInfoRoot
- barraportfoliooptimizer.ClientErrorResponse
- barraportfoliooptimizer.ConstraintAction
- barraportfoliooptimizer.Currency
- barraportfoliooptimizer.CurrencyRoot
- barraportfoliooptimizer.DocumentDirectories
- barraportfoliooptimizer.DocumentDirectoriesRoot
- barraportfoliooptimizer.Error
- barraportfoliooptimizer.ErrorSource
- barraportfoliooptimizer.ObjectRoot
- barraportfoliooptimizer.OptimalPortfolio
- barraportfoliooptimizer.OptimizerAccount
- barraportfoliooptimizer.OptimizerAccountOverrides
- barraportfoliooptimizer.OptimizerOptimalHoldings
- barraportfoliooptimizer.OptimizerOutputTypes
- barraportfoliooptimizer.OptimizerTradesList
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.