FactSet.SDK.SPAREngine
0.21.4
Prefix Reserved
See the version list below for details.
dotnet add package FactSet.SDK.SPAREngine --version 0.21.4
NuGet\Install-Package FactSet.SDK.SPAREngine -Version 0.21.4
<PackageReference Include="FactSet.SDK.SPAREngine" Version="0.21.4" />
paket add FactSet.SDK.SPAREngine --version 0.21.4
#r "nuget: FactSet.SDK.SPAREngine, 0.21.4"
// Install FactSet.SDK.SPAREngine as a Cake Addin #addin nuget:?package=FactSet.SDK.SPAREngine&version=0.21.4 // Install FactSet.SDK.SPAREngine as a Cake Tool #tool nuget:?package=FactSet.SDK.SPAREngine&version=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
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- 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
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | GetAccounts | GET /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory |
AccountsApi | GetSPARReturnsType | GET /analytics/engines/spar/v3/accounts/{accountPath}/returns-type | Get SPAR account returns type details |
BenchmarksApi | GetSPARBenchmarkById | GET /analytics/engines/spar/v3/benchmarks | Get SPAR benchmark details |
ComponentsApi | GetSPARComponents | GET /analytics/engines/spar/v3/components | Get SPAR components |
CurrenciesApi | GetCurrencies | GET /analytics/lookups/v3/currencies | Get currencies |
DocumentsApi | GetSPAR3Documents | GET /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory |
FrequenciesApi | GetSPARFrequencies | GET /analytics/engines/spar/v3/frequencies | Get SPAR frequencies |
SPARCalculationsApi | CancelCalculationById | DELETE /analytics/engines/spar/v3/calculations/{id} | Cancel SPAR calculation |
SPARCalculationsApi | GetAllCalculations | GET /analytics/engines/spar/v3/calculations | Get all calculations |
SPARCalculationsApi | GetCalculationParameters | GET /analytics/engines/spar/v3/calculations/{id} | Get SPAR calculation parameters by id |
SPARCalculationsApi | GetCalculationStatusById | GET /analytics/engines/spar/v3/calculations/{id}/status | Get SPAR calculation status by id |
SPARCalculationsApi | GetCalculationUnitResultById | GET /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result | Get SPAR calculation result by id |
SPARCalculationsApi | PostAndCalculate | POST /analytics/engines/spar/v3/calculations | Create and Run SPAR calculation |
SPARCalculationsApi | PutAndCalculate | PUT /analytics/engines/spar/v3/calculations/{id} | Create or Update SPAR calculation and run it. |
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.
Product | Versions 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. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.1)
- 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 |
---|---|---|
2.0.0 | 123 | 7/18/2024 |
1.0.4 | 93 | 7/11/2024 |
1.0.3 | 89 | 5/3/2024 |
1.0.2 | 122 | 4/10/2024 |
1.0.1 | 203 | 12/15/2023 |
1.0.0 | 188 | 10/20/2023 |
0.23.0 | 160 | 9/12/2023 |
0.22.3 | 154 | 8/30/2023 |
0.22.2 | 154 | 8/11/2023 |
0.22.1 | 163 | 6/6/2023 |
0.22.0 | 142 | 5/26/2023 |
0.21.5 | 155 | 5/11/2023 |
0.21.4 | 233 | 3/1/2023 |
0.21.3 | 246 | 2/24/2023 |
0.21.2 | 348 | 11/14/2022 |
0.21.1 | 386 | 8/31/2022 |
0.21.0 | 408 | 7/21/2022 |
0.20.0 | 432 | 5/24/2022 |
0.9.1 | 444 | 2/14/2022 |
0.9.0 | 422 | 2/2/2022 |
0.8.10 | 159 | 8/30/2023 |
0.8.9 | 144 | 8/11/2023 |
0.8.8 | 170 | 6/6/2023 |
0.8.7 | 147 | 5/11/2023 |
0.8.6 | 236 | 3/1/2023 |
0.8.5 | 240 | 2/24/2023 |
0.8.4 | 389 | 8/31/2022 |
0.8.3 | 403 | 7/21/2022 |
0.8.2 | 405 | 5/24/2022 |
0.8.1 | 429 | 2/14/2022 |
0.8.0 | 452 | 2/2/2022 |
Refer to Changelog on GitHub source repository