Show / Hide Table of Contents

Interface IOrder

Encapsulates order information from Alpaca REST API.

Namespace: Alpaca.Markets
Assembly: Alpaca.Markets.dll
Syntax
public interface IOrder

Properties

| Improve this Doc View Source

AssetClass

Gets asset class.

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

AssetId

Gets unique asset identifier.

Declaration
Guid AssetId { get; }
Property Value
Type Description
Guid
| Improve this Doc View Source

AverageFillPrice

Gets order average fill price.

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

CancelledAtUtc

Gets order cancellation timestamp in UTC.

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

ClientOrderId

Gets client-side (user specified) order identifier. Client Order IDs must be unique.

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

CreatedAtUtc

Gets order creation timestamp in UTC.

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

ExpiredAtUtc

Gets order expiration timestamp in UTC.

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

FailedAtUtc

Gets order rejection timestamp in UTC.

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

FilledAtUtc

Gets order fill timestamp in UTC.

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

FilledQuantity

Gets filled order quantity (with the fractional part).

Declaration
Decimal FilledQuantity { get; }
Property Value
Type Description
Decimal
| Improve this Doc View Source

HighWaterMark

Gets the current high water mark price for trailing stop orders.

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

IntegerFilledQuantity

Gets filled order quantity (rounded to the nearest integer).

Declaration
Int64 IntegerFilledQuantity { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

IntegerQuantity

Gets original order quantity (rounded to the nearest integer).

Declaration
Int64 IntegerQuantity { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

Legs

Gets legs for this order.

Declaration
IReadOnlyList<IOrder> Legs { get; }
Property Value
Type Description
IReadOnlyList<IOrder>
| Improve this Doc View Source

LimitPrice

Gets order limit price for limit and stop-limit orders.

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

Notional

Gets original notional order quantity (with the fractional part).

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

OrderClass

Gets order class.

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

OrderId

Gets unique server-side order identifier.

Declaration
Guid OrderId { get; }
Property Value
Type Description
Guid
| Improve this Doc View Source

OrderSide

Gets order side (buy or sell).

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

OrderStatus

Gets current order status.

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

OrderType

Gets order type.

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

Quantity

Gets original fractional order quantity (with the fractional part).

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

ReplacedAtUtc

Gets order replacement timestamp in UTC.

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

ReplacedByOrderId

Gets the order ID that this order was replaced by.

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

ReplacesOrderId

Gets the order ID that this order replaces.

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

StopPrice

Gets order stop price for stop and stop-limit orders.

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

SubmittedAtUtc

Gets order submission timestamp in UTC.

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

Symbol

Gets asset symbol.

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

TimeInForce

Gets order duration.

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

TrailOffsetInDollars

Gets the profit taking limit price for advanced order types.

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

TrailOffsetInPercent

Gets the stop loss stop price for advanced order types.

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

UpdatedAtUtc

Gets last order update timestamp in UTC.

Declaration
DateTime? UpdatedAtUtc { get; }
Property Value
Type Description
System.Nullable<DateTime>

Extension Methods

OrderExtensions.GetOrderQuantity(IOrder)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX