Screener

Screener Search

POSThttps://openapi.longbridge.com/v1/quote/ai/screener/search

Authorization

Signed mode: every request is signed with your App Key/Secret. Header set:

NameTypeRequiredDescription
Authorizationstring · headerRequiredThe account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation.
X-Api-Keystring · headerRequiredYour App Key.
X-Timestampstring · headerRequiredRequest timestamp in seconds (Unix epoch).
X-Api-Signaturestring · headerRequiredHMAC-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.

>_ CLI
longbridge screener search --strategy-id 42
longbridge screener search --market HK --filter marketcap:100:1000

Request

Request body

NameTypeRequiredDescription
marketstringRequiredMarket to screen, e.g. `US`, `HK`, `CN`. When a strategy is used, taken from the strategy.
filtersarrayRequiredFilter conditions. Each item is `{ "key": "filter_pettm", "min": "10", "max": "30", "tech_values": {} }`.
returnsarrayRequiredIndicator keys to return for each match, e.g. `filter_pettm`.
pageintegerRequiredPage number (0-indexed).
sizeintegerRequiredPage size.

Response

Response properties

NameTypeRequiredDescription
totalintegerOptionalTotal number of matching stocks.
itemsobject[]OptionalMatched stock list.
└ symbolstringOptionalSecurity symbol, e.g. `WXT.US`.
└ namestringOptionalSecurity name.
└ indicatorsobject[]OptionalIndicator values for this stock.
└ ∟ keystringOptionalIndicator key, e.g. `filter_pettm`.
└ ∟ namestringOptionalIndicator display name.
└ ∟ valuestringOptionalIndicator value as a string; empty when unavailable.
└ ∟ unitstringOptionalValue 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.