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=. |
Filter stocks by strategy ID or custom indicator conditions, with pagination support.
longbridge screener search --strategy-id 42
longbridge screener search --market HK --filter marketcap:100:1000
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
market | string | Required | Market to screen, e.g. `US`, `HK`, `CN`. When a strategy is used, taken from the strategy. |
filters | array | Required | Filter conditions. Each item is `{ "key": "filter_pettm", "min": "10", "max": "30", "tech_values": {} }`. |
returns | array | Required | Indicator keys to return for each match, e.g. `filter_pettm`. |
page | integer | Required | Page number (0-indexed). |
size | integer | Required | Page size. |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | Optional | Total number of matching stocks. |
items | object[] | Optional | Matched stock list. |
└ symbol | string | Optional | Security symbol, e.g. `WXT.US`. |
└ name | string | Optional | Security name. |
└ indicators | object[] | Optional | Indicator values for this stock. |
└ ∟ key | string | Optional | Indicator key, e.g. `filter_pettm`. |
└ ∟ name | string | Optional | Indicator display name. |
└ ∟ value | string | Optional | Indicator value as a string; empty when unavailable. |
└ ∟ unit | string | Optional | Value unit, e.g. `%`, `B`. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"total": 88,
"page": 0,
"market": "US",
"items": [
{
"symbol": "AAPL.US",
"name": "Apple Inc.",
"prevchg": 0.62,
"marketcap": 3241500000000,
"pettm": 32.15,
"pbmrq": 50.21,
"salesgrowthyoy": 8.04
},
{
"symbol": "MSFT.US",
"name": "Microsoft",
"prevchg": 1.05,
"marketcap": 3085000000000,
"pettm": 35.42,
"pbmrq": 12.87,
"salesgrowthyoy": 12.61
}
]
}
}Error code
See the Error Codes page for the full list of error codes.