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. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<WarrantFilterResponse>

ModelValue: WarrantFilterModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullNot applicableInherited field; QuoteClient does not inject TigerConfig.DefaultAccount, and null is omitted during serialization
SymbolstringsymbolnullRequired
PageInt32pageCLR default; omitted during serializationOptionalPositive integer
PageSizeInt32page_sizeCLR default; omitted during serializationOptionalPositive integer
SortFieldNamestringsort_field_namenullOptional
SortDirSortDirsort_dirCLR default; omitted during serializationOptional
WarrantTypeISetwarrant_typeCLR default; omitted during serializationOptional
IssuerNamestringissuer_namenullOptional
ExpireYMstringexpire_ymnullOptional
StateInt32stateCLR default; omitted during serializationOptional
InOutPriceISetin_out_priceCLR default; omitted during serializationOptional
LotSizeISetlot_sizeCLR default; omitted during serializationOptional
EntitlementRatioISetentitlement_ratioCLR default; omitted during serializationOptional
StrikeRangestrikeCLR default; omitted during serializationOptional
EffectiveLeverageRangeeffective_leverageCLR default; omitted during serializationOptional
LeverageRatioRangeleverage_ratioCLR default; omitted during serializationOptional
CallPriceRangecall_priceCLR default; omitted during serializationOptional
VolumeRangevolumeCLR default; omitted during serializationOptional
PremiumRangepremiumCLR default; omitted during serializationOptional
OutstandingRatioRangeoutstanding_ratioCLR default; omitted during serializationOptional
ImpliedVolatilityRangeimplied_volatilityCLR default; omitted during serializationOptional

Return

WarrantFilterResponse inherits TigerResponse; its Data is WarrantFilterItem.

Response data structure: WarrantFilterItem; Items is List<WarrantItem> and Bounds is FilterBounds.

WarrantFilterItem fields

FieldC# typeDescription
PageintCurrent page.
TotalPageintTotal pages.
TotalCountintTotal result count.
ItemsList<WarrantItem>Warrant list.
BoundsFilterBoundsAvailable filter bounds.

Nested WarrantItem fields

FieldC# typeDescription
SymbolstringWarrant symbol.
NamestringWarrant name.
SecTypestringSecurity type.
MarketstringMarket.
ExpireDatestringExpiration date.
LastTradingDatestringLast trading date.
StrikestringStrike price.
TypeWarrantTypeWarrant type.
StateWarrantStateWarrant state.
EntitlementRatiodoubleEntitlement ratio.
EntitlementPricedoubleEntitlement price.
PremiumdoublePremium.
BreakevenPointdoubleBreakeven point.
CallPricedoubleCall price.
BeforeCallLeveldoubleBefore-call level.
changeRatedoublePrice change rate.
ChangedoublePrice change.
LatestPricedoubleLatest price.
AmountdoubleTurnover.
OutstandingRatiodoubleOutstanding ratio.
InOutPricedoubleIn/out price.
DeltadoubleDelta.
LeverageRatiodoubleLeverage ratio.
EffectiveLeveragedoubleEffective leverage.
ImpliedVolatilitydoubleImplied volatility.
VolumelongTrading volume.
LotSizeintLot size.

Nested FilterBounds fields

FieldC# typeDescription
IssuerNameList<string>Available issuer names.
ExpireDateList<string>Available expiry dates.
LotSizeList<int>Available lot sizes.
EntitlementRatioList<double>Available entitlement ratios.
LeverageRatioRange<double>Available leverage-ratio range.
StrikeRange<double>Available strike range.
PremiumRange<double>Available premium range.
OutstandingRatioRange<double>Available outstanding-ratio range.
ImpliedVolatilityRange<double>Available implied-volatility range.
EffectiveLeverageRange<double>Available effective-leverage range.
CallPriceRange<double>Available call-price range.

WarrantItem.Delta is the sensitivity of theoretical warrant value to changes in the underlying price.

Example

TigerRequest<WarrantFilterResponse> request = new()
{
    ApiMethodName = QuoteApiService.WARRANT_FILTER,
    ModelValue = new WarrantFilterModel { Symbol = "AAPL", Page = 1, PageSize = 20 }
};
WarrantFilterResponse? response = await quoteClient.ExecuteAsync(request);

Response type

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

Response 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
  }
}

Rate limit

Base tier: 60 requests per minute.

Related APIs

See Requests, responses, and operations.

Get Warrant Quotes

Operation

QuoteApiService.WARRANT_REAL_TIME_QUOTE = warrant_real_time_quote. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<WarrantQuoteResponse>

ModelValue: WarrantQuoteModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangCLR default; omitted during serializationno
Accountstring (nullable)accountnullNot applicableInherited field; QuoteClient does not inject TigerConfig.DefaultAccount, and null is omitted during serialization
Symbolslist of stringsymbolsnullRequiredNon-empty list

Return

WarrantQuoteResponse inherits TigerResponse; its Data is WarrantQuoteItem.

Response data structure: WarrantQuoteItem; Items is List<WarrantQuote>.

WarrantQuoteItem fields

FieldC# typeDescription
ItemsList<WarrantQuote>Warrant quote list.

Nested WarrantQuote fields

FieldC# typeDescription
SymbolstringWarrant symbol.
NamestringWarrant name.
ExchangestringExchange.
SecTypestringSecurity type.
MarketstringMarket.
CurrencystringCurrency.
ExpirystringExpiration.
StrikestringStrike price.
RightstringOption right.
UnderlyingSymbolstringUnderlying symbol.
MultiplierdoubleContract multiplier.
EntitlementRatiodoubleEntitlement ratio.
EntitlementPricedoubleEntitlement price.
MinTickdoubleMinimum price increment.
CallPricedoubleCall price.
LatestPricedoubleLatest price.
PreClosedoublePrevious close price.
OpendoubleOpening price.
HighdoubleHigh price.
LowdoubleLow price.
AmountdoubleTurnover.
PremiumdoublePremium.
OutstandingRatiodoubleOutstanding ratio.
ImpliedVolatilitydoubleImplied volatility.
InOutPricedoubleIn/out price.
DeltadoubleDelta.
LeverageRatiodoubleLeverage ratio.
BreakevenPointdoubleBreakeven point.
LastTradingDatelongLast trading date.
ListingDatelongListing date.
TimestamplongQuote timestamp.
VolumelongTrading volume.
HaltedHaltedStatusTrading status.

WarrantQuote.Delta is the sensitivity of theoretical warrant value to changes in the underlying price.

Example

TigerRequest<WarrantQuoteResponse> request = new()
{
    ApiMethodName = QuoteApiService.WARRANT_REAL_TIME_QUOTE,
    ModelValue = new WarrantQuoteModel { Symbols = new List<string> { "AAPL" } }
};
WarrantQuoteResponse? response = await quoteClient.ExecuteAsync(request);

Response type

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

Rate limit

Base tier: 60 requests per minute.


Did this page help you?