Stock Screener

`MarketScanner`

Purpose

Screens instruments with base, accumulated, financial, tag, and sort filters.

Signature

func (c *QuoteClient) MarketScanner(req model.MarketScannerRequest) (*model.ScannerResult, error)

Availability depends on market, instrument, and enabled data access.

Parameters

model.MarketScannerRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Market`	`string`	Yes	Always serialized	Allowed values: ALL, US, HK, CN, SG
`Page`	`int`	No	Omitted if zero	Page number
`PageSize`	`int`	No	Omitted if zero	Number of items per page
`CursorID`	`string`	No	Omitted if empty	Cursor returned by the previous page
`BaseFilterList`	`[]map[string]interface{}`	No	Omitted if empty	Base-indicator filters
`AccumulateFilterList`	`[]map[string]interface{}`	No	Omitted if empty	Accumulated-indicator filters
`FinancialFilterList`	`[]map[string]interface{}`	No	Omitted if empty	Financial-indicator filters
`MultiTagsFilterList`	`[]map[string]interface{}`	No	Omitted if empty	Multi-tag filters
`SortFieldData`	`map[string]interface{}`	No	Omitted if empty	Sort configuration
`MultiTagsFields`	`[]string`	No	Omitted if empty	Multi-tag fields to return

Returns

(*model.ScannerResult, error). Key fields from model.ScannerResult:

Field	Type	JSON field	Description
`Page`	`int`	`page`	Current result page number.
`TotalPage`	`int`	`totalPage`	Total number of result pages.
`TotalCount`	`int`	`totalCount`	Total matched instruments.
`PageSize`	`int`	`pageSize`	Number of items per page.
`CursorID`	`string`	`cursorId`	Cursor for paging results.
`Items`	`[]ScannerResultItem`	`items`	Matched instrument results.

`ScannerResultItem` field	Type	JSON field
`Symbol`	`string`	`symbol`
`Market`	`string`	`market`
`BaseDataList`	`[]ScannerDataRow`	`baseDataList`
`AccumulateDataList`	`[]ScannerDataRow`	`accumulateDataList`
`FinancialDataList`	`[]ScannerDataRow`	`financialDataList`
`MultiTagDataList`	`[]ScannerDataRow`	`multiTagDataList`

`ScannerDataRow` field	Type	JSON field
`Index`	`int`	`index`
`Name`	`string`	`name`
`Value`	`string`	`value`
`Data`	`float64`	`data`

Invocation example

result, err := qc.MarketScanner(model.MarketScannerRequest{
	Market: "US",
	Page: 1,
	PageSize: 20,
	MultiTagsFields: []string{"MultiTagField_Industry"},
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{"page":0,"totalPage":1,"totalCount":1,"pageSize":20,"cursorId":"next-cursor","items":[{"symbol":"NVDA","market":"US","baseDataList":[{"index":1,"name":"latestPrice","value":"132.15","data":132.15}],"accumulateDataList":[],"financialDataList":[],"multiTagDataList":[]}]}

Rate limit

The base rate limit is 10 requests/min.

`GetMarketScannerTags`

Purpose

Retrieves market scanner tags data and decodes it into the published Go return model.