paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
get_mini_trend: {"type":"object","properties":{"market":{"enum":["JP"],"default":"JP","type":"string","description":"Market code, fixed as JP (Japanese stocks); optional, defaults to JP."},"symbols":{"minItems":1,"type":"array","items":{"type":"string"},"description":"Japanese stock ticker list, supporting batch queries, e.g., [\"6758.jp\", \"7203.jp\"]."},"timeMode":{"enum":[0,1],"default":0,"type":"number","description":"Time mode: 0 = real-time, 1 = delayed."}},"required":["symbols"]}
get_orderbook: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP","GLOBAL"],"type":"string","description":"Market code: HK (Hong Kong stocks), US (U.S. stocks), CN (A-shares / Shanghai-Shenzhen markets), JP (Japanese stocks), GLOBAL (bonds)."},"assetType":{"enum":["stock","etf","index","bond"],"default":"stock","type":"string","description":"Asset type, default: stock. HK supports stock/etf/index/bond; other markets select based on API capabilities."},"symbol":{"type":"string","description":"Security code, e.g., \"00700.hk\", \"AAPL.us\", \"6758.jp\", \"US91282CHZ77\"."}},"required":["market","symbol"]}
get_trade_statistics: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP"],"type":"string","description":"Market code: HK (Hong Kong stocks), US (U.S. stocks), CN (A-shares / Shanghai-Shenzhen markets), JP (Japanese stocks)."},"symbol":{"type":"string","description":"Security code, e.g., \"6758.jp\"; required for JP trading statistics overview."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"statisticsType":{"enum":["overview","detail"],"type":"string","description":"statisticsType values: overview=Trading Statistics Overview, detail=Trading Statistics Details."},"type":{"enum":[0,1,2,3,4],"default":4,"type":"number","description":"Trade direction: 0 = Main buy, 1 = Main sell, 2 = Neutral, 3 = Main buy and main sell, 4 = All. Default: 4."},"date":{"type":"string","description":"Query date, format: YYYY-MM-DD. For JP transaction summary overview, if omitted, defaults to today’s local Japan date; no data may be available on non-trading days. For HK detailed data, results may correspond to the prior trading day; the `date` field in the response is authoritative, and a warning is included if the returned date differs from the requested date."},"sortField":{"enum":["price","volume"],"type":"string","description":"Detail sorting field; required when 'detail' is specified: 'price' = price level, 'volume' = trading volume."},"sortType":{"enum":[0,1],"default":1,"type":"integer","description":"Detail sort order: 0 = ascending, 1 = descending; default is 1."},"pageNum":{"default":1,"minimum":1,"maximum":100000,"type":"integer","description":"detail: page number, starting from 1, maximum 100000. Out-of-range returns PAGE_OUT_OF_RANGE; validation failure returns PAGE_EMPTY_UNCONFIRMED."},"pageSize":{"default":20,"minimum":1,"maximum":200,"type":"integer","description":"detail: number of items per page; default is 20, maximum is 200; recommended range is 20–50. Returns full page; if response exceeds budget, returns RESPONSE_TOO_LARGE; reduce page size and restart pagination from page 1."},"sessionId":{"enum":[-1,1,-2],"default":1,"type":"number","description":"U.S. stock trading session: -1=pre-market, 1=in-session, -2=after-hours."}},"required":["market","statisticsType"],"allOf":[{"if":{"properties":{"market":{"const":"HK"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"HK"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"US"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"US"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"CN"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"CN"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"JP"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"JP"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"market":{"const":"HK"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"HK"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"US"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"US"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"CN"},"statisticsType":{"const":"overview"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"CN"},"statisticsType":{"const":"detail"}},"required":["market","statisticsType"]},"then":{"required":["date"]}},{"if":{"properties":{"statisticsType":{"const":"detail"}},"required":["statisticsType"]},"then":{"required":["sortField"]}}]}
get_trades: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP"],"type":"string","description":"Market code: HK (Hong Kong stocks), US (U.S. stocks), CN (A-shares / Shanghai-Shenzhen markets), JP (Japanese stocks)."},"assetType":{"enum":["stock","etf","index"],"default":"stock","type":"string","description":"Asset type, default: stock; bond is not supported."},"symbol":{"type":"string","description":"Security code, e.g., \"00700.hk\", \"AAPL.us\", \"6758.jp\", \"US91282CHZ77\"."},"time":{"type":"string","description":"Query time, format: YYYY-MM-DD HH:mm:ss, e.g., 2026-07-28 09:30:00; required when `market=JP`."},"startTime":{"type":"string","description":"Start time. Format: YYYY-MM-DD HH:mm:ss, e.g., 2026-07-28 09:30:00."},"endTime":{"type":"string","description":"End time, format YYYY-MM-DD HH:mm:ss, e.g., 2026-07-28 16:00:00."},"pageNum":{"default":1,"minimum":1,"maximum":100000,"type":"number","description":"Page number, starting from 1; default is 1."},"pageSize":{"default":20,"minimum":1,"maximum":200,"type":"number","description":"Number of records per page; default is 20, maximum is 200."},"orderMode":{"enum":[0,1],"default":0,"type":"number","description":"Tick-by-tick trade sorting/pagination direction: 0 = query data before the specified time, 1 = query data after the specified time. Default is 0."},"tickerId":{"type":"number","description":"Tick-by-tick cursor ID; required for some markets."},"sessionId":{"enum":[-1,1,-2],"default":1,"type":"number","description":"U.S. stock trading session: -1=pre-market, 1=in-session, -2=after-hours. Default is 1."}},"required":["market","symbol"],"allOf":[{"if":{"properties":{"market":{"const":"JP"}},"required":["market"]},"then":{"required":["time"]}}]}
