Skip to content

Candlestick Patterns ​

GET /api/v1.0/quote/kline-shape/list

Get the catalog of supported K-line chart patterns (Double Bottom, Triple Bottom, Head and Shoulders, Flag, Double Top, etc.). Returns: shape_type, shape_name, direction (BULLISH / BEARISH), shape_brief, shape_image, and shape_url. For pattern stock screening use quote.kline_shape_stocks; for per-stock pattern detection and backtest use quote.kline_shape_analysis.

Request ​

ParameterTypeInRequiredDescription
filter_typestringquerynoPattern filter: ALL (default) / RISE (bullish) / FALL (bearish) / RECOMMEND

Example ​

bash
curl -X GET 'https://webapi.moomoo.com/api/v1.0/quote/kline-shape/list?filter_type=1' \
  -H 'Authorization: Bearer <AccessToken>' | jq

Response ​

FieldTypeDescription
data.itemsobject[]
data.items[].shape_typeintegerPattern type ID (1~10 bullish, 1001~1010 bearish)
data.items[].shape_nameintegerPattern enum name
data.items[].directionintegerDirection: BULLISH / BEARISH
data.items[].shape_briefstringPattern technical description
data.items[].shape_imagestringPattern illustration image URL
data.items[].shape_urlstringPattern help article URL

Errors ​

ret_codeerror.codeDescription
0—Success
-3invalid_parameterMissing or invalid parameter
-7invalid_symbolUnknown symbol
-8unsupportedMarket or product is not supported
-9permission_deniedMissing permission
-10no_dataNo data
-11rate_limitedToo many requests

Sample ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "items": [
      {
        "shape_type": 0,
        "shape_name": 0,
        "direction": 0,
        "shape_brief": "example",
        "shape_image": "example",
        "shape_url": "example"
      }
    ]
  }
}