Screener

Screener — a derived convenience surface that returns the securities matching a set of filter criteria, computed over official market and financial data.

DerivedSource: TWSE / TPEx·Plan: pro·Cost: 3 credits·GET /v2/datasets/screener

Overview

screener returns one row per matching security for the filters supplied, computed on top of official TWSE / TPEx market and financial datasets. It is a derived convenience layer: the underlying values come from official sources, but the match list itself is computed by TWMD rather than published by an exchange.

Field	Type	Description
`symbol`	string	Ticker of the matching security.
`name`	string	Security name.
`matched_filters`	array	Which filter criteria this row satisfied.
`as_of`	string	Data date the screen was computed against.
`source_role`	string	twmd_derived_screener.

Coverage

Rows	7,625,469
Window	2006-01-02 – 2026-07-16
Grade	Derived

Example response

TODO — no real response has been captured for this dataset yet. It needs an entitled API key, or its required parameters are not yet known. Rather than show an example nobody has observed, this section stays empty.

Getting started

Put your key in the X-API-Key header.
Add query parameters (symbol, date range, limit).
Send the request and read the returned payload.

curl "https://api.twmarketdata.com/v2/datasets/screener?symbol=2330" \  -H "X-API-Key: sk_live_..."

Filtering

Parameter	Required	Type	Description
`symbol`	No	string	Ticker to filter to a single security.
`limit`	No	integer	Maximum rows to return.

Python

A first call:

import requests resp = requests.get(    "https://api.twmarketdata.com/v2/datasets/screener",    params={"symbol": "2330"},    headers={"X-API-Key": "sk_live_..."},)resp.raise_for_status()print(resp.json())

With a date-range filter:

import requests # The full verified example — the same call with every supported filter set.resp = requests.get(    "https://api.twmarketdata.com/v2/datasets/screener",    params={"symbol": "2330"},    headers={"X-API-Key": "sk_live_..."},)resp.raise_for_status()print(resp.json())

OpenAPI

This endpoint is GET /v2/datasets/screener. The full machine-readable schema (parameters, security, response envelope) lives in the OpenAPI spec.

Notes & limitations

Derived / computed convenience over official data — not itself an official published list. Results depend on the filters and the as_of data date; reproduce a screen by pinning as_of.

Request & Response

Request

curl "https://api.twmarketdata.com/v2/datasets/screener?symbol=2330&limit=5" \  -H "X-API-Key: $TWMD_API_KEY"

Authenticate with the X-API-Key header, using a sk_live_ key issued in the dashboard.

Response

TODO — no response has been captured for this dataset yet (it needs an entitled key, or its required parameters are not yet known). No example is shown rather than an invented one.

The grade badge on this page is a documentation classification, not a response field.

Overview

Field	Type	Description
`symbol`	string	Ticker of the matching security.
`name`	string	Security name.
`matched_filters`	array	Which filter criteria this row satisfied.
`as_of`	string	Data date the screen was computed against.
`source_role`	string	twmd_derived_screener.

Parameter

Required

Type

Description

symbol

string

Ticker to filter to a single security.

limit

integer

Maximum rows to return.

Python

A first call:

import requests resp = requests.get(    "https://api.twmarketdata.com/v2/datasets/screener",    params={"symbol": "2330"},    headers={"X-API-Key": "sk_live_..."},)resp.raise_for_status()print(resp.json())

With a date-range filter:

import requests # The full verified example — the same call with every supported filter set.resp = requests.get(    "https://api.twmarketdata.com/v2/datasets/screener",    params={"symbol": "2330"},    headers={"X-API-Key": "sk_live_..."},)resp.raise_for_status()print(resp.json())