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 full configuration of a single stock screener strategy by strategy ID, including all indicator groups and the filter range for each indicator. (strategy ID as path parameter)
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Required | Strategy ID from `screener_recommend_strategies` or `screener_user_strategies` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Optional | Strategy ID |
market | string | Optional | Target market |
filter | object | Optional | Filter configuration |
└ filters | object[] | Optional | Filter conditions |
└ ∟ key | string | Optional | Indicator key, e.g. `filter_pettm`. |
└ ∟ min | string | Optional | Lower bound |
└ ∟ max | string | Optional | Upper bound |
└ ∟ tech_values | object | Optional | Technical indicator params |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"id": 19,
"name": "Stocks that surged today",
"market": "US",
"type": "platform",
"filter": {
"filters": [
{
"key": "prevchg",
"min": "2",
"max": "",
"tech_values": {}
}
]
}
}
}Error code
See the Error Codes page for the full list of error codes.