Class NewsArticlesRequest

Encapsulates request parameters for call.

Inheritance
System.Object
NewsArticlesRequest
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public sealed class NewsArticlesRequest : IHistoricalRequest<NewsArticlesRequest, INewsArticle>, IHistoricalRequest

Constructors

| Improve this Doc View Source

NewsArticlesRequest()

Creates new instance of NewsArticlesRequest object.

Declaration
public NewsArticlesRequest()
| Improve this Doc View Source

NewsArticlesRequest(IEnumerable<String>)

Creates new instance of NewsArticlesRequest object.

Declaration
public NewsArticlesRequest(IEnumerable<String> symbols)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.

Properties

| Improve this Doc View Source

ExcludeItemsWithoutContent

Gets or sets flag for excluding news articles that do not contain Content property value (just Headline and Summary values).

Declaration
public Boolean? ExcludeItemsWithoutContent { get; set; }
Property Value
Type Description
System.Nullable<Boolean>
| Improve this Doc View Source

Pagination

Gets the pagination parameters for the request (page size and token).

Declaration
public Pagination Pagination { get; }
Property Value
Type Description
Pagination
| Improve this Doc View Source

SendFullContentForItems

Gets or sets flag for sending Content property value for each news article.

Declaration
public Boolean? SendFullContentForItems { get; set; }
Property Value
Type Description
System.Nullable<Boolean>
| Improve this Doc View Source

SortDirection

Gets or sets articles sorting (by UpdatedAtUtc property) direction.

Declaration
public SortDirection? SortDirection { get; set; }
Property Value
Type Description
System.Nullable<SortDirection>
| Improve this Doc View Source

Symbols

Gets assets names list for data retrieval.

Declaration
public IReadOnlyCollection<String> Symbols { get; }
Property Value
Type Description
IReadOnlyCollection<String>
| Improve this Doc View Source

TimeInterval

Gets or sets inclusive date interval for filtering items in response.

Declaration
public Interval<DateTime>? TimeInterval { get; set; }
Property Value
Type Description
System.Nullable<Alpaca.Markets.Interval<DateTime>>

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<NewsArticlesRequest, INewsArticle>.GetValidatedRequestWithoutPageToken()

Declaration
NewsArticlesRequest IHistoricalRequest<NewsArticlesRequest, INewsArticle>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
NewsArticlesRequest

Implements

Extension Methods