@factset/sdk-watchlistapifordigitalportals NPM

Watchlist API for Digital Portals client library for JavaScript

Watchlists keeps track of users' individual investment objectives. They are meant to support the self-directed business of wealth management firms.

The Watchlist API for Digital Portals is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments in a watchlist. This also supports basic security identifier cross-reference. To complement the Watchlist API with direct access to price histories, please refer to the Time Series API for Digital Portals.

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

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

Requirements

Node.js >= 14

Installation

npm

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

yarn

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

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

// Call api endpoint
apiInstance.getWatchlistGet(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
watchlistapifordigitalportals.WatchlistApi	getWatchlistGet	GET /watchlist/get	Details of a watchlist.
watchlistapifordigitalportals.WatchlistApi	getWatchlistList	GET /watchlist/list	List of watchlists.
watchlistapifordigitalportals.WatchlistApi	getWatchlistPositionList	GET /watchlist/position/list	List of positions of a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistCreate	POST /watchlist/create	Create a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistDelete	POST /watchlist/delete	Delete a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistModify	POST /watchlist/modify	Modify a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistPositionCreate	POST /watchlist/position/create	Add a position to a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistPositionDelete	POST /watchlist/position/delete	Delete a position of a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistPositionGet	POST /watchlist/position/get	Details of the position of a watchlist.
watchlistapifordigitalportals.WatchlistApi	postWatchlistPositionModify	POST /watchlist/position/modify	Modify a position in a watchlist.

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