FactSet.SDK.PriceAlertingAPIforDigitalPortals 0.10.3

<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">

Price Alerting API for Digital Portals client library for .NET

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.

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 2
• Package version: 0.10.3
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.PriceAlertingAPIforDigitalPortals

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.PriceAlertingAPIforDigitalPortals

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. Run the following:

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.PriceAlertingAPIforDigitalPortals.Api;
using FactSet.SDK.PriceAlertingAPIforDigitalPortals.Client;
using FactSet.SDK.PriceAlertingAPIforDigitalPortals.Model;

namespace Example
{
    public static class GetAlertingPricesBasicAlertGetExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.PriceAlertingAPIforDigitalPortals.Client.Configuration();

            // 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-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new AlertingApi(config);
            var id = "id_example";  // string | 
            var attributes = new List<string>(); // List<string> | Limit the attributes returned in the response to the specified set. (optional) 

            try
            {
                // Details of an alert.
                InlineResponse200 result = apiInstance.GetAlertingPricesBasicAlertGet(id, attributes);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling AlertingApi.GetAlertingPricesBasicAlertGet: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

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

Documentation for Models

• Model.AlertingPricesBasicTriggerListData
• Model.AlertingPricesBasicTriggerListDataFilter
• Model.AlertingPricesBasicTriggerListDataFilterStatus
• Model.AlertingPricesBasicTriggerListMeta
• Model.AlertingPricesBasicTriggerListMetaPagination
• Model.CursorBasedPaginationOutputObject
• Model.CursorBasedPaginationOutputObjectWithoutTotal
• Model.ErrorMetaObject
• Model.InlineObject
• Model.InlineResponse200
• Model.InlineResponse2001
• Model.InlineResponse2001Data
• Model.InlineResponse2001Meta
• Model.InlineResponse2001Trigger
• Model.InlineResponse2001TriggerPrice
• Model.InlineResponse2001TriggerStatus
• Model.InlineResponse2002
• Model.InlineResponse2002Data
• Model.InlineResponse2003
• Model.InlineResponse2003Data
• Model.InlineResponse2003Range
• Model.InlineResponse200Data
• Model.InlineResponse200DataPrice
• Model.InlineResponse200DataTrigger
• Model.InlineResponse200DataTriggerNotation
• Model.InlineResponse200DataTriggerPrice
• Model.InlineResponse200DataTriggerRange
• Model.InlineResponse200DataTriggerStatus
• Model.InlineResponse200Meta
• Model.OffsetBasedPaginationOutputObject
• Model.OffsetBasedPaginationOutputObjectWithoutTotal
• Model.PartialOutputObject
• Model.StatusObject

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.