@factset/sdk-realtimepricealerting

v0.11.1

Published

7 months ago

Real-Time Price Alerting client library for JavaScript

Downloads

0High
0Medium
0Low

enterprisesdk

fds

tsouthmaydfds

FactSet API SDK

Real-Time Price Alerting client library for JavaScript

The Price Alerting API is designed to inform the users of an application directly about important changes in the data on the platform. The endpoint group basic price alerting deals with generation of alerts based on current price data. For notations, users can define an upper or lower limit and choose on which price type those limit conditions apply.

Alerting uses the concepts of triggers and alerts.

A trigger is an entity that is set up by an application to watch a certain condition in the market data around a financial instrument. The standard conditions that can be applied are lower limit and upper limit for the value of the price for a given financial instrument.

When the condition of a trigger is met, an alert is created. Each alert thus represents one event where a trigger condition was met.

An application can learn about the creation of alerts in two ways: The application can actively request the list of alerts (pull approach) or it can subscribe to the list of existing alerts. If a new alert is created, that list changes and the application is notified about the new alert with an update that contains the details on the new alert (push approach).

The API supports both approaches. The push approach is realized most easily by using the subscription support that the client libraries provide.

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

Note: As part of the general trial access, endpoints to write data are excluded. For a description of the full alerting API, please work with a FactSet consultant and see https://endpointreference.factset.com.

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

API version: 3.0.0
Package version: 0.11.1
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
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, AlertingApi } = require('@factset/sdk-realtimepricealerting');
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 AlertingApi();
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.getAlertingPricesBasicAlertGet(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/v3

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- realtimepricealerting.AlertingApi | getAlertingPricesBasicAlertGet | GET /alerting/prices/basic/alert/get | Details of an alert. realtimepricealerting.AlertingApi | getAlertingPricesBasicAlertList | GET /alerting/prices/basic/alert/list | List of alerts. realtimepricealerting.AlertingApi | getAlertingPricesBasicTriggerGet | GET /alerting/prices/basic/trigger/get | Details of a trigger. realtimepricealerting.AlertingApi | postAlertingPricesBasicTriggerList | POST /alerting/prices/basic/trigger/list | List of triggers.

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.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Real-Time Price Alerting client library for JavaScript

Requirements

Installation

npm

yarn

Usage

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

FactSetApiKey

FactSetOAuth2

Contributing

Copyright