FactSet.SDK.StocksAPIforDigitalPortals 0.9.4

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FactSet.SDK.StocksAPIforDigitalPortals --version 0.9.4
NuGet\Install-Package FactSet.SDK.StocksAPIforDigitalPortals -Version 0.9.4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FactSet.SDK.StocksAPIforDigitalPortals" Version="0.9.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add FactSet.SDK.StocksAPIforDigitalPortals --version 0.9.4
#r "nuget: FactSet.SDK.StocksAPIforDigitalPortals, 0.9.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install FactSet.SDK.StocksAPIforDigitalPortals as a Cake Addin
#addin nuget:?package=FactSet.SDK.StocksAPIforDigitalPortals&version=0.9.4

// Install FactSet.SDK.StocksAPIforDigitalPortals as a Cake Tool
#tool nuget:?package=FactSet.SDK.StocksAPIforDigitalPortals&version=0.9.4

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

Stocks API for Digital Portals client library for .NET

Nuget Apache-2 license

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: v1
  • Package version: 0.9.4
  • 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.StocksAPIforDigitalPortals

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.StocksAPIforDigitalPortals

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.StocksAPIforDigitalPortals.Api;
using FactSet.SDK.StocksAPIforDigitalPortals.Client;
using FactSet.SDK.StocksAPIforDigitalPortals.Model;

namespace Example
{
    public static class GetStockDividendTypeListExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.StocksAPIforDigitalPortals.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 StockApi(config);
            var attributes = new List<string>(); // List<string> | Limit the attributes returned in the response to the specified set. (optional) 
            var language = "language_example";  // string | ISO 639-1 code of the language. (optional) 

            try
            {
                // List of dividend types.
                InlineResponse2001 result = apiInstance.GetStockDividendTypeList(attributes, language);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling StockApi.GetStockDividendTypeList: " + 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 http://api.factset.com/wealth/v1

Class Method HTTP request Description
StockApi GetStockDividendTypeList GET /stock/dividend/type/list List of dividend types.
StockApi GetStockNotationKeyFiguresBenchmarkMonth1Get GET /stock/notation/keyFigures/benchmark/month/1/get End-of-day (EOD) benchmark key figures of a stock for the time range of one month.
StockApi GetStockNotationKeyFiguresBenchmarkMonth3Get GET /stock/notation/keyFigures/benchmark/month/3/get End-of-day (EOD) benchmark key figures of a stock for the time range of three months.
StockApi GetStockNotationKeyFiguresBenchmarkWeek1Get GET /stock/notation/keyFigures/benchmark/week/1/get End-of-day (EOD) benchmark key figures of a stock for the time range of one week.
StockApi GetStockNotationKeyFiguresBenchmarkYear1Get GET /stock/notation/keyFigures/benchmark/year/1/get End-of-day (EOD) benchmark key figures of a stock for the time range of one year.
StockApi GetStockNotationKeyFiguresBenchmarkYear3Get GET /stock/notation/keyFigures/benchmark/year/3/get End-of-day (EOD) benchmark key figures of a stock for the time range of three years.
StockApi GetStockNotationKeyFiguresBenchmarkYear5Get GET /stock/notation/keyFigures/benchmark/year/5/get End-of-day (EOD) benchmark key figures of a stock for the time range of five years.
StockApi PostStockDividendList POST /stock/dividend/list List of dividends for a stock.
StockApi PostStockNotationRankingIntradayList POST /stock/notation/ranking/intraday/list Ranking of stocks' notations using intraday figures.
StockApi PostStockNotationScreenerSearch POST /stock/notation/screener/search Screener for stocks' notations based on stock-specific parameters.
StockApi PostStockNotationScreenerValueRangesGet POST /stock/notation/screener/valueRanges/get Possible values and value ranges for the parameters used in the endpoint /stock/notation/screener/search.

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 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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.10.14 100 4/10/2024
0.10.13 229 10/25/2023
0.10.12 122 8/30/2023
0.10.11 118 8/11/2023
0.10.10 113 6/6/2023
0.10.9 138 5/11/2023
0.10.8 201 3/1/2023
0.10.7 221 2/24/2023
0.10.6 283 1/12/2023
0.10.4 267 12/15/2022
0.10.3 362 8/31/2022
0.10.1 374 7/21/2022
0.10.0 380 5/24/2022
0.9.4 342 8/31/2022
0.9.3 358 7/21/2022
0.9.2 373 5/24/2022
0.9.1 397 2/14/2022
0.9.0 386 2/2/2022

Refer to Changelog on GitHub source repository