Screener
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get the list of platform-preset stock screener strategies, including recent average daily change and constituent stocks.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
market | string | Optional | Market filter: `US`, `HK`, `CN`, `SG`. Default: `US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
strategys | object[] | Optional | Strategy list |
└ id | integer | Optional | Strategy ID (pass to `screener_strategy` or `screener_search`) |
└ name | string | Optional | Strategy name |
└ type | string | Optional | `"platform"` for preset strategies |
└ market | string | Optional | Target market (e.g. `"US"`, `"HK"`) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"strategys": [
{
"id": 19,
"name": "Stocks that surged today",
"type": "platform",
"market": "US"
},
{
"id": 20,
"name": "Top growth stocks of the year",
"type": "platform",
"market": "US"
}
]
}
}Error code
See the Error Codes page for the full list of error codes.