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 all indicator definitions supported by the stock screener, including keys, names, units, and available ranges. Use these to build custom filter conditions.
Request
This endpoint takes no request parameters.
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
groups | object[] | Optional | Indicator groups |
└ group_type | string | Optional | Group type. |
└ group_name | string | Optional | Group name |
└ indicators | object[] | Optional | Indicators in this group |
└ ∟ id | integer | Optional | Indicator ID (string) |
└ ∟ key | string | Optional | Indicator key, e.g. `filter_pettm`. |
└ ∟ name | string | Optional | Indicator display name |
└ ∟ places | integer | Optional | Number of decimal places. |
└ ∟ category | integer | Optional | Company category |
└ ∟ tech_indicators | array | Optional | Technical indicator options. |
└ ∟ default_range | object | Optional | Default value range. |
└ ∟ unit | string | Optional | Unit (e.g. `%`, `B`) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"groups": [
{
"group_name": "Company Size & Financials",
"indicators": [
{
"id": "1",
"key": "marketcap",
"name": "Market Cap",
"unit": "B",
"min": null,
"max": null
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.