Show / Hide Table of Contents

Class OrderBase

Encapsulates base data for any order types, never used directly by any code.

Inheritance
System.Object
OrderBase
AdvancedOrderBase
SimpleOrderBase
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 abstract class OrderBase

Constructors

| Improve this Doc View Source

OrderBase(OrderBase)

Creates new instance of the OrderBase class.

Declaration
protected OrderBase(OrderBase baseOrder)
Parameters
Type Name Description
OrderBase baseOrder

Base order for getting parameters.

| Improve this Doc View Source

OrderBase(String, OrderQuantity, OrderSide, OrderType)

Creates new instance of the OrderBase class.

Declaration
protected OrderBase(String symbol, OrderQuantity quantity, OrderSide side, OrderType type)
Parameters
Type Name Description
String symbol

Alpaca symbol for order.

Alpaca.Markets.OrderQuantity quantity

Order quantity (absolute value).

OrderSide side

Order side (buy or sell).

OrderType type

Order type (market, limit, stop, stop-limit).

Properties

| Improve this Doc View Source

ClientOrderId

Gets or sets the client order ID. This is a user-specified ID that must be unique if provided.

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

Duration

Gets the new order duration.

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

ExtendedHours

Gets or sets flag indicating that order should be allowed to execute during extended hours trading.

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

PositionIntent

Gets or sets the optional position intent for order placement.

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

Quantity

Gets the new order quantity.

Declaration
public OrderQuantity Quantity { get; }
Property Value
Type Description
Alpaca.Markets.OrderQuantity
| Improve this Doc View Source

Side

Gets the new order side (buy or sell).

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

Symbol

Gets the new order asset symbol.

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

Type

Gets the new order type.

Declaration
public OrderType Type { get; }
Property Value
Type Description
OrderType

Extension Methods

OrderBaseExtensions.WithDuration<TOrder>(TOrder, TimeInForce)
OrderBaseExtensions.WithClientOrderId<TOrder>(TOrder, String)
OrderBaseExtensions.WithExtendedHours<TOrder>(TOrder, Boolean)
OrderBaseExtensions.WithPositionIntent<TOrder>(TOrder, PositionIntent)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX