FactSet Benchmarks client library for .NET

FactSet Benchmarks API gives access to Index Constituents, Prices, Returns, and Ratios. For a sample list of identifiers, use the /metrics endpoint. Equity Only - Fixed Income Benchmark support coming soon.

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

API version: 1.10.0
SDK version: 1.5.0
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.FactSetBenchmarks -v 1.5.0

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetBenchmarks -Version 1.5.0

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

namespace Example
{
    public static class GetBenchmarkConstituentsExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetBenchmarks.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 BenchmarkConstituentsApi(config);
            var ids = new List<string>(); // List<string> | Benchmark Identifiers. Reference the helper endpoint **_/id-list** to get a sample list of  valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error. <p>***ids limit** =  1 per request*</p>
            var date = "date_example";  // string | Date of holding expressed in YYYY-MM-DD format. (optional) 
            var currency = "currency_example";  // string | Currency for response. (optional) 
            var calendar = "\"FIVEDAY\"";  // string | Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays. (optional)  (default to "FIVEDAY")

            try
            {
                // Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
                BenchmarkConstituentsResponse result = apiInstance.GetBenchmarkConstituents(ids, date, currency, calendar);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling BenchmarkConstituentsApi.GetBenchmarkConstituents: " + 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/content

Class	Method	HTTP request	Description
BenchmarkConstituentsApi	GetBenchmarkConstituents	GET /factset-benchmarks/v1/constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetBenchmarkConstituentsForList	POST /factset-benchmarks/v1/constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetFIBenchmarkConstituents	GET /factset-benchmarks/v1/fixed-income-constituents	Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetFIBenchmarkConstituentsForList	POST /factset-benchmarks/v1/fixed-income-constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
HelperApi	GetBenchmarkIds	GET /factset-benchmarks/v1/id-list	Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
HelperApi	GetBenchmarkIdsForList	POST /factset-benchmarks/v1/id-list	Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
IndexLevelApi	GetBenchmarkRatios	GET /factset-benchmarks/v1/ratios	Returns the aggregated ratios of a requested benchmark
IndexLevelApi	GetBenchmarkRatiosForList	POST /factset-benchmarks/v1/ratios	Returns the aggregated ratios of a requested benchmark
IndexLevelApi	GetIndexHistory	GET /factset-benchmarks/v1/index-history	Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
IndexLevelApi	GetIndexHistoryForList	POST /factset-benchmarks/v1/index-history	Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
IndexLevelApi	GetIndexSnapshot	GET /factset-benchmarks/v1/index-snapshot	Index Level Prices, Returns, and related information as of a single date.
IndexLevelApi	GetIndexSnapshotForList	POST /factset-benchmarks/v1/index-snapshot	Retrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date.

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 Benchmarks client library for .NET

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

API version: 1.10.0
SDK version: 1.5.0
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.FactSetBenchmarks -v 1.5.0

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetBenchmarks -Version 1.5.0

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

namespace Example
{
    public static class GetBenchmarkConstituentsExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetBenchmarks.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 BenchmarkConstituentsApi(config);
            var ids = new List<string>(); // List<string> | Benchmark Identifiers. Reference the helper endpoint **_/id-list** to get a sample list of  valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error. <p>***ids limit** =  1 per request*</p>
            var date = "date_example";  // string | Date of holding expressed in YYYY-MM-DD format. (optional) 
            var currency = "currency_example";  // string | Currency for response. (optional) 
            var calendar = "\"FIVEDAY\"";  // string | Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays. (optional)  (default to "FIVEDAY")

            try
            {
                // Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
                BenchmarkConstituentsResponse result = apiInstance.GetBenchmarkConstituents(ids, date, currency, calendar);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling BenchmarkConstituentsApi.GetBenchmarkConstituents: " + 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/content

Class	Method	HTTP request	Description
BenchmarkConstituentsApi	GetBenchmarkConstituents	GET /factset-benchmarks/v1/constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetBenchmarkConstituentsForList	POST /factset-benchmarks/v1/constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetFIBenchmarkConstituents	GET /factset-benchmarks/v1/fixed-income-constituents	Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value.
BenchmarkConstituentsApi	GetFIBenchmarkConstituentsForList	POST /factset-benchmarks/v1/fixed-income-constituents	Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.
HelperApi	GetBenchmarkIds	GET /factset-benchmarks/v1/id-list	Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
HelperApi	GetBenchmarkIdsForList	POST /factset-benchmarks/v1/id-list	Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.
IndexLevelApi	GetBenchmarkRatios	GET /factset-benchmarks/v1/ratios	Returns the aggregated ratios of a requested benchmark
IndexLevelApi	GetBenchmarkRatiosForList	POST /factset-benchmarks/v1/ratios	Returns the aggregated ratios of a requested benchmark
IndexLevelApi	GetIndexHistory	GET /factset-benchmarks/v1/index-history	Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
IndexLevelApi	GetIndexHistoryForList	POST /factset-benchmarks/v1/index-history	Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.
IndexLevelApi	GetIndexSnapshot	GET /factset-benchmarks/v1/index-snapshot	Index Level Prices, Returns, and related information as of a single date.
IndexLevelApi	GetIndexSnapshotForList	POST /factset-benchmarks/v1/index-snapshot	Retrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date.

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

FactSet/FactSet.SDK.FactSetBenchmarksv1.5.0

Get Started

Readme

FactSet Benchmarks client library for .NET

Requirements

Installation

.NET CLI

NuGet

Usage

Example Code

Using a Proxy

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

FactSetApiKey

FactSetOAuth2

Contributing

Copyright

FactSet/FactSet.SDK.FactSetBenchmarksv1.5.0

Get Started

Readme

FactSet Benchmarks client library for .NET

Requirements

Installation

.NET CLI

NuGet

Usage

Example Code

Using a Proxy

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

FactSetApiKey

FactSetOAuth2

Contributing

Copyright