Market Scanner

About 2 min

Stock Filter MarketScanner

Description

Screen the targets of the whole market through basic indicators, cumulative indicators, financial indicators, etc.

Argument

ArgumentTypeRequiredDescription
marketenumYesUS,SG,HK
baseFilterListlistNobasic indicators
accumulateFilterListlistNocumulative indicators
financialFilterListlistNofinancial indicators
multiTagsRelationFilterListlistNoMulti-label association filter conditions
sortFieldDataobjectNosort field
pageintYesPage NO, start from 0
pageSizeintYesPage size,max :200

Response

TigerOpenAPI.Quote.Response.MarketScannerResponsesourceopen in new window

Structured as follows:

  public class MarketScannerResponse : TigerResponse
  {
    [JsonProperty(PropertyName = "data")]
    public MarketScannerPageItem Data { get; set; }

    public MarketScannerResponse()
    {
    }
  }

User MarketScannerResponse.GetData().GetItems(), acutal data returned is a list of MarketScannerItem, TigerOpenAPI.Quote.Response.MarketScannerItem has the following attributes:

NameTypeDescription
marketstringmarket code(US/CN/HK)
symbolstringSymbol
baseDataListList<MarketIndicatorValue>basic indicators
accumulateDataListList<MarketIndicatorValue>cumulative indicators
financialDataListList<MarketIndicatorValue>financial indicator
multiTagDataListList<MarketIndicatorValue>Multi-label association filter conditions

Example

  static async Task<MarketScannerResponse?> FilterSymbolsAsync(QuoteClient quoteClient)
  {
    // create request
    TigerRequest<MarketScannerResponse> request = new TigerRequest<MarketScannerResponse>()
    {
      ApiMethodName = QuoteApiService.MARKET_SCANNER,
      ModelValue = new MarketScannerModel()
      {
        Market = Market.HK,
        // construct base filter prameter list
        BaseFilterList = new List<BaseFilter>()
        {
          new BaseFilter()
          {
            FieldName = StockField.StockField_MarketValue,
            FilterMin = 1000000000D,
            FilterMax = 2000000000D
          }
        },
        Page = 1,
        PageSize = 20
      }
    };
    return await quoteClient.ExecuteAsync(request);
  }

Response Example

{
    "data":{
        "page":1,
        "pageSize":20,
        "totalPage":13,
        "totalCount":258,
        "items":[
            {
                "market":"HK",
                "symbol":"03315",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1245757040
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"03301",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1582425531.98
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"03788",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1509200000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01126",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1841072800
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"09911",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1737999000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01180",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1073229021.3
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"09906",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1344000000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"09908",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1403257010
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01161",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1170550754.08
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01168",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1070832520.13
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"09936",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1461600000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"83081",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1498464000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00733",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1280884979.1
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00726",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1225448288.35
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00716",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1619900024.24
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00776",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1614276840
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01626",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1602000000
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00769",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1159141639.1
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"00752",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1783342229.76
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            },
            {
                "market":"HK",
                "symbol":"01608",
                "baseDataList":[
                    {
                        "index":17,
                        "name":"marketValue",
                        "value":1134711065.46
                    }
                ],
                "accumulateDataList":[

                ],
                "financialDataList":[

                ],
                "multiTagDataList":[

                ]
            }
        ]
    },
    "code":0,
    "message":"success",
    "timestamp":1677830284272,
    "sign":"gE14eWd+ZosTz42k44Hs1xV6P945N6c3/Dm8TR1FiRQWMkbAp0oVWPHGhZc2LzNFIjGSQ8ijBmljZTKwtYIu9MM+f0kizM8xAVwBWk2eqYmxcxfnLJICdz4zkvM+r4gAajHOAuuOSUrG1DeHCwhIQqNO785q9n5/OyzsZCGYkPc="
}
Last update: