FactSet.SDK.PAEngine 2.0.1

Prefix Reserved
dotnet add package FactSet.SDK.PAEngine --version 2.0.1                
NuGet\Install-Package FactSet.SDK.PAEngine -Version 2.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FactSet.SDK.PAEngine" Version="2.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FactSet.SDK.PAEngine --version 2.0.1                
#r "nuget: FactSet.SDK.PAEngine, 2.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FactSet.SDK.PAEngine as a Cake Addin
#addin nuget:?package=FactSet.SDK.PAEngine&version=2.0.1

// Install FactSet.SDK.PAEngine as a Cake Tool
#tool nuget:?package=FactSet.SDK.PAEngine&version=2.0.1                

FactSet

PA Engine client library for .NET

API Version Nuget Apache-2 license

Allow clients to fetch Analytics through APIs.

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

  • API version: 3.15.6
  • SDK version: 2.0.1
  • 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.PAEngine -v 2.0.1

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.Protobuf.Stach.Extensions
nuget install FactSet.SDK.PAEngine -Version 2.0.1

Usage

  1. Generate authentication credentials.
  2. Setup .NET Standard 2.0 compatible environment.
  3. Install dependencies.
  4. 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.PAEngine.Api;
using FactSet.SDK.PAEngine.Client;
using FactSet.SDK.PAEngine.Model;

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

            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
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
CurrenciesApi GetCurrencies GET /analytics/lookups/v3/currencies Get currencies
DatesApi ConvertPADatesToAbsoluteFormat GET /analytics/engines/pa/v3/dates Convert PA dates to absolute format
DocumentsApi GetPA3Documents GET /analytics/engines/pa/v3/documents/{path} Get PA3 documents and sub-directories in a directory
FrequenciesApi GetPAFrequencies GET /analytics/engines/pa/v3/frequencies Get PA 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
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
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

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 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.1 63 8/5/2024
2.0.0 66 7/24/2024
1.0.4 84 7/11/2024
1.0.3 130 4/10/2024
1.0.2 119 3/25/2024
1.0.1 211 12/15/2023
1.0.0 163 10/20/2023
0.21.10 154 9/12/2023
0.21.9 136 8/30/2023
0.21.8 146 8/14/2023
0.21.7 166 6/6/2023
0.21.6 172 5/11/2023
0.21.5 234 3/1/2023
0.21.4 246 2/24/2023
0.21.2 432 8/31/2022
0.21.0 413 7/21/2022
0.20.0 432 5/24/2022
0.9.1 432 2/14/2022
0.9.0 438 2/2/2022
0.8.11 136 8/30/2023
0.8.10 124 8/11/2023
0.8.9 153 6/6/2023
0.8.8 153 5/11/2023
0.8.7 233 3/1/2023
0.8.6 246 2/24/2023
0.8.5 390 8/31/2022
0.8.3 410 7/21/2022
0.8.2 430 5/24/2022
0.8.1 430 2/14/2022
0.8.0 432 2/2/2022

Refer to Changelog on GitHub source repository