FactSet.SDK.SPAREngine 0.21.4

SPAR Engine client library for .NET

Allow clients to fetch Analytics through APIs.

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

• API version: 3
• Package version: 0.21.4
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.Protobuf.Stach.Extensions
dotnet add package FactSet.SDK.SPAREngine

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.Protobuf.Stach.Extensions
nuget install FactSet.SDK.SPAREngine

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

namespace Example
{
    public static class GetAccountsExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.SPAREngine.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 AccountsApi(config);
            var path = "\"Client:\"";  // string | The directory to get the accounts and sub-directories in (default to "Client:")

            try
            {
                // Get accounts and sub-directories in a directory
                AccountDirectoriesRoot result = apiInstance.GetAccounts(path);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling AccountsApi.GetAccounts: " + 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;

STACH extensions

Some methods within this client library are able to return STACH formatted data. Please see the documentation of those endpoints on how to enable and use STACH formatted data.

Documentation of the STACH extension can be found here: stach-extensions and here STACH schema

Documentation for API Endpoints

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

Documentation for Models

• Model.AccountDirectories
• Model.AccountDirectoriesRoot
• Model.CalculationMeta
• Model.CalculationStatus
• Model.CalculationStatusMeta
• Model.CalculationStatusRoot
• Model.CalculationUnitStatus
• Model.CalculationUnitStatusMeta
• Model.CalculationsSummary
• Model.CalculationsSummaryRoot
• Model.ClientErrorResponse
• Model.ComponentSummary
• Model.ComponentSummaryRoot
• Model.Currency
• Model.CurrencyRoot
• Model.DocumentDirectories
• Model.DocumentDirectoriesRoot
• Model.Error
• Model.ErrorSource
• Model.Frequency
• Model.FrequencyRoot
• Model.ObjectRoot
• Model.PaginationInfo
• Model.PaginationMeta
• Model.ReturnType
• Model.SPARAccounts
• Model.SPARAccountsRoot
• Model.SPARBenchmark
• Model.SPARBenchmarkRoot
• Model.SPARCalculationParameters
• Model.SPARCalculationParametersRoot
• Model.SPARDateParameters
• Model.SPARIdentifier

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.