View on GitHub

analyticsapi-engines-dotnet-sdk

🚨 THIS PACKAGE IS DEPRECATED!

The Analytics SDK will be deprecated effective 31-Aug-2026. While we intend to provide limited security fixes till 31-Aug-2026, this SDK will be archived thereafter and will no longer receive updates or security patches. Please migrate to our Enterprise SDK, which is the long-term supported solution from FactSet. Please choose the appropriate API-specific Enterprise SDK from these search results: enterprise-sdk.

FactSet.AnalyticsAPI.Engines - the C# library for the Engines API

Allow clients to fetch Analytics through APIs.

This C# SDK is automatically generated by the OpenAPI Generator project:

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

Usage

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;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.factset.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new AFIOptimizerApi(config);
            var id = id_example;  // string | from url, provided from the location header in the Create and Run AFI optimization endpoint

            try
            {
                // Cancel AFI optimization by id
                apiInstance.CancelOptimizationById(id);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AFIOptimizerApi.CancelOptimizationById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AFIOptimizerApi CancelOptimizationById DELETE /analytics/engines/afi/v3/optimizations/{id} Cancel AFI optimization by id
AFIOptimizerApi GetOptimizationParameters GET /analytics/engines/afi/v3/optimizations/{id} Get AFI optimization parameters by id
AFIOptimizerApi GetOptimizationResult GET /analytics/engines/afi/v3/optimizations/{id}/result Get AFI optimization result by id
AFIOptimizerApi GetOptimizationStatusById GET /analytics/engines/afi/v3/optimizations/{id}/status Get AFI optimization status by id
AFIOptimizerApi PostAndOptimize POST /analytics/engines/afi/v3/optimizations Create and Run AFI optimization
AFIOptimizerApi PutAndOptimize PUT /analytics/engines/afi/v3/optimizations/{id} Create or Update AFI optimization and run it.
AXPOptimizerApi CancelOptimizationById DELETE /analytics/engines/axp/v3/optimizations/{id} Cancel Axioma optimization by id
AXPOptimizerApi GetOptimizationParameters GET /analytics/engines/axp/v3/optimizations/{id} Get Axioma optimization parameters by id
AXPOptimizerApi GetOptimizationResult GET /analytics/engines/axp/v3/optimizations/{id}/result Get Axioma optimization result by id
AXPOptimizerApi GetOptimizationStatusById GET /analytics/engines/axp/v3/optimizations/{id}/status Get Axioma optimization status by id
AXPOptimizerApi PostAndOptimize POST /analytics/engines/axp/v3/optimizations Create and Run Axioma optimization
AXPOptimizerApi PutAndOptimize PUT /analytics/engines/axp/v3/optimizations/{id} Create or Update Axioma optimization and run it.
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
BPMOptimizerApi CancelOptimizationById DELETE /analytics/engines/bpm/v3/optimizations/{id} Cancel BPM optimization by id
BPMOptimizerApi GetOptimizationParameters GET /analytics/engines/bpm/v3/optimizations/{id} Get BPM optimization parameters by id
BPMOptimizerApi GetOptimizationResult GET /analytics/engines/bpm/v3/optimizations/{id}/result Get BPM optimization result by id
BPMOptimizerApi GetOptimizationStatusById GET /analytics/engines/bpm/v3/optimizations/{id}/status Get BPM optimization status by id
BPMOptimizerApi PostAndOptimize POST /analytics/engines/bpm/v3/optimizations Create and Run BPM optimization
BPMOptimizerApi PutAndOptimize PUT /analytics/engines/bpm/v3/optimizations/{id} Create or Update BPM optimization and run it.
BenchmarksApi GetSPARBenchmarkById GET /analytics/engines/spar/v3/benchmarks Get SPAR benchmark details
ColumnStatisticsApi GetPAColumnStatistics GET /analytics/engines/pa/v3/columnstatistics Get PA column statistics
ColumnsApi GetPAColumnById GET /analytics/engines/pa/v3/columns/{id} Get PA column settings
ColumnsApi GetPAColumns GET /analytics/engines/pa/v3/columns Get PA columns
ComponentsApi GetPAComponentById GET /analytics/engines/pa/v3/components/{id} Get PA component by id
ComponentsApi GetPAComponents GET /analytics/engines/pa/v3/components Get PA components
ComponentsApi GetSPARComponentById GET /analytics/engines/spar/v3/components/{id} Get SPAR component by id
ComponentsApi GetSPARComponents GET /analytics/engines/spar/v3/components Get SPAR components
ComponentsApi GetVaultComponentById GET /analytics/engines/vault/v3/components/{id} Get Vault component by id
ComponentsApi GetVaultComponents GET /analytics/engines/vault/v3/components Get Vault components
ConfigurationsApi GetVaultConfigurationById GET /analytics/engines/vault/v3/configurations/{id} Get Vault configuration by id
ConfigurationsApi GetVaultConfigurations GET /analytics/engines/vault/v3/configurations Get Vault configurations
CurrenciesApi GetCurrencies GET /analytics/lookups/v3/currencies Get currencies
DatesApi ConvertPADatesToAbsoluteFormat GET /analytics/engines/pa/v3/dates Convert PA dates to absolute format
DatesApi ConvertVaultDatesToAbsoluteFormat GET /analytics/engines/vault/v3/dates Convert Vault dates to absolute format
DiscountCurvesApi GetAllFIDiscountCurves GET /analytics/engines/fi/v3/discount-curves Get Discount Curves
DocumentsApi GetPA3Documents GET /analytics/engines/pa/v3/documents/{path} Get PA3 documents and sub-directories in a directory
DocumentsApi GetPubDocuments GET /analytics/engines/pub/v3/documents/{path} Gets Publisher documents and sub-directories in a directory
DocumentsApi GetSPAR3Documents GET /analytics/engines/spar/v3/documents/{path} Gets SPAR3 documents and sub-directories in a directory
DocumentsApi GetVaultDocuments GET /analytics/engines/vault/v3/documents/{path} Get Vault documents and sub-directories in a directory
FIABCalculationsApi GetCalculationById GET /analytics/engines/fiab/v1/calculations/{id} Get FIAB calculation by id
FIABCalculationsApi GetCalculationStatusSummaries GET /analytics/engines/fiab/v1/calculations Get all FIAB calculation summaries
FIABCalculationsApi RunCalculation POST /analytics/engines/fiab/v1/calculations Run FIAB calculation
FICalculationsApi CancelCalculationById DELETE /analytics/engines/fi/v3/calculations/{id} Cancel FI calculation by id
FICalculationsApi GetCalculationParameters GET /analytics/engines/fi/v3/calculations/{id} Get FI calculation parameters by id
FICalculationsApi GetCalculationResult GET /analytics/engines/fi/v3/calculations/{id}/result Get FI calculation result by id
FICalculationsApi GetCalculationStatusById GET /analytics/engines/fi/v3/calculations/{id}/status Get FI calculation status by id
FICalculationsApi PostAndCalculate POST /analytics/engines/fi/v3/calculations Create and Run FI calculation
FICalculationsApi PutAndCalculate PUT /analytics/engines/fi/v3/calculations/{id} Create or Update FI calculation and run it.
FPOOptimizerApi CancelOptimizationById DELETE /analytics/engines/fpo/v3/optimizations/{id} Cancel FPO optimization by id
FPOOptimizerApi GetOptimizationParameters GET /analytics/engines/fpo/v3/optimizations/{id} Get FPO optimization parameters by id
FPOOptimizerApi GetOptimizationResult GET /analytics/engines/fpo/v3/optimizations/{id}/result Get FPO optimization result by id
FPOOptimizerApi GetOptimizationStatusById GET /analytics/engines/fpo/v3/optimizations/{id}/status Get FPO optimization status by id
FPOOptimizerApi PostAndOptimize POST /analytics/engines/fpo/v3/optimizations Create and Run FPO optimization
FPOOptimizerApi PutAndOptimize PUT /analytics/engines/fpo/v3/optimizations/{id} Create or Update FPO optimization and run it.
FrequenciesApi GetPAFrequencies GET /analytics/engines/pa/v3/frequencies Get PA frequencies
FrequenciesApi GetSPARFrequencies GET /analytics/engines/spar/v3/frequencies Get SPAR frequencies
FrequenciesApi GetVaultFrequencies GET /analytics/engines/vault/v3/frequencies Get Vault frequencies
GroupsApi GetPAGroupingFrequencies GET /analytics/engines/pa/v3/grouping-frequencies Get PA grouping frequencies
GroupsApi GetPAGroups GET /analytics/engines/pa/v3/groups Get PA groups
LinkedPATemplatesApi CreateLinkedPATemplates POST /analytics/engines/pa/v3/linked-templates Create a linked PA template
LinkedPATemplatesApi DeleteLinkedPATemplates DELETE /analytics/engines/pa/v3/linked-templates/{id} Delete a linked PA template.
LinkedPATemplatesApi GetLinkedPATemplates GET /analytics/engines/pa/v3/linked-templates Get linked PA templates
LinkedPATemplatesApi GetLinkedPATemplatesById GET /analytics/engines/pa/v3/linked-templates/{id} Get linked PA template by id
LinkedPATemplatesApi UpdateLinkedPATemplates PUT /analytics/engines/pa/v3/linked-templates/{id} Update a linked PA template
NPOOptimizerApi CancelOptimizationById DELETE /analytics/engines/npo/v3/optimizations/{id} Cancel NPO optimization by id
NPOOptimizerApi GetOptimizationParameters GET /analytics/engines/npo/v3/optimizations/{id} Get NPO optimization parameters by id
NPOOptimizerApi GetOptimizationResult GET /analytics/engines/npo/v3/optimizations/{id}/result Get NPO optimization result by id
NPOOptimizerApi GetOptimizationStatusById GET /analytics/engines/npo/v3/optimizations/{id}/status Get NPO optimization status by id
NPOOptimizerApi PostAndOptimize POST /analytics/engines/npo/v3/optimizations Create and Run NPO optimization
NPOOptimizerApi PutAndOptimize PUT /analytics/engines/npo/v3/optimizations/{id} Create or Update NPO optimization and run it.
PACalculationsApi CancelCalculationById DELETE /analytics/engines/pa/v3/calculations/{id} Cancel PA calculation by id
PACalculationsApi GetAllCalculations GET /analytics/engines/pa/v3/calculations Get all calculations
PACalculationsApi GetCalculationParameters GET /analytics/engines/pa/v3/calculations/{id} Get PA calculation parameters by id
PACalculationsApi GetCalculationStatusById GET /analytics/engines/pa/v3/calculations/{id}/status Get PA calculation status by id
PACalculationsApi GetCalculationUnitResultById GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result Get PA calculation result by id
PACalculationsApi PostAndCalculate POST /analytics/engines/pa/v3/calculations Create and Run PA calculation
PACalculationsApi PutAndCalculate PUT /analytics/engines/pa/v3/calculations/{id} Create or Update PA calculation and run it.
PricingSourcesApi GetPAPricingSources GET /analytics/engines/pa/v3/pricing-sources Get PA pricing sources
PubCalculationsApi CancelCalculationById DELETE /analytics/engines/pub/v3/calculations/{id} Cancel Pub calculation by id
PubCalculationsApi GetAllCalculations GET /analytics/engines/pub/v3/calculations Get all calculations
PubCalculationsApi GetCalculationParameters GET /analytics/engines/pub/v3/calculations/{id} Get Pub calculation parameters by id
PubCalculationsApi GetCalculationStatusById GET /analytics/engines/pub/v3/calculations/{id}/status Get Pub calculation status by id
PubCalculationsApi GetCalculationUnitResultById GET /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result Get Pub calculation result by id
PubCalculationsApi PostAndCalculate POST /analytics/engines/pub/v3/calculations Create and Run Pub calculation
PubCalculationsApi PutAndCalculate PUT /analytics/engines/pub/v3/calculations/{id} Create or Update Pub calculation and run it.
QuantCalculationsApi CancelCalculationById DELETE /analytics/engines/quant/v3/calculations/{id} Cancel Quant calculation by id
QuantCalculationsApi GetAllCalculations GET /analytics/engines/quant/v3/calculations Get all calculations
QuantCalculationsApi GetCalculationParameters GET /analytics/engines/quant/v3/calculations/{id} Get Quant Engine calculation parameters by id
QuantCalculationsApi GetCalculationStatusById GET /analytics/engines/quant/v3/calculations/{id}/status Get Quant Engine calculation status by id
QuantCalculationsApi GetCalculationUnitInfoById GET /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info Get Quant Engine calculation metadata information by id
QuantCalculationsApi GetCalculationUnitResultById GET /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result Get Quant Engine calculation result by id
QuantCalculationsApi PostAndCalculate POST /analytics/engines/quant/v3/calculations Create and Run Quant Engine calculation
QuantCalculationsApi PutAndCalculate PUT /analytics/engines/quant/v3/calculations/{id} Create or update Quant Engine calculation and run it.
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.
StrategyDocumentsApi GetAxiomaEquityStrategyDocuments GET /analytics/engines/axp/v3/strategies/{path} Get Axioma Equity strategy documents and sub-directories in a directory
StrategyDocumentsApi GetAxiomaFIStrategyDocuments GET /analytics/engines/afi/v3/strategies/{path} Get Axioma FI strategy documents and sub-directories in a directory
StrategyDocumentsApi GetBarraStrategyDocuments GET /analytics/engines/bpm/v3/strategies/{path} Get Barra strategy documents and sub-directories in a directory
StrategyDocumentsApi GetFPOStrategyDocuments GET /analytics/engines/fpo/v3/strategies/{path} Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory
StrategyDocumentsApi GetNorthfieldStrategyDocuments GET /analytics/engines/npo/v3/strategies/{path} Get Northfield strategy documents and sub-directories in a directory
TemplatedPAComponentsApi CreateTemplatedPAComponents POST /analytics/engines/pa/v3/templated-components Create templated PA component
TemplatedPAComponentsApi DeleteTemplatedPAComponents DELETE /analytics/engines/pa/v3/templated-components/{id} Delete templated PA component
TemplatedPAComponentsApi GetTemplatedPAComponentById GET /analytics/engines/pa/v3/templated-components/{id} Get templated PA component by id
TemplatedPAComponentsApi GetTemplatedPAComponentsInPath GET /analytics/engines/pa/v3/templated-components Get templated PA components in path
TemplatedPAComponentsApi UpdateTemplatedPAComponents PUT /analytics/engines/pa/v3/templated-components/{id} Update templated PA component
UnlinkedPATemplatesApi CreateUnlinkedPATemplates POST /analytics/engines/pa/v3/unlinked-templates Create unlinked PA template
UnlinkedPATemplatesApi DeleteUnlinkedPATemplates DELETE /analytics/engines/pa/v3/unlinked-templates/{id} Delete unlinked PA template
UnlinkedPATemplatesApi GetDefaultUnlinkedPATemplateTypes GET /analytics/engines/pa/v3/unlinked-templates/template-types Get default unlinked PA template types.
UnlinkedPATemplatesApi GetDetailsType GET /analytics/engines/pa/v3/unlinked-templates/template-types/{id} Get unlinked PA template type details by id.
UnlinkedPATemplatesApi GetUnlinkedPATemplates GET /analytics/engines/pa/v3/unlinked-templates Get unlinked PA templates
UnlinkedPATemplatesApi GetUnlinkedPATemplatesById GET /analytics/engines/pa/v3/unlinked-templates/{id} Get unlinked PA template details by id
UnlinkedPATemplatesApi UpdateUnlinkedPATemplates PUT /analytics/engines/pa/v3/unlinked-templates/{id} Update unlinked PA template
VaultCalculationsApi CancelCalculationById DELETE /analytics/engines/vault/v3/calculations/{id} Cancel Vault calculation by id
VaultCalculationsApi GetAllCalculations GET /analytics/engines/vault/v3/calculations Get all calculations
VaultCalculationsApi GetCalculationParameters GET /analytics/engines/vault/v3/calculations/{id} Get Vault calculation parameters by id
VaultCalculationsApi GetCalculationStatusById GET /analytics/engines/vault/v3/calculations/{id}/status Get Vault calculation status by id
VaultCalculationsApi GetCalculationUnitResultById GET /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result Get Vault calculation result by id
VaultCalculationsApi PostAndCalculate POST /analytics/engines/vault/v3/calculations Create and Run Vault calculation
VaultCalculationsApi PutAndCalculate PUT /analytics/engines/vault/v3/calculations/{id} Create or Update Vault calculation and run it.

Documentation for Models

Documentation for Authorization

Basic

Bearer