paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
get_hk_ipo_calendar: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["calendar","calendar_detail"],"type":"string","description":"IPO Data Type: calendar=IPO Calendar, calendar_detail."},"startDate":{"type":"string","description":"Start date. Format: YYYY-MM-DD, e.g., 2026-07-01. Used for historical range, financial report periods, fund NAV, and fund flow queries."},"endDate":{"type":"string","description":"End date, format: YYYY-MM-DD (e.g., 2026-07-28). Typically used with startDate."},"date":{"type":"string","description":"Query date/time. The default date format is YYYY-MM-DD; for scenarios requiring precise timestamps—such as K-line (minute-level), tick-by-tick, and intraday data—the format must be YYYY-MM-DD HH:mm:ss."}},"required":["ipoType"],"allOf":[{"if":{"properties":{"market":{"const":"HK"},"ipoType":{"const":"calendar"}},"required":["market","ipoType"]},"then":{"required":["startDate"]}},{"if":{"properties":{"market":{"const":"HK"},"ipoType":{"const":"calendar"}},"required":["market","ipoType"]},"then":{"required":["endDate"]}},{"if":{"properties":{"market":{"const":"HK"},"ipoType":{"const":"calendar_detail"}},"required":["market","ipoType"]},"then":{"required":["date"]}}]}
get_hk_ipo_company_profile: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["company_profile","company_profile_new"],"type":"string","description":"IPO Data Type: company_profile, company_profile_new."},"code":{"type":"string","description":"HK IPO stock ID or new stock code; for company profile APIs, pass 'code'; do not use 'symbol'."}},"required":["ipoType","code"]}
get_hk_ipo_detail: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["offering","public_offering","company_info","allocation_top","allocation_bottom"],"type":"string","description":"IPO Data Type: offering=Offering Details, public_offering, company_info, allocation_top, allocation_bottom."},"code":{"type":"string","description":"HK IPO stock ID or new stock code; for detail-type APIs, pass 'code'; do not use 'symbol'."}},"required":["ipoType","code"]}
get_hk_ipo_list: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["make_new","today","to_be_listed","listed","table","table_detail"],"type":"string","description":"IPO Data Type: listed=Listed, make_new, today, to_be_listed, table, table_detail."},"name":{"type":"string","description":"Filing company name; required when ipoType=table_detail."},"status":{"enum":[0,1,2,3,4,5,6,7,8],"type":"integer","description":"Filing market status; required when ipoType=table. Values: 0 = not open, 1 = pre-market auction, 2 = waiting for opening, 3 = trading, 4 = midday halt, 5 = closing auction, 6 = closed, 7 = halted, 8 = post-market trading."}},"required":["ipoType"],"allOf":[{"if":{"properties":{"ipoType":{"const":"table_detail"}},"required":["ipoType"]},"then":{"required":["name"]}},{"if":{"properties":{"ipoType":{"const":"table"}},"required":["ipoType"]},"then":{"required":["status"]}}]}
get_hk_ipo_margin_info: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["margin","margin_step","broker_info","multiple"],"type":"string","description":"IPO Data Type: margin=Margin, margin_step, broker_info, multiple."},"code":{"type":"string","description":"HK IPO stock ID or new stock code; margin, margin_step, and broker_info are required. For detail-type APIs, pass 'code'; do not use 'symbol'."}},"required":["ipoType"],"allOf":[{"if":{"properties":{"ipoType":{"const":"margin"}},"required":["ipoType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoType":{"const":"margin_step"}},"required":["ipoType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoType":{"const":"broker_info"}},"required":["ipoType"]},"then":{"required":["code"]}}]}
get_hk_ipo_market_data: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoMarketType":{"enum":["market_info","industry_info","industry_performance","industry_name"],"type":"string","description":"IPO Market Data Type: market_info=Market Overview, industry_info=Industry Statistics, industry_performance=Industry Performance, industry_name=Query Industry Name by Industry Code."},"code":{"type":"string","description":"Industry code or industry ID; required when ipoMarketType=industry_name."},"date":{"type":"string","description":"Query date, format: YYYY-MM-DD."}},"required":["ipoMarketType"],"allOf":[{"if":{"properties":{"ipoMarketType":{"const":"industry_name"}},"required":["ipoMarketType"]},"then":{"required":["code"]}}]}
get_hk_ipo_notice: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["prospectus","table_notice"],"type":"string","description":"IPO Data Type: prospectus=Prospectus Announcement, table_notice."},"code":{"type":"string","description":"HK IPO stock ID or new stock code; for announcement detail APIs, pass 'code'; do not use 'symbol'."}},"required":["ipoType","code"]}
get_hk_ipo_rankings: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"rankType":{"enum":["popular","first_day_return","sponsor","underwriter","cornerstone"],"type":"string","description":"Ranking type: popular = popular subscription, first_day_return = first-day return, sponsor = sponsor ranking, underwriter = underwriter ranking, cornerstone = cornerstone investor ranking."}},"required":["rankType"]}
get_hk_ipo_subscription_tools: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoUtilityType":{"enum":["compute","h5_compute","amount_list","broker_list","lot","new_stock_list","subscription_list","subscription_dates"],"type":"string","description":"ipoUtilityType values: compute=New Share Subscription Calculation, h5_compute=H5 New Share Subscription Calculation, amount_list=Subscription Quantity List, broker_list=Broker List, lot=Lot Allocation Quantity, new_stock_list=New Stock List, subscription_list=Subscription Method List, subscription_dates=Subscription Start/End Dates."},"code":{"type":"string","description":"IPO stock code, string type; required for compute, h5_compute, amount_list, broker_list, and lot."},"brokerId":{"type":["integer","string"],"description":"Broker ID. For compute/new_stock_list, an integer is required."},"mode":{"enum":[1,2],"type":"integer","description":"Subscription method; required for compute: 1 = cash subscription, 2 = bank financing subscription."},"quantity":{"type":"integer","description":"Subscription quantity or subscription lots, integer type; required for compute and h5_compute."},"lot":{"type":"integer","description":"Allotted subscription lots. Integer type. Must not exceed quantity. Required for compute and h5_compute."},"financingLeverage":{"type":"integer","description":"Leverage Multiple: Integer type, range 1–50; required for h5_compute."},"financingRate":{"type":"number","description":"Margin financing interest rate; numeric type, range 0–10, supporting up to two decimal places; h5_compute is required."},"flag":{"type":"string","description":"Date range flag; subscription_dates is required, e.g., before, this, after."}},"required":["ipoUtilityType"],"allOf":[{"if":{"properties":{"ipoUtilityType":{"const":"compute"}},"required":["ipoUtilityType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoUtilityType":{"const":"h5_compute"}},"required":["ipoUtilityType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoUtilityType":{"const":"amount_list"}},"required":["ipoUtilityType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoUtilityType":{"const":"broker_list"}},"required":["ipoUtilityType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoUtilityType":{"const":"lot"}},"required":["ipoUtilityType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoUtilityType":{"const":"compute"}},"required":["ipoUtilityType"]},"then":{"required":["brokerId"]}},{"if":{"properties":{"ipoUtilityType":{"const":"new_stock_list"}},"required":["ipoUtilityType"]},"then":{"required":["brokerId"]}},{"if":{"properties":{"ipoUtilityType":{"const":"subscription_list"}},"required":["ipoUtilityType"]},"then":{"required":["brokerId"]}},{"if":{"properties":{"ipoUtilityType":{"const":"compute"}},"required":["ipoUtilityType"]},"then":{"required":["mode"]}},{"if":{"properties":{"ipoUtilityType":{"const":"compute"}},"required":["ipoUtilityType"]},"then":{"required":["quantity"]}},{"if":{"properties":{"ipoUtilityType":{"const":"h5_compute"}},"required":["ipoUtilityType"]},"then":{"required":["quantity"]}},{"if":{"properties":{"ipoUtilityType":{"const":"compute"}},"required":["ipoUtilityType"]},"then":{"required":["lot"]}},{"if":{"properties":{"ipoUtilityType":{"const":"h5_compute"}},"required":["ipoUtilityType"]},"then":{"required":["lot"]}},{"if":{"properties":{"ipoUtilityType":{"const":"h5_compute"}},"required":["ipoUtilityType"]},"then":{"required":["financingLeverage"]}},{"if":{"properties":{"ipoUtilityType":{"const":"h5_compute"}},"required":["ipoUtilityType"]},"then":{"required":["financingRate"]}},{"if":{"properties":{"ipoUtilityType":{"const":"subscription_dates"}},"required":["ipoUtilityType"]},"then":{"required":["flag"]}}]}
get_ipo_course: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"courseType":{"enum":["search","hot","month_rank","refer","relate","h5_relate","detail","total_rank"],"type":"string","description":"courseType values: search=course list, hot=hot courses, month_rank=monthly ranking, refer=recommended courses, relate=PC-related courses, h5_relate=H5-related courses, detail=course details, total_rank=overall ranking."},"keyword":{"type":"string","description":"Course search keyword."},"id":{"type":"integer","description":"Course ID, must be an integer; required for detail, relate, and h5_relate."}},"required":["courseType"],"allOf":[{"if":{"properties":{"courseType":{"const":"detail"}},"required":["courseType"]},"then":{"required":["id"]}},{"if":{"properties":{"courseType":{"const":"relate"}},"required":["courseType"]},"then":{"required":["id"]}},{"if":{"properties":{"courseType":{"const":"h5_relate"}},"required":["courseType"]},"then":{"required":["id"]}}]}
get_ipo_news: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"contentType":{"enum":["new_stock_info","list","detail","hot","day_rank","week_rank","refer","relate","h5_relate"],"type":"string","description":"Content type: new_stock_info = news related to new stocks, list = news list, detail = news detail, hot = hot news, day_rank = daily ranking, week_rank = weekly ranking, refer = recommended news, relate = PC-related news, h5_relate = H5-related news."},"match":{"type":"string","description":"Keyword matching: searches for news headlines containing the value of the match field. String type. For the new_stock_info group, keywords must be provided; otherwise, an empty list will be returned."},"id":{"type":"integer","description":"Information ID, must be an integer; required for detail, relate, and h5_relate."}},"required":["contentType"],"allOf":[{"if":{"properties":{"contentType":{"const":"new_stock_info"}},"required":["contentType"]},"then":{"required":["match"]}},{"if":{"properties":{"contentType":{"const":"detail"}},"required":["contentType"]},"then":{"required":["id"]}},{"if":{"properties":{"contentType":{"const":"relate"}},"required":["contentType"]},"then":{"required":["id"]}},{"if":{"properties":{"contentType":{"const":"h5_relate"}},"required":["contentType"]},"then":{"required":["id"]}}]}
get_ipo_profile: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["profile"],"default":"profile","type":"string","description":"IPO Data Type: profile."},"code":{"type":"string","description":"HK IPO stock ID or new stock code."}},"required":["ipoType","code"]}
get_ipo_tags: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"tagType":{"enum":["exist_data","list"],"type":"string","description":"tagType values: exist_data=Retrieve tags with available data, list=Retrieve tag list."},"tagCategory":{"enum":[10,11,20,21],"default":10,"type":"number","description":"Tag classification dimension: 10=HK stock information category, 11=HK stock information source, 20=HK stock course category, 21=HK stock course source. If omitted, defaults to 10."}},"required":["tagType"]}
get_ipo_topic: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"topicType":{"enum":["top","list","detail","info"],"type":"string","description":"topicType values: top=sticky topic, list=topic list, detail=topic detail, info=topic-related news."},"id":{"type":"integer","description":"Topic ID. Must be an integer; required when topicType=detail."}},"required":["topicType"],"allOf":[{"if":{"properties":{"topicType":{"const":"detail"}},"required":["topicType"]},"then":{"required":["id"]}}]}
get_us_ipo_list: {"type":"object","properties":{"market":{"enum":["US"],"default":"US","type":"string","description":"Market code, fixed as US (U.S. stocks); optional, defaults to US."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoType":{"enum":["to_be_listed","listed","trend","pe_ttm"],"type":"string","description":"IPO Data Type: listed=Listed, to_be_listed, trend, pe_ttm."},"dateType":{"enum":["30","90","180","365"],"type":"string","description":"U.S. stock IPO time range, in days; valid values are 30, 90, 180, or 365."},"date":{"type":"string","description":"Query date/time. The default date format is YYYY-MM-DD; for scenarios requiring precise timestamps—such as K-line (minute-level), tick-by-tick, and intraday data—the format must be YYYY-MM-DD HH:mm:ss."}},"required":["ipoType"],"allOf":[{"if":{"properties":{"ipoType":{"const":"trend"}},"required":["ipoType"]},"then":{"required":["dateType"]}},{"if":{"properties":{"ipoType":{"const":"pe_ttm"}},"required":["ipoType"]},"then":{"required":["dateType"]}},{"if":{"properties":{"market":{"const":"US"},"ipoType":{"const":"to_be_listed"}},"required":["market","ipoType"]},"then":{"required":["date"]}},{"if":{"properties":{"market":{"const":"US"},"ipoType":{"const":"listed"}},"required":["market","ipoType"]},"then":{"required":["date"]}}]}
get_us_ipo_market_data: {"type":"object","properties":{"market":{"enum":["US"],"default":"US","type":"string","description":"Market code, fixed as US (U.S. stocks); optional, defaults to US."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"ipoMarketType":{"enum":["us_market_info","us_industry_performance"],"type":"string","description":"IPO Market Data Type: us_market_info=US IPO Market Overview, us_industry_performance=US IPO Industry Performance."},"code":{"type":"string","description":"Industry code or industry ID; required when ipoMarketType=industry_name."},"date":{"type":"string","description":"Query date, format: YYYY-MM-DD."},"dateType":{"enum":["30","90","180","365"],"type":"string","description":"U.S. stock IPO time range, in days; valid values are 30, 90, 180, or 365."}},"required":["ipoMarketType"],"allOf":[{"if":{"properties":{"ipoMarketType":{"const":"industry_name"}},"required":["ipoMarketType"]},"then":{"required":["code"]}},{"if":{"properties":{"ipoMarketType":{"const":"us_market_info"}},"required":["ipoMarketType"]},"then":{"required":["dateType"]}}]}
search_ipo_content: {"type":"object","properties":{"market":{"enum":["HK"],"default":"HK","type":"string","description":"Market code, fixed as HK (Hong Kong stocks); optional, defaults to HK."},"symbol":{"type":"string","description":"A single security, fund, bond, option, or IPO code."},"symbols":{"type":"array","items":{"type":"string"},"description":"Batch list of security codes, e.g., [\"00700.hk\", \"AAPL.us\"];"},"contentType":{"enum":["async_search","search"],"type":"string","description":"Content type: async_search = asynchronous search, search = news search."},"match":{"type":"string","description":"Keyword matching: searches for news headlines containing the value of the match field. String type. For the new_stock_info group, keywords must be provided; otherwise, an empty list will be returned."},"id":{"type":"integer","description":"Information ID, must be an integer; required for detail, relate, and h5_relate."}},"required":["contentType"],"allOf":[{"if":{"properties":{"contentType":{"const":"new_stock_info"}},"required":["contentType"]},"then":{"required":["match"]}},{"if":{"properties":{"contentType":{"const":"detail"}},"required":["contentType"]},"then":{"required":["id"]}},{"if":{"properties":{"contentType":{"const":"relate"}},"required":["contentType"]},"then":{"required":["id"]}},{"if":{"properties":{"contentType":{"const":"h5_relate"}},"required":["contentType"]},"then":{"required":["id"]}}]}
