Analytics API Engines .NET SDK

Use this library to integrate with FactSet's Analytics APIs. Below APIs are supported by this SDK.

• PA Engine API
• SPAR Engine API
• Vault API

Contents

• auto-generated-sdk - Auto-generated code using Analytics API Engines SDK Generator
• examples - Sample project containing code snippets to quickly get started with the SDK
• tests - Integration tests

Requirements

• .Net Standard 2.0 or higher

Installation

• Install with Package Manager Console:

  Install-Package FactSet.AnalyticsAPI.Engines

• Install with NuGet:

  nuget install FactSet.AnalyticsAPI.Engines

• Install with .NET Core:

  dotnet add package FactSet.AnalyticsAPI.Engines

• Alternatively, download or clone this repository, build the SDK and add it as reference to your project:

  git clone https://github.com/factset/analyticsapi-engines-dotnet-sdk.git
  cd auto-generated-sdk
  dotnet build auto-generated-sdk/src/FactSet.AnalyticsAPI.Engines

Usage

Refer examples project for sample code snippets to quickly get started with the SDK

Tests

First, clone the repo locally and cd into the directory.

git clone https://github.com/factset/analyticsapi-engines-dotnet-sdk.git
cd tests

Before running the tests, set the below environment variables. Use the Developer Portal Manage API Keys page to get these values.

export ANALYTICS_API_USERNAME_SERIAL = "username-serial"
export ANALYTICS_API_PASSWORD = "apikey"

Run the tests with below command.

dotnet test

Contributing

• Files in auto-generated-sdk directory are auto-generated and should not be manually edited here. Refer Analytics API Engines SDK Generator for instructions on how to modify these files.
• Projects examples and tests are open to enhancements and bug fixes. Please create a pull requests with the proposed changes.