FactSet.SDK.DocumentsDistributorCallStreetEvents 0.21.16

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

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

FactSet

Documents Distributor - CallStreet Events client library for .NET

API Version Nuget Apache-2 license

CallStreet Events contains all the Documents Distributor APIs that offer events data such as Events Audio and Near Real-Time Transcripts.

The Events Audio API provides access to historical as well as the latest audio recordings of various company events covered by FactSet. The events include, but are not limited to: earnings calls, conferences, and investor days.

This API also provides relevant metadata such as timestamps and identifiers around each audio file.

The Documents Distributor - Near Real-time Transcripts API enables access to Near Real-time Transcripts provided by CallStreet to time-sensitive clients. This API also provides the relevant speaker metadata along with their confidence scores. This data caters to quant clients interested in building machine learning models.

Clients can leverage this API to perform sentiment analysis through natural language processing or machine learning. It can also be used to complement analysis using FactSet's transcripts service.

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

  • API version: 1.8.3
  • SDK version: 0.21.16
  • 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.DocumentsDistributorCallStreetEvents -v 0.21.16

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.DocumentsDistributorCallStreetEvents -Version 0.21.16

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.DocumentsDistributorCallStreetEvents.Api;
using FactSet.SDK.DocumentsDistributorCallStreetEvents.Client;
using FactSet.SDK.DocumentsDistributorCallStreetEvents.Model;

namespace Example
{
    public static class GetDocsDistributorAudioV1HistoryFilesExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.DocumentsDistributorCallStreetEvents.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 EventsAudioApi(config);
            var paginationLimit = 25;  // int? | Specifies the number of results to return per page. [ Min=0 ; Max=500 ] (optional)  (default to 25)
            var paginationOffset = 0;  // int? | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results. (optional)  (default to 0)
            var year = 2021;  // int? | Specifies the year for which the historical audio recordings and related metadata are to be retrieved. (optional) 
            var trimmed = false;  // bool? | Specifies if trimmed/untrimmed historical audio recordings should be returned. (optional)  (default to false)

            try
            {
                // Retrieve historical audio recordings and related metadata within FactSet coverage.
                EventsAudioHistory result = apiInstance.GetDocsDistributorAudioV1HistoryFiles(paginationLimit, paginationOffset, year, trimmed);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling EventsAudioApi.GetDocsDistributorAudioV1HistoryFiles: " + 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

Class Method HTTP request Description
EventsAudioApi GetDocsDistributorAudioV1HistoryFiles GET /docs-distributor/audio/v1/history-files Retrieve historical audio recordings and related metadata within FactSet coverage.
EventsAudioApi GetDocsDistributorAudioV1ListFiles GET /docs-distributor/audio/v1/list-files Retrieve latest audio recordings and related metadata within FactSet coverage.
NearRealTimeTranscriptsApi GetBulkDocumentsNrtV1Calls GET /bulk-documents/nrt/v1/calls Returns the active calls happening at the moment.
NearRealTimeTranscriptsApi GetBulkDocumentsNrtV1IndexedNrt GET /bulk-documents/nrt/v1/indexed-nrt Returns the indexed transcript data in small increments throughout the duration of an active call.
NearRealTimeTranscriptsApi GetBulkDocumentsNrtV1ListSnippets GET /bulk-documents/nrt/v1/list-snippets Returns the latest transcript snippets from an active call.
NearRealTimeTranscriptsApi GetBulkDocumentsNrtV1Speakerids GET /bulk-documents/nrt/v1/speakerids Returns the latest speakerIds with the confidence scores generated for an active call.

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.21.16 92 7/11/2024
0.21.15 122 4/10/2024
0.21.14 289 10/25/2023
0.21.13 190 8/30/2023
0.21.12 197 8/11/2023
0.21.11 179 7/27/2023
0.21.9 188 6/6/2023
0.21.8 157 5/11/2023
0.21.7 277 3/1/2023
0.21.6 272 2/27/2023
0.21.5 263 2/24/2023
0.21.4 337 12/13/2022
0.21.3 370 11/14/2022
0.21.2 388 11/3/2022
0.21.1 410 8/31/2022
0.21.0 436 7/21/2022
0.20.0 461 5/24/2022
0.9.1 457 2/14/2022
0.9.0 461 2/2/2022

Refer to Changelog on GitHub source repository