Class ListOrdersRequest

Encapsulates request parameters for ListOrdersAsync(ListOrdersRequest, CancellationToken) call.

Inheritance
System.Object
ListOrdersRequest
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 ListOrdersRequest

Properties

| Improve this Doc View Source

LimitOrderNumber

Gets or sets maximum number of orders in response.

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

OrderListSorting

Gets or sets the chronological order of response based on the submission time.

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

OrderSide

Gets or sets side of orders in response (all orders if null).

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

OrderStatusFilter

Gets or sets order status for filtering.

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

RollUpNestedOrders

Gets or sets flag for rolling up multi-leg orders under the Legs property of primary order.

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

Symbols

Gets list of symbols used for filtering the resulting list, if empty - orders for all symbols will be included.

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

TimeInterval

Gets exclusive date time interval for filtering orders in response.

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

Methods

| Improve this Doc View Source

WithInterval(Interval<DateTime>)

Sets time interval for filtering data returned by this request. ///

Declaration
public ListOrdersRequest WithInterval(Interval<DateTime> value)
Parameters
Type Name Description
Alpaca.Markets.Interval<DateTime> value

New filtering interval.
Returns
Type Description
ListOrdersRequest

Request with applied filtering.
| Improve this Doc View Source

WithSymbol(String)

Adds a single symbol item into the Symbols list.

Declaration
public ListOrdersRequest WithSymbol(String symbol)
Parameters
Type Name Description
String symbol

Single symbol name for filtering.
Returns
Type Description
ListOrdersRequest

Fluent interface, returns the original ListOrdersRequest instance.
| Improve this Doc View Source

WithSymbols(IEnumerable<String>)

Adds all items from the symbols list into the Symbols list.

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

List of symbol names for filtering.
Returns
Type Description
ListOrdersRequest

Fluent interface, returns the original ListOrdersRequest instance.