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. Uses server method market_scanner.
Request
TigerRequest<MarketScannerResponse>ModelValue: MarketScannerModel.
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 |
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 | None (omitted if not set) | Optional | — |
Page | int | page | None (omitted if not set) | Optional | Positive integer |
PageSize | int | page_size | None (omitted if not set) | Optional | Positive integer |
Return
MarketScannerResponse inherits TigerResponse; its data property is MarketScannerPageItem. Key SDK fields: Page: Int32, PageSize: Int32, TotalPage: Int32, TotalCount: Int32, Items: list of MarketScannerItem.
Example
TigerRequest<MarketScannerResponse> request = new()
{
ApiMethodName = QuoteApiService.MARKET_SCANNER,
ModelValue = new MarketScannerModel { Account = tradeClient.GetDefaultAccount, 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 absentResponse 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
}
}Related APIs
See Requests, responses, and operations.
Scanner Tags
Operation
QuoteApiService.MARKET_SCANNER_TAGS = market_scanner_tags. Uses server method market_scanner_tags.
Request
TigerRequest<MarketScannerTagsResponse>ModelValue: MarketScannerTagsModel.
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 |
MultiTagFieldList | list of string | multi_tag_field_list | null | Optional | — |
Return
MarketScannerTagsResponse inherits TigerResponse; its data property is list of MarketScannerTagItem. Key SDK fields: Market: string, MultiTagField: string, TagList: list of TagValue.
Example
TigerRequest<MarketScannerTagsResponse> request = new()
{
ApiMethodName = QuoteApiService.MARKET_SCANNER_TAGS,
ModelValue = new MarketScannerTagsModel { Account = tradeClient.GetDefaultAccount, Market = Market.US }
};
MarketScannerTagsResponse? response = await quoteClient.ExecuteAsync(request);Response type
List<MarketScannerTagItem>? data = response?.Data; // null when response or data is absentRelated APIs
Updated 1 day ago