Style Performance and Risk Analysis (SPAR) Engine client library for .NET
$ dotnet add package FactSet.SDK.SPAREngineAllow clients to fetch SPAR Engine Analytics through APIs.
This .NET package is automatically generated by the OpenAPI Generator project:
For more information, please visit https://developer.factset.com/contact
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.Protobuf.Stach.Extensions
dotnet add package FactSet.SDK.SPAREngine
nuget install FactSet.SDK.Utils
nuget install FactSet.Protobuf.Stach.Extensions
nuget install FactSet.SDK.SPAREngine
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:Foo/Bar\""; // string | The directory to get the accounts and sub-directories in (default to "Client:Foo/Bar")
try
{
// Get accounts and sub-directories in a directory
AccountDirectories 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);
}
}
}
}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;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
All URIs are relative to https://api-sandbox.factset.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | GetAccounts | GET /analytics/lookups/v2/accounts/{path} | Get accounts and sub-directories in a directory |
| CalculationsApi | CancelCalculationById | DELETE /analytics/engines/v2/calculations/{id} | Cancel calculation by id |
| CalculationsApi | GetCalculationStatusById | GET /analytics/engines/v2/calculations/{id} | Get calculation status by id |
| CalculationsApi | GetCalculationStatusSummaries | GET /analytics/engines/v2/calculations | Get all calculation statuses |
| CalculationsApi | RunCalculation | POST /analytics/engines/v2/calculations | Run calculation |
| ComponentsApi | GetSPARComponents | GET /analytics/lookups/v2/engines/spar/components | Get SPAR components |
| DocumentsApi | GetSPAR3Documents | GET /analytics/lookups/v2/engines/spar/documents/{path} | Gets SPAR3 documents and sub-directories in a directory |
| FrequenciesApi | GetSPARFrequencies | GET /analytics/lookups/v2/engines/spar/frequencies | Get SPAR frequencies |
| SPARBenchmarkApi | GetSPARBenchmarkById | GET /analytics/lookups/v2/engines/spar/benchmarks | Get SPAR benchmark details |
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.