FactSet.SDK.StocksAPIforDigitalPortals 0.11.1

Prefix Reserved

dotnet add package FactSet.SDK.StocksAPIforDigitalPortals --version 0.11.1

NuGet\Install-Package FactSet.SDK.StocksAPIforDigitalPortals -Version 0.11.1

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.11.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add FactSet.SDK.StocksAPIforDigitalPortals --version 0.11.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: FactSet.SDK.StocksAPIforDigitalPortals, 0.11.1"

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

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Stocks API for Digital Portals client library for .NET

The Stocks API features a screener to search for equity instruments based on stock-specific parameters.

Parameters for up to three fiscal years might now be used in one request; data is available for the ten most recent completed fiscal years. Estimates are available for the current and two consecutive fiscal years. Search criteria also include benchmark-related attributes (beta, correlation, outperformance), and ESG parameters, based on FactSet’s Truvalue ESG scores.

A separate endpoint returns the possible values and value ranges for the parameters that the endpoint /stock/notation/screener/search accepts Application developers can request the values and value ranges only for a restricted set of notations that match predefined parameters. This functionality may be used to pre-fill the values and value ranges of the parameters of the /stock/notation/screener/search endpoint so that performing a search always leads to a non-empty set of notations.

The endpoint /stock/notation/ranking/intraday/list ranks stocks notations using intraday figures, for example to build a gainers/losers list.

Additional endpoints include end-of-day benchmark key figures, and selected fundamentals (as of end of fiscal year and with daily updates).

This API is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments, as well as basic security identifier cross-reference. For direct access to price histories, please refer to the Time Series API for Digital Portals.

Similar criteria based screener APIs exist for fixed income instruments and securitized derivatives: See the Bonds API and the Securitized Derivatives API for details.

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

API version: 2
SDK version: 0.11.1
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 -v 0.11.1

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.StocksAPIforDigitalPortals -Version 0.11.1

Usage

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

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

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 GetCompanyBoardListByInstrumentExample
    {
        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
            //
            // The confidential client instance should be reused in production environments.
            // 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 CompanyApi(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) 
            var language = "language_example";  // string |  (optional) 

            try
            {
                // List of boards for a company, with their officers.
                InlineResponse2005 result = apiInstance.GetCompanyBoardListByInstrument(id, attributes, language);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling CompanyApi.GetCompanyBoardListByInstrument: " + 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

Class	Method	HTTP request	Description
CompanyApi	GetCompanyBoardListByInstrument	GET /company/board/listByInstrument	List of boards for a company, with their officers.
CompanyApi	GetCompanyBoardOfficerFunctionDeliveryList	GET /company/board/officer/function/delivery/list	List of officer functions as provided by a delivery.
CompanyApi	GetCompanyBoardTypeList	GET /company/board/type/list	List of company board types.
CompanyApi	PostCompanyEstimatesListByInstrument	POST /company/estimates/listByInstrument	Estimates for selected figures for a stock.
CompanyApi	PostCompanyKeyItemsCurrentGetByInstrument	POST /company/keyItems/current/getByInstrument	Fundamentals for a stock with potentially daily updates.
CompanyApi	PostCompanyKeyItemsFiscalYearListByInstrument	POST /company/keyItems/fiscalYear/listByInstrument	Selected fundamentals for a stock with values as of the end of a fiscal year.
StockApi	GetStockCompositeProfileGetByNotation	GET /stock/composite/profile/getByNotation	Provides key elements of a stock profile together with the profile of the issuing company.
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	GetStockNotationKeyFiguresBenchmarkMonth6Get	GET /stock/notation/keyFigures/benchmark/month/6/get	End-of-day (EOD) benchmark key figures of a stock for the time range of six 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	GetStockOwnerList	GET /stock/owner/list	List of owners for a specific type of a company's shares.
StockApi	GetStockRecommendationAggregateGet	GET /stock/recommendation/aggregate/get	Target price and aggregated recommendations for a stock.
StockApi	GetStockRecommendationAggregateHistoryList	GET /stock/recommendation/aggregate/history/list	Current and historical trade recommendations and target prices for a stock.
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

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.

.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)

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.11.1	103	7/11/2024
0.11.0	105	6/14/2024
0.10.14	135	4/10/2024
0.10.13	263	10/25/2023
0.10.12	152	8/30/2023
0.10.11	150	8/11/2023
0.10.10	143	6/6/2023
0.10.9	176	5/11/2023
0.10.8	230	3/1/2023
0.10.7	252	2/24/2023
0.10.6	319	1/12/2023
0.10.4	303	12/15/2022
0.10.3	399	8/31/2022
0.10.1	413	7/21/2022
0.10.0	414	5/24/2022
0.9.4	374	8/31/2022
0.9.3	395	7/21/2022
0.9.2	412	5/24/2022
0.9.1	430	2/14/2022
0.9.0	419	2/2/2022

Refer to Changelog on GitHub source repository