Stock Screener

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.

Market Scanner

Operation

QuoteApiService.MARKET_SCANNER = market_scanner. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<MarketScannerResponse>

ModelValue: MarketScannerModel.

Parameters

SDK property	C# type	API field	SDK default	Required	Constraints
`Lang`	Language	`lang`	CLR default; omitted during serialization	no	—
`Account`	string (nullable)	`account`	null	Not applicable	Inherited field; `QuoteClient` does not inject `TigerConfig.DefaultAccount`, and null is omitted during serialization
`Market`	Market	`market`	CLR default; omitted during serialization	Optional	Enum value
`BaseFilterList`	list of BaseFilter	`base_filter_list`	null	Optional	—
`AccumulateFilterList`	list of AccumulateFilter	`accumulate_filter_list`	null	Optional	—
`FinancialFilterList`	list of FinancialFilter	`financial_filter_list`	null	Optional	—
`MultiTagsFilterList`	list of MultiTagsRelationFilter	`multi_tags_filter_list`	null	Optional	—
`SortFieldData`	SortFieldData	`sort_field_data`	CLR default; omitted during serialization	Optional	—
`Page`	int	`page`	CLR default; omitted during serialization	Optional	Positive integer
`PageSize`	int	`page_size`	CLR default; omitted during serialization	Optional	Positive integer

Return

MarketScannerResponse inherits TigerResponse; its Data is MarketScannerPageItem.

Response data structure: MarketScannerPageItem; Items is List<MarketScannerItem>.

MarketScannerPageItem fields

Field	C# type	Description
`Page`	`int`	Current page.
`PageSize`	`int`	Page size.
`TotalPage`	`int`	Total pages.
`TotalCount`	`int`	Total result count.
`Items`	`List<MarketScannerItem>`	Scanner result items.

Nested MarketScannerItem fields

Field	C# type	Description
`Market`	`string`	Market identifier.
`Symbol`	`string`	Instrument symbol.
`BaseDataList`	`List<MarketIndicatorValue>`	Basic indicator values.
`AccumulateDataList`	`List<MarketIndicatorValue>`	Accumulative indicator values.
`FinancialDataList`	`List<MarketIndicatorValue>`	Financial indicator values.
`MultiTagDataList`	`List<MarketIndicatorValue>`	Multi-tag indicator values.

Nested MarketIndicatorValue fields

Field	C# type	Description
`Index`	`int`	Indicator index.
`Name`	`string`	Indicator name.
`Value`	`object`	Dynamic indicator value; its type and fields depend on the selected filter field.

Example

TigerRequest<MarketScannerResponse> request = new()
{
    ApiMethodName = QuoteApiService.MARKET_SCANNER,
    ModelValue = new MarketScannerModel { Market = Market.US, Page = 1, PageSize = 20 }
};
MarketScannerResponse? response = await quoteClient.ExecuteAsync(request);

Response type

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

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "items": [
      {"symbol": "AAPL", "latestPrice": 308.91, "changeRate": -0.0735, "volume": 176739024, "marketValue": 3250000000000.0},
      {"symbol": "TSLA", "latestPrice": 285.50, "changeRate": 0.0312, "volume": 95000000, "marketValue": 915000000000.0}
    ],
    "totalCount": 156
  }
}

Rate limit

Base tier: 10 requests per minute.

Scanner Tags

Operation

QuoteApiService.MARKET_SCANNER_TAGS = market_scanner_tags. Use this constant for TigerRequest.ApiMethodName.

Request

TigerRequest<MarketScannerTagsResponse>

ModelValue: MarketScannerTagsModel.

Parameters

SDK property	C# type	API field	SDK default	Required	Constraints
`Lang`	Language	`lang`	CLR default; omitted during serialization	no	—
`Account`	string (nullable)	`account`	null	Not applicable	Inherited field; `QuoteClient` does not inject `TigerConfig.DefaultAccount`, and null is omitted during serialization
`Market`	Market	`market`	CLR default; omitted during serialization	Optional	Enum value
`MultiTagFieldList`	list of string	`multi_tag_field_list`	null	Optional	—

Return

MarketScannerTagsResponse inherits TigerResponse; its Data is List<MarketScannerTagItem>.

Response data structure: List<MarketScannerTagItem>; each TagList value is List<TagValue>.

MarketScannerTagItem fields

Field	C# type	Description
`Market`	`string`	Market identifier.
`MultiTagField`	`string`	Multi-tag field name.
`TagList`	`List<TagValue>`	Tag values.

Nested TagValue fields

Field	C# type	Description
`Tag`	`string`	Tag label.
`Value`	`string?`	Tag value.