FactSet.SDK.StreetAccountNews
0.20.3
Prefix Reserved
See the version list below for details.
dotnet add package FactSet.SDK.StreetAccountNews --version 0.20.3
NuGet\Install-Package FactSet.SDK.StreetAccountNews -Version 0.20.3
<PackageReference Include="FactSet.SDK.StreetAccountNews" Version="0.20.3" />
paket add FactSet.SDK.StreetAccountNews --version 0.20.3
#r "nuget: FactSet.SDK.StreetAccountNews, 0.20.3"
// Install FactSet.SDK.StreetAccountNews as a Cake Addin #addin nuget:?package=FactSet.SDK.StreetAccountNews&version=0.20.3 // Install FactSet.SDK.StreetAccountNews as a Cake Tool #tool nuget:?package=FactSet.SDK.StreetAccountNews&version=0.20.3
StreetAccount News client library for .NET
The StreetAccount News API provides access to FactSet's proprietary news provider, StreetAccount. StreetAccount, is a premium real-time market intelligence news service that delivers comprehensive U.S., Canadian, and European coverage (and expanding Asia coverage). All possible sources for corporate news are scanned and key story facts are highlighted and presented in an easy-to-read format.
StreetAccount Filters, Headlines, and Views:
These endpoints allow for the retrieval of news headlines using filters such as Watchlists/Indices/Tickers, Company Filters, Market Topics, Regions, and Sectors. Headlines can also be retrieved based on saved views within the Workstation.
StreetAccount Historical Stories:
These endpoints provide access to historical StreetAccount (SA) news. The API delivers SA stories in XML format based on user-specified date input parameters. Output files are securely available to users through a URL. This API has three endpoints: Request Files, Check Status, and Get Files.
Please note that this API only supports adhoc requests for historical files and does not support real-time files. If real-time push is required, consider using other methods such as SFTP, QNT account, or Azure Storage. Both historical and real-time Street Account news can be delivered via SFTP, QNT account, or Azure Storage.
The files delivered contain both metadata and content body, eliminating the need for multiple requests through multiple services to retrieve all the information.
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 0.20.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.StreetAccountNews -v 0.20.3
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.StreetAccountNews -Version 0.20.3
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- 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.StreetAccountNews.Api;
using FactSet.SDK.StreetAccountNews.Client;
using FactSet.SDK.StreetAccountNews.Model;
namespace Example
{
public static class GetStreetAccountFiltersExample
{
public static async Task Main()
{
var config = new FactSet.SDK.StreetAccountNews.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 FiltersApi(config);
var structured = true; // bool? | Pass structured to generate a structured view of the available filters. (optional)
var flattened = true; // bool? | Pass flattened to generate a structured view of the available filters. (optional)
try
{
// Retrieve all StreetAccount filters
FilterResponse result = apiInstance.GetStreetAccountFilters(structured, flattened);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling FiltersApi.GetStreetAccountFilters: " + 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/research/news/v0
Class | Method | HTTP request | Description |
---|---|---|---|
FiltersApi | GetStreetAccountFilters | GET /streetaccount/filters | Retrieve all StreetAccount filters |
HeadlinesApi | GetStreetAccountHeadlines | POST /streetaccount/headlines | Retrieve StreetAccount headlines for given filters |
HeadlinesApi | GetStreetAccountHeadlinesByView | POST /streetaccount/views/{id}/headlines | Retrieve StreetAccount headlines for given view |
StreetAccountHistoricalStoriesApi | StreetaccountHistoricalCheckStatusGet | GET /streetaccount/historical/check-status | Returns the status and percentage of completion for the requested jobID |
StreetAccountHistoricalStoriesApi | StreetaccountHistoricalGetFilesGet | GET /streetaccount/historical/get-files | Returns the StreetAccount XML files for the specified date range |
StreetAccountHistoricalStoriesApi | StreetaccountHistoricalRequestFilesGet | GET /streetaccount/historical/request-files | Returns the jobID |
ViewsApi | CreateStreetAccountView | POST /streetaccount/views/{id} | Creates and saves a StreetAccount view |
ViewsApi | DeleteStreetAccountView | DELETE /streetaccount/views/{id} | Deletes an existing StreetAccount view |
ViewsApi | EditStreetAccountView | PUT /streetaccount/views/{id} | Edits and saves an existing StreetAccount view |
ViewsApi | GetStreetAccountViews | GET /streetaccount/views | Retrieves StreetAccount search views |
Documentation for Models
- Model.Checkstatus
- Model.CheckstatusResponse
- Model.CreateEditDeleteViewResponse
- Model.CreateEditDeleteViewResponseData
- Model.CreateEditDeleteViewResponseDataMessage
- Model.CreateOrEditViewBody
- Model.CreateOrEditViewBodyData
- Model.CreateOrEditViewTickers
- Model.Error
- Model.ErrorObject
- Model.FilterResponse
- Model.FilterResponseData
- Model.FlattenedFilters
- Model.FlattenedFiltersCategoriesObject
- Model.FlattenedFiltersRegionsObject
- Model.FlattenedFiltersSectorsObject
- Model.FlattenedFiltersTopicsObject
- Model.FlattenedFiltersWatchlistsObject
- Model.Getfiles
- Model.GetfilesResponse
- Model.IsPartialOne
- Model.MetaOne
- Model.PaginationOne
- Model.RequestfilesResponse
- Model.SaHeadlinesRequest
- Model.SaHeadlinesRequestByView
- Model.SaHeadlinesRequestByViewData
- Model.SaHeadlinesRequestData
- Model.SaHeadlinesRequestDataSearchDate
- Model.SaHeadlinesRequestMeta
- Model.SaHeadlinesRequestMetaPagination
- Model.SaHeadlinesRequestTickersObject
- Model.SearchResponse
- Model.SearchResponseArrayObject
- Model.SearchResponseData
- Model.SearchResponseMeta
- Model.SearchResponseMetaPagination
- Model.StreetAccountStatus
- Model.StructuredFilters
- Model.StructuredFiltersCategoriesObject
- Model.StructuredFiltersChildrenObject
- Model.StructuredFiltersRegionsObject
- Model.StructuredFiltersSectorsObject
- Model.StructuredFiltersTopicsObject
- Model.StructuredFiltersWatchlistsObject
- Model.Views
- Model.ViewsObject
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
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 | Versions 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. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Refer to Changelog on GitHub source repository