Show / Hide Table of Contents

Class HistoricalCryptoQuotesRequest

Encapsulates request parameters for ListHistoricalQuotesAsync(TRequest, CancellationToken) and GetHistoricalQuotesAsync(TRequest, CancellationToken) calls.

Inheritance
System.Object
HistoricalRequestBase
HistoricalCryptoQuotesRequest
Implements
IHistoricalRequest<HistoricalCryptoQuotesRequest, IQuote>
IHistoricalRequest
Inherited Members
HistoricalRequestBase.Symbol
HistoricalRequestBase.Symbols
HistoricalRequestBase.TimeInterval
HistoricalRequestBase.Pagination
HistoricalRequestBase.SortDirection
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 HistoricalCryptoQuotesRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalCryptoQuotesRequest, IQuote>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(IEnumerable<String>)

Creates new instance of HistoricalCryptoQuotesRequest object.

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

Asset symbols for data retrieval.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(IEnumerable<String>, IInclusiveTimeInterval)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(IEnumerable<String> symbols, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.

IInclusiveTimeInterval timeInterval

Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(IEnumerable<String>, Interval<DateTime>)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(IEnumerable<String> symbols, Interval<DateTime> timeInterval)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.

Alpaca.Markets.Interval<DateTime> timeInterval

Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(IEnumerable<String>, DateTime, DateTime)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(IEnumerable<String> symbols, DateTime from, DateTime into)
Parameters
Type Name Description
IEnumerable<String> symbols

Asset symbols for data retrieval.

DateTime from

Filter data equal to or after this time.

DateTime into

Filter data equal to or before this time.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(String)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(String symbol)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(String, IInclusiveTimeInterval)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(String symbol, IInclusiveTimeInterval timeInterval)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.

IInclusiveTimeInterval timeInterval

Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(String, Interval<DateTime>)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(String symbol, Interval<DateTime> timeInterval)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.

Alpaca.Markets.Interval<DateTime> timeInterval

Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoQuotesRequest(String, DateTime, DateTime)

Creates new instance of HistoricalCryptoQuotesRequest object.

Declaration
public HistoricalCryptoQuotesRequest(String symbol, DateTime from, DateTime into)
Parameters
Type Name Description
String symbol

Asset symbol for data retrieval.

DateTime from

Filter data equal to or after this time.

DateTime into

Filter data equal to or before this time.

Properties

| Improve this Doc View Source

Exchanges

Gets crypto exchanges list for data retrieval (empty list means 'all exchanges').

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

LastPathSegment

Gets the last part of the full REST endpoint URL path.

Declaration
protected override String LastPathSegment { get; }
Property Value
Type Description
String
Overrides
HistoricalRequestBase.LastPathSegment

Methods

| Improve this Doc View Source

WithExchanges(CryptoExchange[])

Creates new instance of HistoricalCryptoQuotesRequest object with the updated Exchanges list.

Declaration
public HistoricalCryptoQuotesRequest WithExchanges(params CryptoExchange[] exchanges)
Parameters
Type Name Description
CryptoExchange[] exchanges

Crypto exchanges to add into the list.

Returns
Type Description
HistoricalCryptoQuotesRequest

The new instance of the HistoricalCryptoQuotesRequest object.

| Improve this Doc View Source

WithExchanges(IEnumerable<CryptoExchange>)

Creates new instance of HistoricalCryptoQuotesRequest object with the updated Exchanges list.

Declaration
public HistoricalCryptoQuotesRequest WithExchanges(IEnumerable<CryptoExchange> exchanges)
Parameters
Type Name Description
IEnumerable<CryptoExchange> exchanges

Crypto exchanges to add into the list.

Returns
Type Description
HistoricalCryptoQuotesRequest

The new instance of the HistoricalCryptoQuotesRequest object.

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<HistoricalCryptoQuotesRequest, IQuote>.GetValidatedRequestWithoutPageToken()

Declaration
HistoricalCryptoQuotesRequest IHistoricalRequest<HistoricalCryptoQuotesRequest, IQuote>.GetValidatedRequestWithoutPageToken()
Returns
Type Description
HistoricalCryptoQuotesRequest

Implements

IHistoricalRequest<TRequest, TItem>
IHistoricalRequest

Extension Methods

HistoricalRequestBaseExtensions.WithPageSize<TRequest>(TRequest, UInt32)
HistoricalRequestBaseExtensions.WithPageToken<TRequest>(TRequest, String)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX