Options
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.
Get Option Expirations
Operation
QuoteApiService.OPTION_EXPIRATION = option_expiration. Uses server method option_expiration.
Request
TigerRequest<OptionExpirationResponse>ModelValue: OptionExpirationModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
Symbols | list of string | symbols | null | Required | Non-empty list |
Return
OptionExpirationResponse inherits TigerResponse; its data property is list of OptionExpirationItem. Key SDK fields: Symbol: string, Count: int, Dates: list of string, Timestamps: list of long, PeriodTags: list of string.
Example
TigerRequest<OptionExpirationResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_EXPIRATION,
ModelValue = new OptionExpirationModel { Account = tradeClient.GetDefaultAccount, Market = Market.US, Symbols = new List<string> { "AAPL" } }
};
OptionExpirationResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionExpirationItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"symbol": "AAPL",
"dates": ["2025-08-08", "2025-08-15", "2025-08-22"],
"timestamps": [1754625600000, 1755230400000, 1755835200000],
"count": 3
}
]
}Related APIs
See Requests, responses, and operations.
Get Option Chain
Operation
QuoteApiService.OPTION_CHAIN = option_chain. Uses server method option_chain.
Request
TigerRequest<OptionChainResponse>ModelValue: OptionChainV3Model.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
OptionBasic | list of OptionChainModel | option_basic | null | Optional | — |
OptionFilter | OptionChainFilterModel | option_filter | None (omitted if not set) | Optional | — |
ReturnGreekValue | Boolean | return_greek_value | None (omitted if not set) | Optional | — |
Return
OptionChainResponse inherits TigerResponse; its data property is list of OptionChainItem. Key SDK fields: Symbol: string, Expiry: long, Items: list of OptionRealTimeQuoteGroup.
Example
TigerRequest<OptionChainResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_CHAIN,
ModelValue = new OptionChainV3Model { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionChainResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionChainItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"symbol": "AAPL",
"expiry": 1754625600000,
"items": [
{"identifier": "AAPL 250808C00230000", "strike": 230.0, "right": "CALL", "latestPrice": 80.50, "volume": 1200, "openInterest": 5600},
{"identifier": "AAPL 250808P00230000", "strike": 230.0, "right": "PUT", "latestPrice": 1.25, "volume": 800, "openInterest": 3200}
]
}
]
}Related APIs
See Requests, responses, and operations.
Get Option Quotes
Operation
QuoteApiService.OPTION_BRIEF = option_brief. Uses server method option_brief.
Request
TigerRequest<OptionBriefResponse>ModelValue: OptionBasicModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
OptionBasic | list of OptionCommonModel | option_basic | null | Optional | — |
Return
OptionBriefResponse inherits TigerResponse; its data property is list of OptionBriefItem. Key SDK fields: Identifier: string, Symbol: string, Strike: string, Right: string, Expiry: long, AskPrice: Double, AskSize: long, BidPrice: Double.
Example
TigerRequest<OptionBriefResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_BRIEF,
ModelValue = new OptionBasicModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionBriefResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionBriefItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"identifier": "AAPL 250808C00230000",
"symbol": "AAPL",
"strike": 230.0,
"right": "CALL",
"multiplier": 100,
"expiry": 1754625600000,
"latestPrice": 80.50,
"volume": 1200,
"openInterest": 5600,
"impliedVol": 0.3702,
"delta": 0.92,
"gamma": 0.008,
"theta": -0.15,
"vega": 0.12
}
]
}Related APIs
See Requests, responses, and operations.
Get Option K-Line
Operation
QuoteApiService.OPTION_KLINE = option_kline. Uses server method option_kline.
Request
TigerRequest<OptionKlineResponse>ModelValue: OptionKlineV2Model.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
OptionQuery | list of OptionKlineModel | option_query | null | Required | — |
Return
OptionKlineResponse inherits TigerResponse; its data property is list of OptionKlineItem. Key SDK fields: Symbol: string, Strike: string, Right: string, Expiry: long, Period: string, Items: list of OptionKlinePoint.
Example
TigerRequest<OptionKlineResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_KLINE,
ModelValue = new OptionKlineV2Model { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionKlineResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionKlineItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"identifier": "AAPL 250808C00230000",
"period": "day",
"items": [
{"time": 1785355200000, "open": 78.00, "high": 82.00, "low": 77.50, "close": 80.50, "volume": 1200},
{"time": 1785441600000, "open": 80.50, "high": 83.00, "low": 79.00, "close": 81.25, "volume": 950}
]
}
]
}Related APIs
See Requests, responses, and operations.
Get Option Ticks
Operation
QuoteApiService.OPTION_TRADE_TICK = option_trade_tick. Uses server method option_trade_tick.
Request
TigerRequest<OptionTradeTickResponse>ModelValue: OptionModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
Return
OptionTradeTickResponse inherits TigerResponse; its data property is list of OptionTradeTickItem. Key SDK fields: Symbol: string, Expiry: long, Strike: string, Right: string, Items: list of OptionTradeTickPoint.
Example
TigerRequest<OptionTradeTickResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_TRADE_TICK,
ModelValue = new OptionModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionTradeTickResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionTradeTickItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"identifier": "AAPL 250808C00230000",
"items": [
{"time": 1785527900000, "price": 80.50, "volume": 5, "type": "+"},
{"time": 1785527920000, "price": 80.45, "volume": 3, "type": "-"}
]
}
]
}Related APIs
See Requests, responses, and operations.
Get Option Depth
Operation
QuoteApiService.OPTION_DEPTH = option_depth. Uses server method option_depth.
Request
TigerRequest<OptionDepthResponse>ModelValue: OptionModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
Return
OptionDepthResponse inherits TigerResponse; its data property is list of OptionDepthItem. Key SDK fields: Symbol: string, Expiry: long, Strike: string, Right: string, Timestamp: long, Ask: list of OptionDepthOrderBook, Bid: list of OptionDepthOrderBook.
Example
TigerRequest<OptionDepthResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_DEPTH,
ModelValue = new OptionModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionDepthResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionDepthItem>? data = response?.Data; // null when response or data is absentResponse Example
{
"code": 0,
"message": "success",
"timestamp": 1785528000000,
"data": [
{
"identifier": "AAPL 250808C00230000",
"asks": [
{"price": 80.80, "volume": 20, "count": 0},
{"price": 80.90, "volume": 15, "count": 0}
],
"bids": [
{"price": 80.50, "volume": 10, "count": 0},
{"price": 80.40, "volume": 25, "count": 0}
]
}
]
}Related APIs
See Requests, responses, and operations.
Get HK Option Symbols
Operation
QuoteApiService.ALL_HK_OPTION_SYMBOLS = all_hk_option_symbols. Uses server method all_hk_option_symbols.
Request
TigerRequest<OptionSymbolResponse>ModelValue: QuoteMarketModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
PackageName | PackageName | package_name | None (omitted if not set) | Optional | — |
IncludeOTC | Boolean | include_otc | None (omitted if not set) | Optional | — |
Return
OptionSymbolResponse inherits TigerResponse; its data property is list of OptionSymbolItem. Key SDK fields: Symbol: string, Name: string, UnderlyingSymbol: string.
Example
TigerRequest<OptionSymbolResponse> request = new()
{
ApiMethodName = QuoteApiService.ALL_HK_OPTION_SYMBOLS,
ModelValue = new QuoteMarketModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionSymbolResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionSymbolItem>? data = response?.Data; // null when response or data is absentRelated APIs
See Requests, responses, and operations.
Option Analysis
Operation
QuoteApiService.OPTION_ANALYSIS = option_analysis. Uses server method option_analysis.
Request
TigerRequest<OptionAnalysisResponse>ModelValue: OptionAnalysisModel.
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 |
Market | Market | market | None (omitted if not set) | Optional | Enum value |
Symbols | list of OptionAnalysisSymbolModel | symbols | null | Required | Non-empty list |
Return
OptionAnalysisResponse inherits TigerResponse; its data property is list of OptionAnalysisItem. Key SDK fields: Symbol: string, ImpliedVol30Days: double, HisVolatility: double, IvHisVRatio: double, CallPutRatio: double, ImpliedVolMetric: string, VolatilityList: list of object.
Example
TigerRequest<OptionAnalysisResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_ANALYSIS,
ModelValue = new OptionAnalysisModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
OptionAnalysisResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<OptionAnalysisItem>? data = response?.Data; // null when response or data is absentRelated APIs
See Requests, responses, and operations.
Option Timeline
Operation
QuoteApiService.OPTION_TIMELINE = option_timeline. Uses server method option_timeline.
Request
TigerRequest<TigerListResponse>ModelValue: OptionTimelineModel.
Parameters
| SDK property | C# type | API field | SDK default | Required | Constraints |
|---|---|---|---|---|---|
OptionQuery | list of OptionTimelineQuery | option_query | none | Required | — |
Market | Market | market | Market.NONE/omitted | Optional | Enum value |
Return
TigerListResponse inherits TigerResponse; its data property is list of dictionary from string to object. Key SDK fields: dynamic fields.
Example
TigerRequest<TigerListResponse> request = new()
{
ApiMethodName = QuoteApiService.OPTION_TIMELINE,
ModelValue = new OptionTimelineModel { Market = Market.US, OptionQuery = new List<OptionTimelineQuery> { new() { Symbol = "AAPL", Expiry = 1784246400000L, Right = "CALL", Strike = "200" } } }
};
TigerListResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<Dictionary<string, object>>? data = response?.Data; // null when response or data is absentRelated APIs
Updated about 12 hours ago