paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
get_quote: {"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","bond"],"default":"stock","type":"string","description":"Asset type. Currently, only stock and bond are supported for actual portfolios; use dedicated interfaces for etf/index/warrant."},"symbols":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string"},"description":"List of security codes, e.g., [\"00700.hk\"], [\"AAPL.us\"], [\"000100.sz\"], [\"6758.jp\"], [\"US91282CHZ77\"]."},"symbol":{"type":"string","description":"If both symbols and symbol are provided, symbols takes precedence."},"quoteType":{"enum":["basic","extended"],"default":"basic","type":"string","description":"Market data type: basic = basic snapshot, extended = extended market data."},"timeMode":{"enum":[0,1],"default":0,"type":"integer","description":"Time mode: 0 = real-time, 1 = delayed. Default is 0."},"fields":{"type":"array","items":{"type":"string","enum":["snapshot","order","trade"]},"description":"US stock basic only: market data field — 'snapshot' = snapshot data, 'order' = order book data, 'trade' = tick-by-tick trade data; if omitted, defaults to [\"snapshot\", \"order\", \"trade\"]"},"sessionId":{"enum":[-1,1,-2],"type":"integer","description":"US stock basic only: request value — -1 = pre-market, 1 = regular market hours, -2 = after-hours; response may also include 3 = data correction. If omitted, no value is sent and the current session is used by default."}},"required":["market"],"allOf":[{"if":{"properties":{"market":{"const":"HK"},"assetType":{"const":"stock"},"quoteType":{"const":"basic"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"HK"},"assetType":{"const":"stock"},"quoteType":{"const":"extended"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"US"},"assetType":{"const":"stock"},"quoteType":{"const":"basic"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"US"},"assetType":{"const":"stock"},"quoteType":{"const":"extended"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"CN"},"assetType":{"const":"stock"},"quoteType":{"const":"basic"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"CN"},"assetType":{"const":"stock"},"quoteType":{"const":"extended"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"JP"},"assetType":{"const":"stock"},"quoteType":{"const":"basic"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}},{"if":{"properties":{"market":{"const":"JP"},"assetType":{"const":"stock"},"quoteType":{"const":"extended"}},"required":["market","assetType","quoteType"]},"then":{"required":["symbols"]}}]}
get_security_profile: {"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 is stock."},"symbols":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string"},"description":"List of security codes; up to 50 allowed."},"date":{"type":"string","description":"Query date for HK Index, format YYYY-MM-DD; if omitted, today's date is used."},"indexSeries":{"enum":["C","H","S","T"],"type":"string","description":"HK Index optional series: C=China Securities Index, H=Hang Seng, S=S&P, T=Total Return; if omitted, all four series are automatically queried. Code examples: \"000065\", \"CES120\"."}},"required":["market","symbols"]}
search_security: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP","ALL"],"type":"string","description":"Market code: HK (Hong Kong stocks), US (U.S. stocks), CN (A-shares / Shanghai-Shenzhen markets), JP (Japanese stocks), ALL (cross-market search)."},"assetType":{"enum":["all","stock","etf","index","warrant","bond"],"default":"all","type":"string","description":"Asset type; default is all. Use the fund_data toolkit for fund queries."},"keyword":{"type":"string","description":"Optional keyword. JP performs local filtering on the list result; HK index performs local filtering after fetching the index list. Required when market=ALL."},"date":{"type":"string","description":"Query date for HK Index, format YYYY-MM-DD; if omitted, today's date is used."},"indexSeries":{"enum":["C","H","S","T"],"type":"string","description":"HK Index optional series: C=China Securities Index, H=Hang Seng, S=S&P, T=Total Return; if omitted, all four series are combined. Code examples: \"000065\", \"CES120\"."},"limit":{"default":20,"minimum":1,"maximum":100,"type":"number","description":"Number of records to return; default is 20, maximum is 100."},"marketBoard":{"enum":["Q","G","S","N","A","P","Z","V"],"type":"string","description":"U.S. stock exchange filter; effective only when market=US or ALL. Q=Nasdaq Global Select Market, G=Nasdaq Global Market, S=Nasdaq Capital Market, N=NYSE, A=NYSE MKT/AMEX, P=NYSE Arca, Z=BATS, V=IEX."}},"required":["market"],"allOf":[{"if":{"properties":{"market":{"const":"ALL"}},"required":["market"]},"then":{"required":["keyword"]}}]}
