FactSet.SDK.FactSetTickHistory 0.32.3

Prefix Reserved
dotnet add package FactSet.SDK.FactSetTickHistory --version 0.32.3                
NuGet\Install-Package FactSet.SDK.FactSetTickHistory -Version 0.32.3                
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.FactSetTickHistory" Version="0.32.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FactSet.SDK.FactSetTickHistory --version 0.32.3                
#r "nuget: FactSet.SDK.FactSetTickHistory, 0.32.3"                
#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.FactSetTickHistory as a Cake Addin
#addin nuget:?package=FactSet.SDK.FactSetTickHistory&version=0.32.3

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

FactSet

FactSet Tick History client library for .NET

API Version Nuget Apache-2 license

Tick History provides dynamic access to historical tick data for a specific security for specific dates or date range.

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

  • API version: 2.3.0
  • SDK version: 0.32.3
  • 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.SDK.FactSetTickHistory -v 0.32.3

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetTickHistory -Version 0.32.3

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.Net;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetTickHistory.Api;
using FactSet.SDK.FactSetTickHistory.Client;
using FactSet.SDK.FactSetTickHistory.Model;

namespace Example
{
    public static class GetLevel1FileStatusExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetTickHistory.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 Level1Api(config);
            var id = "id_example";  // string | id returned by files create endpoint to poll and collect status of the query

            try
            {
                // Returns the status of the ID
                Level1Api.GetLevel1FileStatusResponseWrapper result = apiInstance.GetLevel1FileStatus(id);

                switch (result.StatusCode)
                {

                    case (HttpStatusCode)201:
                        Console.WriteLine(result.Response201);
                        break;

                    case (HttpStatusCode)202:
                        Console.WriteLine(result.Response202);
                        break;

                }
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling Level1Api.GetLevel1FileStatus: " + 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;

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/tick-history/v2

Class Method HTTP request Description
Level1Api GetLevel1FileStatus GET /level1/files/status Returns the status of the ID
Level1Api GetMinutebarsFileStatus GET /level1/files/minute-bars/status Returns the status of the ID
Level1Api GetMinutebarsFiles GET /level1/files/minute-bars/get Returns the Minute bars data in files requested in the /create endpoint
Level1Api GetTickHistoryLevel1Files GET /level1/files/get Returns the tick-by-tick data in files requested in the /create endpoint
Level1Api RequestMinutebarsFiles POST /level1/files/minute-bars/create Requests the creation of Minute bars file
Level1Api RequestTickHistoryCoverage GET /level1/coverage Returns the coverage for the requested ticker/isin along with other response fields for Level1 data.
Level1Api RequestTickHistoryLevel1Files POST /level1/files/create Requests the creation of tick-by-tick file

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
0.32.3 95 7/24/2024
0.32.2 77 7/11/2024
0.32.1 107 4/29/2024
0.32.0 117 4/19/2024
0.31.1 114 4/10/2024
0.31.0 106 2/19/2024
0.30.3 279 10/25/2023
0.30.2 150 9/12/2023
0.30.1 138 8/30/2023
0.30.0 119 8/24/2023
0.22.10 79 7/11/2024
0.22.9 110 4/10/2024
0.22.8 127 10/25/2023
0.22.7 134 8/30/2023
0.22.6 157 8/11/2023
0.22.5 124 6/6/2023
0.22.4 160 5/11/2023
0.22.3 189 4/12/2023
0.22.2 236 3/1/2023
0.22.1 248 2/24/2023
0.22.0 255 2/7/2023
0.21.1 365 8/31/2022
0.21.0 378 7/21/2022
0.20.0 406 5/24/2022
0.9.1 413 2/14/2022
0.9.0 411 2/2/2022
0.0.2 163 8/11/2023
0.0.1 138 7/11/2023

Refer to Changelog on GitHub source repository