Order Queries

State-changing operations must prevent duplicate submission.

In TradeOrder, AvgFillPrice is the volume-weighted average of fill prices and excludes commissions and other fees. RealizedPnl is realized P&L. Commission and Gst are returned separately. Refer to the account statement for the exact calculation basis and currency. Commission, Gst, AvgFillPrice, and RealizedPnl are non-nullable Double properties in this SDK, so they cannot distinguish a missing field from an explicit 0. ReplaceStatus=REPLACED is final modify success and FAILED is failure; CancelStatus=RECEIVED only means the cancellation request was accepted, while the final result comes from order Status.

Get Order Number

Operation

TradeApiService.ORDER_NO = order_no. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<TigerDictResponse>

ModelValue: TradeModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno

Return

TigerDictResponse inherits TigerResponse; its data property is Dictionary<string, object>.

Example

TigerRequest<TigerDictResponse> request = new()
{
    ApiMethodName = TradeApiService.ORDER_NO,
    ModelValue = new TradeModel { Account = tradeClient.GetDefaultAccount }
};
TigerDictResponse? response = await tradeClient.ExecuteAsync(request);

Response type

Dictionary<string, object>? data = response?.Data; // null when response or data is absent

Data fields

TypeSDK contract
Dictionary<string, object>Dynamic dictionary; the SDK defines no fixed keys or nested object types.

Rate limit

Base tier: 120 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Orders

Operation

TradeApiService.ORDERS = orders. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<OrderBatchResponse>

ModelValue: QueryOrderModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno
IdInt64idCLR default; omitted during serializationRequired
IsShowChargesBooleanshow_chargesCLR default; omitted during serializationOptional
SegTypeSegmentTypeseg_typeCLR default; omitted during serializationOptional
SecTypeSecTypesec_typeCLR default; omitted during serializationOptional
MarketMarketmarketCLR default; omitted during serializationOptionalEnum value
SymbolstringsymbolnullRequired
Rightstring (nullable)rightnullOptional
Strikestring (nullable)strikenullOptional
Expirystring (nullable)expirynullOptional
StartDateInt64start_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
EndDateInt64end_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
LimitInt32limit100OptionalPositive integer
SortByOrderSortBysort_byCLR default; omitted during serializationOptionalOmnibus accounts only. LATEST_CREATED: sorts descending and filters by order creation/submission time; LATEST_STATUS_UPDATED: sorts descending and filters by the most recent order status update time.
PageTokenstringpage_tokennullOptional

Time range: SortBy selects both the ordering and the timestamp filtered by StartDate and EndDate: LATEST_CREATED uses the order creation/submission time, while LATEST_STATUS_UPDATED uses the most recent order status update time. With NONE or an omitted SortBy, the C# serializer sends no sort_by field and the omnibus service defaults to LATEST_CREATED. StartDate and EndDate are optional; an omitted bound adds no filter for that side. The interface has no maximum time span, but pagination and per-response result limits still apply. Use a reasonably bounded range.

Return

OrderBatchResponse inherits TigerResponse; its data property is OrderBatchItem.

Example

TigerRequest<OrderBatchResponse> request = new()
{
    ApiMethodName = TradeApiService.ORDERS,
    ModelValue = new QueryOrderModel { Account = tradeClient.GetDefaultAccount, Id = 1234567890L, SegType = SegmentType.SEC, SecType = SecType.STK, Market = Market.US }
};
OrderBatchResponse? response = await tradeClient.ExecuteAsync(request);

Response type

OrderBatchItem? data = response?.Data; // null when response or data is absent

Data fields (OrderBatchItem)

FieldAPI fieldC# typeDescription
NextPageTokennextPageTokenstringToken for the next page.
ItemsitemsList<TradeOrder>Order records.

Each TradeOrder in Items:

FieldAPI fieldC# typeDescription
SymbolsymbolstringContract symbol.
MarketmarketstringMarket.
SecTypesecTypestringSecurity type.
CurrencycurrencystringTrading currency.
ExpiryexpirystringContract expiry date.
StrikestrikestringOption strike price.
RightrightstringOption right.
MultipliermultiplierdoubleContract multiplier.
IdentifieridentifierstringContract identifier.
IdidInt64Order identifier.
OrderIdorderIdintOrder number.
ExternalIdexternalIdstringExternal order identifier.
ParentIdparentIdInt64Parent order identifier.
AccountaccountstringAccount identifier.
ActionactionstringOrder action.
OrderTypeorderTypestringOrder type.
LimitPricelimitPriceDoubleLimit price.
AuxPriceauxPriceDoubleAuxiliary price.
TrailingPercenttrailingPercentDoubleTrailing percentage.
TotalQuantitytotalQuantityInt64Total order quantity.
TotalQuantityScaletotalQuantityScaleInt32Decimal scale for total quantity.
FilledQuantityfilledQuantityInt64Filled quantity.
FilledQuantityScalefilledQuantityScaleInt32Decimal scale for filled quantity.
TotalCashAmounttotalCashAmountDoubleTotal cash amount.
FilledCashAmountfilledCashAmountDoubleFilled cash amount.
RefundCashAmountrefundCashAmountDoubleRefunded cash amount.
LastFillPricelastFillPriceDoubleLast fill price.
AvgFillPriceavgFillPriceDoubleAverage fill price.
TimeInForcetimeInForcestringTime-in-force instruction.
ExpireTimeexpireTimeInt64Order expiry timestamp.
GoodTillDategoodTillDatestringGood-until date.
OutsideRthoutsideRthBooleanWhether execution outside regular trading hours is allowed.
TradingSessionTypetradingSessionTypestringTrading session type.
CommissioncommissionDoubleCommission amount.
GstgstDoubleGoods and Services Tax amount.
RealizedPnlrealizedPnlDoubleRealized profit or loss.
RemarkremarkstringOrder remark.
LiquidationliquidationBooleanWhether this is a forced liquidation order.
TriggerStatustriggerStatusstringTrigger status.
OpenTimeopenTimeInt64Order open timestamp.
UpdateTimeupdateTimeInt64Order update timestamp.
LatestTimelatestTimeInt64Latest order timestamp.
NamenamestringContract name.
LatestPricelatestPriceDoubleLatest price.
AttrDescattrDescstringOrder attribute description.
UserMarkuserMarkstringUser-defined order mark.
AttrListattrListList<string>Order attributes.
OcaGroupIdocaGroupIdintOne-cancels-all group identifier.
ComboLegscomboLegsstringCombination-leg information.
AllocAccountsallocAccountsList<string>Allocated account identifiers.
AllocSharesallocSharesList<Double>Allocated share quantities.
AlgoStrategyalgoStrategystringAlgorithmic strategy.
AlgoParametersalgoParametersList<TagValue>Algorithmic strategy parameters.
StatusstatusOrderStatusOrder status.
ReplaceStatusreplaceStatusstringOrder replacement status.
CancelStatuscancelStatusstringOrder cancellation status.
SourcesourcestringOrder source.
DiscountdiscountInt32Discount value.
CanModifycanModifyBooleanWhether the order can be modified.
CanCancelcanCancelBooleanWhether the order can be canceled.
IsOpenisOpenBooleanWhether the order is open.
ComboTypecomboTypestringCombination order type.
ComboTypeDesccomboTypeDescstringCombination order type description.
LegslegsList<OrderLeg>Multi-leg order details.

Each AlgoParameters item is a TagValue:

FieldAPI fieldC# typeDescription
TagtagstringParameter name.
Valuevaluestring?Parameter value.

Each Legs item is an OrderLeg:

FieldAPI fieldC# typeDescription
MarketmarketstringMarket.
CurrencycurrencystringTrading currency.
MultipliermultiplierDoubleContract multiplier.
TotalQuantitytotalQuantityDoubleTotal leg quantity.
FilledQuantityfilledQuantityDoubleFilled leg quantity.
AvgFilledPriceavgFilledPriceDoubleAverage leg fill price.
CreatedAtcreatedAtInt64Creation timestamp.
UpdatedAtupdatedAtInt64Last update timestamp.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "items": [
      {
        "id": 123456,
        "orderId": 789012,
        "symbol": "AAPL",
        "action": "BUY",
        "orderType": "LMT",
        "totalQuantity": 100,
        "filledQuantity": 100,
        "limitPrice": 150.0,
        "avgFillPrice": 149.95,
        "status": "Filled",
        "openTime": 1785441600000,
        "latestTime": 1785441650000
      }
    ]
  }
}

Rate limit

Base tier: 120 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Active Orders

Operation

TradeApiService.ACTIVE_ORDERS = active_orders. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<OrderBatchResponse>

ModelValue: QueryOrderModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno
IdInt64idCLR default; omitted during serializationRequired
IsShowChargesBooleanshow_chargesCLR default; omitted during serializationOptional
SegTypeSegmentTypeseg_typeCLR default; omitted during serializationOptional
SecTypeSecTypesec_typeCLR default; omitted during serializationOptional
MarketMarketmarketCLR default; omitted during serializationOptionalEnum value
SymbolstringsymbolnullRequired
Rightstring (nullable)rightnullOptional
Strikestring (nullable)strikenullOptional
Expirystring (nullable)expirynullOptional
StartDateInt64start_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
EndDateInt64end_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
LimitInt32limit100OptionalPositive integer
SortByOrderSortBysort_byCLR default; omitted during serializationOptionalOmnibus accounts only. LATEST_CREATED: sorts descending and filters by order creation/submission time; LATEST_STATUS_UPDATED: sorts descending and filters by the most recent order status update time. With NONE or omission, no field is serialized and the service defaults to LATEST_CREATED.
PageTokenstringpage_tokennullOptional

Return

OrderBatchResponse inherits TigerResponse; its data property is OrderBatchItem.

Example

TigerRequest<OrderBatchResponse> request = new()
{
    ApiMethodName = TradeApiService.ACTIVE_ORDERS,
    ModelValue = new QueryOrderModel { Account = tradeClient.GetDefaultAccount, Id = 1234567890L, SegType = SegmentType.SEC, SecType = SecType.STK, Market = Market.US }
};
OrderBatchResponse? response = await tradeClient.ExecuteAsync(request);

Response type

OrderBatchItem? data = response?.Data; // null when response or data is absent

Data fields

FieldAPI fieldC# typeDescription
NextPageTokennextPageTokenstringToken for the next page.
ItemsitemsList<TradeOrder>Order records.

See Order-list Data fields for every TradeOrder field.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "items": [
      {
        "id": 123457,
        "orderId": 789013,
        "symbol": "TSLA",
        "action": "BUY",
        "orderType": "LMT",
        "totalQuantity": 50,
        "filledQuantity": 0,
        "limitPrice": 280.0,
        "status": "PendingSubmit",
        "openTime": 1785527000000
      }
    ]
  }
}

Rate limit

Base tier: 120 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Inactive Orders

Operation

TradeApiService.INACTIVE_ORDERS = inactive_orders. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<OrderBatchResponse>

ModelValue: QueryOrderModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno
IdInt64idCLR default; omitted during serializationRequired
IsShowChargesBooleanshow_chargesCLR default; omitted during serializationOptional
SegTypeSegmentTypeseg_typeCLR default; omitted during serializationOptional
SecTypeSecTypesec_typeCLR default; omitted during serializationOptional
MarketMarketmarketCLR default; omitted during serializationOptionalEnum value
SymbolstringsymbolnullRequired
Rightstring (nullable)rightnullOptional
Strikestring (nullable)strikenullOptional
Expirystring (nullable)expirynullOptional
StartDateInt64start_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
EndDateInt64end_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
LimitInt32limit100OptionalPositive integer
SortByOrderSortBysort_byCLR default; omitted during serializationOptionalOmnibus accounts only. LATEST_CREATED: sorts descending and filters by order creation/submission time; LATEST_STATUS_UPDATED: sorts descending and filters by the most recent order status update time. With NONE or omission, no field is serialized and the service defaults to LATEST_CREATED.
PageTokenstringpage_tokennullOptional

Return

OrderBatchResponse inherits TigerResponse; its data property is OrderBatchItem.

Example

TigerRequest<OrderBatchResponse> request = new()
{
    ApiMethodName = TradeApiService.INACTIVE_ORDERS,
    ModelValue = new QueryOrderModel { Account = tradeClient.GetDefaultAccount, Id = 1234567890L, SegType = SegmentType.SEC, SecType = SecType.STK, Market = Market.US }
};
OrderBatchResponse? response = await tradeClient.ExecuteAsync(request);

Response type

OrderBatchItem? data = response?.Data; // null when response or data is absent

Data fields

FieldAPI fieldC# typeDescription
NextPageTokennextPageTokenstringToken for the next page.
ItemsitemsList<TradeOrder>Order records.

See Order-list Data fields for every TradeOrder field.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "items": [
      {
        "id": 123456,
        "orderId": 789012,
        "symbol": "AAPL",
        "action": "BUY",
        "orderType": "LMT",
        "totalQuantity": 100,
        "filledQuantity": 100,
        "limitPrice": 150.0,
        "avgFillPrice": 149.95,
        "status": "Filled"
      }
    ]
  }
}

Rate limit

Base tier: 120 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Filled Orders

Operation

TradeApiService.FILLED_ORDERS = filled_orders. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<OrderBatchResponse>

ModelValue: QueryOrderModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno
IdInt64idCLR default; omitted during serializationRequired
IsShowChargesBooleanshow_chargesCLR default; omitted during serializationOptional
SegTypeSegmentTypeseg_typeCLR default; omitted during serializationOptional
SecTypeSecTypesec_typeCLR default; omitted during serializationOptional
MarketMarketmarketCLR default; omitted during serializationOptionalEnum value
SymbolstringsymbolnullRequired
Rightstring (nullable)rightnullOptional
Strikestring (nullable)strikenullOptional
Expirystring (nullable)expirynullOptional
StartDateInt64start_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
EndDateInt64end_dateCLR default; omitted during serializationOptionalTimestamp or date format; filter against the timestamp selected by SortBy and maintain chronological order
LimitInt32limit100OptionalPositive integer
SortByOrderSortBysort_byCLR default; omitted during serializationOptionalOmnibus accounts only. LATEST_CREATED: sorts descending and filters by order creation/submission time; LATEST_STATUS_UPDATED: sorts descending and filters by the most recent order status update time. With NONE or omission, no field is serialized and the service defaults to LATEST_CREATED.
PageTokenstringpage_tokennullOptional

Return

OrderBatchResponse inherits TigerResponse; its data property is OrderBatchItem.

Example

TigerRequest<OrderBatchResponse> request = new()
{
    ApiMethodName = TradeApiService.FILLED_ORDERS,
    ModelValue = new QueryOrderModel { Account = tradeClient.GetDefaultAccount, Id = 1234567890L, SegType = SegmentType.SEC, SecType = SecType.STK, Market = Market.US }
};
OrderBatchResponse? response = await tradeClient.ExecuteAsync(request);

Response type

OrderBatchItem? data = response?.Data; // null when response or data is absent

Data fields

FieldAPI fieldC# typeDescription
NextPageTokennextPageTokenstringToken for the next page.
ItemsitemsList<TradeOrder>Order records.

See Order-list Data fields for every TradeOrder field.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "items": [
      {
        "id": 123456,
        "orderId": 789012,
        "symbol": "AAPL",
        "action": "BUY",
        "orderType": "LMT",
        "totalQuantity": 100,
        "filledQuantity": 100,
        "limitPrice": 150.0,
        "avgFillPrice": 149.95,
        "status": "Filled"
      }
    ]
  }
}

Rate limit

Base tier: 120 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Transactions

Operation

TradeApiService.ORDER_TRANSACTIONS = order_transactions. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<OrderTransactionsResponse>

ModelValue: OrderTransactionsModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullAuto-filled if emptyIf empty, TradeClient injects TigerConfig.DefaultAccount; validation fails if it remains empty
SecretKeystringsecret_keynullno
OrderIdInt64order_idCLR default; omitted during serializationOptional
SecTypeSecTypesec_typeCLR default; omitted during serializationOptional
SymbolstringsymbolnullRequired
Rightstring (nullable)rightnullOptional
Strikestring (nullable)strikenullOptional
Expirystring (nullable)expirynullOptional
StartDateInt64start_dateCLR default; omitted during serializationOptionalTimestamp or date format; maintain chronological order
EndDateInt64end_dateCLR default; omitted during serializationOptionalTimestamp or date format; maintain chronological order
LimitInt32limit20OptionalPositive integer

Return

OrderTransactionsResponse inherits TigerResponse; its data property is OrderTransactionsItem.

Example

TigerRequest<OrderTransactionsResponse> request = new()
{
    ApiMethodName = TradeApiService.ORDER_TRANSACTIONS,
    ModelValue = new OrderTransactionsModel { Account = tradeClient.GetDefaultAccount, OrderId = 1234567890L, SecType = SecType.STK, Symbol = "AAPL", Strike = "200" }
};
OrderTransactionsResponse? response = await tradeClient.ExecuteAsync(request);

Response type

OrderTransactionsItem? data = response?.Data; // null when response or data is absent

Data fields (OrderTransactionsItem)

FieldAPI fieldC# typeDescription
ItemsitemsList<OrderTransactions>Order transaction records.

Each OrderTransactions in Items:

FieldAPI fieldC# typeDescription
IdidInt64Order transaction identifier.
OrderIdorderIdInt64Order identifier.
AccountIdaccountIdstringAccount identifier.
SecTypesecTypestringSecurity type.
MarketmarketstringMarket.
CurrencycurrencystringTrading currency.
SymbolsymbolstringContract symbol.
ExpiryexpirystringContract expiry date.
StrikestrikestringOption strike price.
RightrightstringOption right.
ActionactionstringOrder action.
FilledQuantityfilledQuantityInt64Filled quantity.
FilledPricefilledPriceDoubleFill price.
FilledAmountfilledAmountDoubleFilled amount.
TransactedAttransactedAtstringTransaction time string.
TransactionTimetransactionTimeInt64Transaction timestamp.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": [
    {
      "id": 123456,
      "orderId": 789012,
      "symbol": "AAPL",
      "action": "BUY",
      "filledQuantity": 100,
      "filledPrice": 149.95,
      "transactionTime": 1785441650000
    }
  ]
}

Rate limit

Base tier: 60 requests per minute.

Related APIs

See Requests, responses, and operations.


Did this page help you?