@factset/sdk-recommendationlistapifordigitalportal

Recommendation List API for Digital Portals client library for JavaScript

A recommendation list is revision-controlled, with up to 5,000 revisions per recommendation list.

A recommendation list as of a given revision may optionally point to an instrument (e.g. an index) and contains a list of up to 1,000 elements, each referring to a security traded on a market (e.g. a financial product recommended by the bank). For listings that are not available in the Wealth Management platform, no information beyond a customer-defined name is available. Each element may optionally have a portfolio weight. Identifiers for revisions are globally unique.

See the Quotes API for Digital Portals for access to detailed price information.

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

API version: 2
Package version: 0.10.2
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-recommendationlistapifordigitalportals

yarn

yarn add @factset/sdk-utils @factset/sdk-recommendationlistapifordigitalportals

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=14. If you're using nvm:
```
nvm install 16
nvm use 16
```
2. (optional) Install yarn.
Install dependencies.
Run the following:

const { ApiClient, RecommendationListApi } = require('@factset/sdk-recommendationlistapifordigitalportals');
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
// 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 RecommendationListApi();
const id = 3.4; // Number | 
const opts = {
  'attributes': ["null"], // [String] | Limit the attributes returned in the response to the specified set.
  'language': "language_example" // String | 
};

// Call api endpoint
apiInstance.getRecommendationListGet(id, opts).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/wealth/v1

Class	Method	HTTP request	Description
recommendationlistapifordigitalportals.RecommendationListApi	getRecommendationListGet	GET /recommendationList/get	Attributes of a single list.
recommendationlistapifordigitalportals.RecommendationListApi	getRecommendationListRevisionElementList	GET /recommendationList/revision/element/list	List of elements of a given revision.
recommendationlistapifordigitalportals.RecommendationListApi	getRecommendationListRevisionGet	GET /recommendationList/revision/get	Attributes of a single revision.
recommendationlistapifordigitalportals.RecommendationListApi	getRecommendationListRevisionSearch	GET /recommendationList/revision/search	Search for revisions of a recommendation list.
recommendationlistapifordigitalportals.RecommendationListApi	getRecommendationListSearch	GET /recommendationList/search	Search for recommendation lists.
recommendationlistapifordigitalportals.RecommendationListApi	postRecommendationListRevisionList	POST /recommendationList/revision/list	List of revisions of a recommendation list.

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

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago