Class HistoricalCryptoBarsRequest

Encapsulates request parameters for ListHistoricalBarsAsync(TRequest, CancellationToken) and GetHistoricalBarsAsync(TRequest, CancellationToken) calls.

Inheritance

System.Object

HistoricalRequestBase

HistoricalCryptoBarsRequest

Implements

IHistoricalRequest<HistoricalCryptoBarsRequest, IBar>

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 HistoricalCryptoBarsRequest : HistoricalRequestBase, IHistoricalRequest<HistoricalCryptoBarsRequest, IBar>, IHistoricalRequest

Constructors

| Improve this Doc View Source

HistoricalCryptoBarsRequest(IEnumerable<String>, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(IEnumerable<String> symbols, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
IEnumerable<String>	symbols	Asset symbols for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(IEnumerable<String>, IInclusiveTimeInterval, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(IEnumerable<String> symbols, IInclusiveTimeInterval timeInterval, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
IEnumerable<String>	symbols	Asset symbols for data retrieval.
IInclusiveTimeInterval	timeInterval	Inclusive time interval for filtering items in response.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(IEnumerable<String>, Interval<DateTime>, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(IEnumerable<String> symbols, Interval<DateTime> timeInterval, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(IEnumerable<String>, DateTime, DateTime, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(IEnumerable<String> symbols, DateTime from, DateTime into, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(String, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(String symbol, BarTimeFrame timeFrame)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(String, BarTimeFrame, IInclusiveTimeInterval)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(String symbol, BarTimeFrame timeFrame, IInclusiveTimeInterval timeInterval)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.
IInclusiveTimeInterval	timeInterval	Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(String, BarTimeFrame, Interval<DateTime>)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(String symbol, BarTimeFrame timeFrame, Interval<DateTime> timeInterval)

Parameters

Type	Name	Description
String	symbol	Asset symbol for data retrieval.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.
Alpaca.Markets.Interval<DateTime>	timeInterval	Inclusive time interval for filtering items in response.

| Improve this Doc View Source

HistoricalCryptoBarsRequest(String, DateTime, DateTime, BarTimeFrame)

Creates new instance of HistoricalCryptoBarsRequest object.

Declaration

public HistoricalCryptoBarsRequest(String symbol, DateTime from, DateTime into, BarTimeFrame timeFrame)

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.
Alpaca.Markets.BarTimeFrame	timeFrame	Type of time bars for retrieval.

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

| Improve this Doc View Source

TimeFrame

Gets type of time bars for retrieval.

Declaration

public BarTimeFrame TimeFrame { get; }

Property Value

Type	Description
Alpaca.Markets.BarTimeFrame

Methods

| Improve this Doc View Source

WithExchanges(CryptoExchange[])

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

Declaration

public HistoricalCryptoBarsRequest WithExchanges(params CryptoExchange[] exchanges)

Parameters

Type	Name	Description
CryptoExchange[]	exchanges	Crypto exchanges to add into the list.

Returns

Type	Description
HistoricalCryptoBarsRequest	The new instance of the HistoricalCryptoBarsRequest object.

| Improve this Doc View Source

WithExchanges(IEnumerable<CryptoExchange>)

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

Declaration

public HistoricalCryptoBarsRequest WithExchanges(IEnumerable<CryptoExchange> exchanges)

Parameters

Type	Name	Description
IEnumerable<CryptoExchange>	exchanges	Crypto exchanges to add into the list.

Returns

Type	Description
HistoricalCryptoBarsRequest	The new instance of the HistoricalCryptoBarsRequest object.

Explicit Interface Implementations

| Improve this Doc View Source

IHistoricalRequest<HistoricalCryptoBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()

Declaration

HistoricalCryptoBarsRequest IHistoricalRequest<HistoricalCryptoBarsRequest, IBar>.GetValidatedRequestWithoutPageToken()

Returns

Type	Description
HistoricalCryptoBarsRequest

Implements

IHistoricalRequest<TRequest, TItem>

IHistoricalRequest

Extension Methods

HistoricalRequestBaseExtensions.WithPageSize<TRequest>(TRequest, UInt32)

HistoricalRequestBaseExtensions.WithPageToken<TRequest>(TRequest, String)