Warrants
All operations use QuoteClient.ExecuteAsync.
STOCK_DETAIL and QUOTE_OVERNIGHT require additional market-data entitlements. The server returns a permission error code when an entitlement is missing.
Warrant Filter
Operation
QuoteApiService.WARRANT_FILTER = warrant_filter. Uses server method warrant_filter.
Request
TigerRequest<WarrantFilterResponse>ModelValue: WarrantFilterModel.
Parameters
| SDK property | C# type | API field | SDK default | Required | Constraints |
|---|---|---|---|---|---|
Lang | Language | lang | None (omitted if not set) | no | — |
Account | string (nullable) | account | null | Not applicable | TradeClient uses DefaultAccount when empty |
Symbol | string | symbol | null | Required | — |
Page | Int32 | page | None (omitted if not set) | Optional | Positive integer |
PageSize | Int32 | page_size | None (omitted if not set) | Optional | Positive integer |
SortFieldName | string | sort_field_name | null | Optional | — |
SortDir | SortDir | sort_dir | None (omitted if not set) | Optional | — |
WarrantType | ISet | warrant_type | None (omitted if not set) | Optional | — |
IssuerName | string | issuer_name | null | Optional | — |
ExpireYM | string | expire_ym | null | Optional | — |
State | Int32 | state | None (omitted if not set) | Optional | — |
InOutPrice | ISet | in_out_price | None (omitted if not set) | Optional | — |
LotSize | ISet | lot_size | None (omitted if not set) | Optional | — |
EntitlementRatio | ISet | entitlement_ratio | None (omitted if not set) | Optional | — |
Strike | Range | strike | None (omitted if not set) | Optional | — |
EffectiveLeverage | Range | effective_leverage | None (omitted if not set) | Optional | — |
LeverageRatio | Range | leverage_ratio | None (omitted if not set) | Optional | — |
CallPrice | Range | call_price | None (omitted if not set) | Optional | — |
Volume | Range | volume | None (omitted if not set) | Optional | — |
Premium | Range | premium | None (omitted if not set) | Optional | — |
OutstandingRatio | Range | outstanding_ratio | None (omitted if not set) | Optional | — |
ImpliedVolatility | Range | implied_volatility | None (omitted if not set) | Optional | — |
Return
WarrantFilterResponse inherits TigerResponse; its data property is WarrantFilterItem. Key SDK fields: Page: Int32, TotalPage: Int32, TotalCount: Int32, Items: list of WarrantItem, Bounds: FilterBounds.
Example
TigerRequest<WarrantFilterResponse> request = new()
{
ApiMethodName = QuoteApiService.WARRANT_FILTER,
ModelValue = new WarrantFilterModel { Account = tradeClient.GetDefaultAccount, Symbol = "AAPL", Page = 1, PageSize = 20 }
};
WarrantFilterResponse? response = await quoteClient.ExecuteAsync(request);Response type
WarrantFilterItem? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": {
"items": [
{"symbol": "15678", "name": "AAPL CW A", "underlying": "AAPL.US", "strike": 300.0, "expiry": "2025-12-30", "type": "CALL", "latestPrice": 0.52},
{"symbol": "15679", "name": "AAPL CW B", "underlying": "AAPL.US", "strike": 320.0, "expiry": "2026-03-30", "type": "CALL", "latestPrice": 0.35}
],
"totalCount": 45
}
}Related APIs
See Requests, responses, and operations.
Get Warrant Quotes
Operation
QuoteApiService.WARRANT_REAL_TIME_QUOTE = warrant_real_time_quote. Uses server method warrant_real_time_quote.
Request
TigerRequest<WarrantQuoteResponse>ModelValue: WarrantQuoteModel.
Parameters
| SDK property | C# type | API field | SDK default | Required | Constraints |
|---|---|---|---|---|---|
Lang | Language | lang | None (omitted if not set) | no | — |
Account | string (nullable) | account | null | Not applicable | TradeClient uses DefaultAccount when empty |
Symbols | list of string | symbols | null | Required | Non-empty list |
Return
WarrantQuoteResponse inherits TigerResponse; its data property is WarrantQuoteItem. Key SDK fields: Items: list of WarrantQuote.
Example
TigerRequest<WarrantQuoteResponse> request = new()
{
ApiMethodName = QuoteApiService.WARRANT_REAL_TIME_QUOTE,
ModelValue = new WarrantQuoteModel { Account = tradeClient.GetDefaultAccount, Symbols = new List<string> { "AAPL" } }
};
WarrantQuoteResponse? response = await quoteClient.ExecuteAsync(request);Response type
WarrantQuoteItem? data = response?.Data; // null when response or data is absentRelated APIs
Updated about 12 hours ago