Stock Screener

`marketScanner`

Signature

async marketScanner(req: MarketScannerRequest): Promise<ScannerResult | undefined>

Purpose

Screens securities using the supplied filters.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`MarketScannerRequest`	Yes	None	None.
`req.market`	`string`	Yes	None	None.
`req.page`	`number \| undefined`	No	None	Page numbering starts at 0
`req.pageSize`	`number \| undefined`	No	None	Omitting it or passing 0 returns at most 500 items per page
`req.cursorId`	`string \| undefined`	No	None	For subsequent pages, use the cursor returned by the preceding page
`req.baseFilterList`	`Record<string, unknown>[] \| undefined`	No	None	None.
`req.accumulateFilterList`	`Record<string, unknown>[] \| undefined`	No	None	None.
`req.financialFilterList`	`Record<string, unknown>[] \| undefined`	No	None	None.
`req.multiTagsFilterList`	`Record<string, unknown>[] \| undefined`	No	None	None.
`req.sortFieldData`	`Record<string, unknown> \| undefined`	No	None	When provided, it must contain `fieldType`, `fieldName`, and `sortDir`
`req.multiTagsFields`	`string[] \| undefined`	No	None	None.

Returns

Promise<ScannerResult | undefined>

Field	Type	Description
page	number	Page number
totalPage	number	Total pages
totalCount	number	Total count
pageSize	number	Page size
cursorId	string	Cursor ID
items	ScannerResultItem[]	Data items array

Type-checked example

const result = await quoteClient.marketScanner({ market: 'US' });
console.log(result);

Response example

{
  "page": 0,
  "totalPage": 0,
  "totalCount": 0,
  "pageSize": 0,
  "cursorId": "string",
  "items": [
    {
      "symbol": "string",
      "market": "string",
      "baseDataList": [
        "ScannerDataRow"
      ],
      "accumulateDataList": [
        "ScannerDataRow"
      ],
      "financialDataList": [
        "ScannerDataRow"
      ],
      "multiTagDataList": [
        "ScannerDataRow"
      ]
    }
  ]
}

Rate limit: The base limit is 10 requests per minute.

`getMarketScannerTags`

Signature

async getMarketScannerTags(req: MarketScannerTagsRequest): Promise<MarketScannerTagGroup[]>

Purpose

Gets market scanner tags.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`MarketScannerTagsRequest`	Yes	None	None.
`req.market`	`string \| undefined`	Yes	None	Valid market value
`req.multiTagFieldList`	`string[] \| undefined`	Yes	None	Non-empty; industry and concept fields return available tags, while other fields may return an empty list
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<MarketScannerTagGroup[]>

Field	Type	Description
market	string	Market
multiTagField	string	Multi-tag field
tagList	MarketScannerTag[]	Tag list

Type-checked example

const result = await quoteClient.getMarketScannerTags({ market: 'US', multiTagFieldList: ['MultiTagField_Industry'] });
console.log(result);

Response example

[
  {
    "market": "string",
    "multiTagField": "string",
    "tagList": [
      "MarketScannerTag"
    ]
  }
]

Rate limit: The base limit is 10 requests per minute.

Updated about 1 month ago

Did this page help you?