paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
get_market_hours: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP","GLOBAL"],"type":"string","description":"Market code: HK = Hong Kong stocks, CN = A-shares, US = U.S. stocks, JP = Japanese stocks, GLOBAL = bonds."},"statusType":{"enum":["bond","yield"],"type":"string","description":"statusType Selects the business branch; refer to parameterBranches for applicable scopes of this field."},"board":{"type":"string","description":"Market category filter: MAIN=Main Board, GEM=Growth Enterprise Market, NASD=NASDAQ AMX Market, ETS=Expanded Trading Securities; if not provided, returns all categories. This is NOT a trading session ID and does not support symbol/symbols filtering. Applicable branches and default values per market are specified in parameterBranches."},"timeMode":{"enum":[0,1],"type":"integer","description":"Time mode: 0 = real-time, 1 = delayed. Refer to 'parameterBranches' for applicable branches and default values per market."},"symbol":{"type":"string","description":"Security code, e.g., \"00700.hk\", \"600519.sh\", \"AAPL.us\". Applicable branches and default values per market are specified in parameterBranches."},"symbols":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"},"description":"symbol Single-element array notation for symbol; multi-security queries are not supported in this endpoint. Refer to parameterBranches for applicable endpoints and default values per market."}},"required":["market"]}
get_reference_data: {"type":"object","properties":{"market":{"enum":["HK","US","CN","GLOBAL"],"type":"string","description":"Market code: HK = Hong Kong stocks, CN = A-shares, US = U.S. stocks, JP = Japanese stocks, GLOBAL = bonds."},"referenceType":{"enum":["isin","sedol","trade_symbol","warrant_related","currency","basic_symbol","cik","adr","bond_codes","yield_codes"],"type":"string","description":"referenceType Selects the business branch; refer to parameterBranches for applicable scopes of this field."},"symbol":{"type":"string","description":"Security code, e.g., \"00700.hk\", \"600519.sh\", \"AAPL.us\". Applicable branches and default values per market are specified in parameterBranches."},"isin":{"type":"string","description":"Optional; International Securities Identification Number (ISIN); default values per branch and market are specified in parameterBranches."},"language":{"enum":["简体","繁体","英文"],"type":"string","description":"Only supports one of: Simplified, Traditional, English. Default: Simplified. Default values per branch and market are specified in parameterBranches."},"symbols":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"},"description":"symbol Single-element array notation for symbol; multi-security queries are not supported in this endpoint. Refer to parameterBranches for applicable endpoints and default values per market."},"sedol":{"type":"string","description":"Optional. Common security identifier used in the UK and Ireland markets. Default values for applicable branches and markets are specified in parameterBranches."},"secType":{"type":"string","description":"Optional field, varchar(6); default values per branch and market are specified in parameterBranches."},"listBoard":{"enum":["MAIN","GEM","主板","创业板","科创板","深交所退市整理板","上交所风险警示板"],"type":"string","description":"Optional; allowed values: MAIN (Main Board), GEM (Growth Enterprise Market); default values per branch and market are specified in parameterBranches."},"hsceFlag":{"type":"string","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"hsccFlag":{"type":"string","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"hsiFlag":{"type":"string","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"hkToSzFlag":{"type":"string","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"hkToShFlag":{"type":"string","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"lotSize":{"type":"integer","description":"Optional. Trading unit (lot size) for the security. Default values for applicable branches and markets are specified in parameterBranches."},"tradeDate":{"type":"string","description":"Optional. Datetime format. Default values for applicable branches and markets are specified in parameterBranches."},"updateTime":{"type":"string","description":"Optional. Datetime format. Default values for applicable branches and markets are specified in parameterBranches."},"warrantCode":{"type":"string","description":"Optional. Applicable branches and market-specific default values are defined in parameterBranches."},"currency":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNH","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GBX","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","ILX","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMW","ZWL","all"],"type":"string","description":"Currency identifier; only accepts types declared in this branch, does not infer missing currencies from securities markets. See parameterBranches for applicable branches and market-specific defaults."},"startDate":{"type":"string","description":"Optional. Format: yyyy-MM-dd. Used to filter the start date of the date range. Default values for applicable branches and markets are specified in parameterBranches."},"endDate":{"type":"string","description":"Optional. Format: yyyy-MM-dd. Used to filter the end date of the date range. Default values for applicable branches and markets are specified in parameterBranches."},"sort":{"enum":["desc","asc","DESC","ASC"],"type":"string","description":"Optional; desc=descending order, asc=ascending order; default is desc; default values per branch and market are specified in parameterBranches."},"listMarket":{"type":"string","description":"Optional field, varchar(10). Applicable branches and market-specific default values are defined in parameterBranches."},"hkexInstrumentType":{"type":"string","description":"Optional field, varchar(6); default values per branch and market are specified in parameterBranches."},"fiuInstrumentType":{"type":["string","integer"],"description":"Example value: 1. Applicable branches and default values per market are specified in parameterBranches."},"aShareCode":{"type":"string","description":"Optional. Used to filter by A-share stock code. Default values for applicable branches and markets are specified in parameterBranches."},"companyReportKind":{"type":["string","integer"],"description":"Optional field, varchar(2). Applicable branches and market-specific default values are defined in parameterBranches."},"cik":{"type":"string","description":"Lookup by CIK code; applicable branches and market-specific default values are defined in parameterBranches."},"cqs":{"type":"string","description":"Optional field, varchar(32); default values per branch and market are specified in parameterBranches."},"exchange":{"enum":["Q","G","S","N","A","P","Z","V"],"type":"string","description":"Optional field, varchar(4), provided by NASDAQ, indicating the stock's listing market or market tier: Q=Nasdaq Global Select Market, G=Nasdaq Global Market, S=Nasdaq Capital Market, N=NYSE, A=NYSE MKT (AMEX), P=NYSE Arca, Z=BATS Exchange, V=Investor's Exchange, LLC; default values per branch and market are specified in parameterBranches."},"hkShareCode":{"type":"string","description":"Optional. Used to filter by Hong Kong stock code. Default values for applicable branches and markets are specified in parameterBranches."},"hsToHkFlag":{"enum":["Y","N"],"type":"integer","description":"Optional; Y=Yes, N=No; default values per branch and market are specified in parameterBranches."},"country":{"enum":["CHN","HKG","USA","all"],"type":"string","description":"Country of Risk for the bond; omit or specify 'all' to include all countries. Applicable branches and market-specific default values are listed in parameterBranches."},"pageNum":{"minimum":1,"type":"integer","description":"Page number, starting from 1. Default values for applicable branches and markets are specified in parameterBranches."},"pageSize":{"minimum":1,"type":"integer","description":"Number of records per page; positive integer; default is 20. Default values per branch and market are specified in parameterBranches."},"region":{"enum":[1,2,3],"type":"integer","description":"Region: 1 for Americas, 2 for Asia-Pacific, 3 for Europe, Africa & Middle East. Default values per branch and market are specified in parameterBranches."},"state":{"type":"integer","description":"Current bond status. Applicable branches and default values per market are specified in parameterBranches."},"subtype":{"enum":[1,2,3,4],"type":"integer","description":"Bond sub-type. Applicable branches and market-specific default values are listed in parameterBranches."},"type":{"enum":[1,2,3],"type":"integer","description":"Bond type. Applicable branches and market-specific default values are listed in parameterBranches."}},"required":["market","referenceType"],"allOf":[{"if":{"properties":{"market":{"const":"HK"},"referenceType":{"const":"currency"}},"required":["market","referenceType"]},"then":{"required":["currency"]}},{"if":{"properties":{"market":{"const":"US"},"referenceType":{"const":"currency"}},"required":["market","referenceType"]},"then":{"required":["currency"]}},{"if":{"properties":{"market":{"const":"CN"},"referenceType":{"const":"currency"}},"required":["market","referenceType"]},"then":{"required":["currency"]}}]}
get_trading_status: {"type":"object","properties":{"market":{"enum":["HK","US","CN","JP","GLOBAL"],"type":"string","description":"Market code: HK = Hong Kong stocks, CN = A-shares, US = U.S. stocks, JP = Japanese stocks, GLOBAL = bonds."},"statusType":{"enum":["trade_date","session","exright","security","delisted","current","bond_session","yield_session"],"type":"string","description":"statusType Selects the business branch; refer to parameterBranches for applicable scopes of this field."},"date":{"type":["string","integer"],"description":"Anchor date, format YYYY-MM-DD; if trading calendar is not provided, defaults to the current market date. Applicable branches and market-specific default values are defined in parameterBranches."},"filterStatus":{"enum":["Y","N","H","ALL"],"type":"string","description":"Trading day status: Y=trading day, N=non-trading day, H=half-day trading (Hong Kong only), ALL=no filtering. Applicable branches and default values per market are specified in parameterBranches."},"orderMode":{"enum":[0,1],"type":"integer","description":"Query direction: 0 = query backward from date (date is the end point), 1 = query forward from date (date is the start point); anchor date is included. Default values per branch and market are specified in parameterBranches."},"stockConnect":{"enum":["NB","SB"],"type":"string","description":"Calendar scope: NB=Northbound, SB=Southbound; if not provided, uses the local market calendar. Channel market closure does not imply exchange closure. See parameterBranches for applicable branches and default values per market."},"pageNum":{"minimum":1,"type":"integer","description":"Page number, starting from 1. Default values for applicable branches and markets are specified in parameterBranches."},"pageSize":{"minimum":1,"type":"integer","description":"Number of records per page; positive integer; default is 20. Default values per branch and market are specified in parameterBranches."},"board":{"type":"string","description":"Market category filter: MAIN=Main Board, GEM=Growth Enterprise Market, NASD=NASDAQ AMX Market, ETS=Expanded Trading Securities; if not provided, returns all categories. This is NOT a trading session ID and does not support symbol/symbols filtering. Applicable branches and default values per market are specified in parameterBranches."},"timeMode":{"enum":[0,1],"type":"integer","description":"Time mode: 0 = real-time, 1 = delayed. Refer to 'parameterBranches' for applicable branches and default values per market."},"symbol":{"type":"string","description":"Security code, e.g., \"00700.hk\", \"600519.sh\", \"AAPL.us\". Applicable branches and default values per market are specified in parameterBranches."},"symbols":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"},"description":"symbol Single-element array notation for symbol; multi-security queries are not supported in this endpoint. Refer to parameterBranches for applicable endpoints and default values per market."},"exchange":{"enum":["Q","N","A","OTC"],"type":"string","description":"Market category for U.S. delisted stocks: Q, N, A, OTC; corresponds to market, not the composite market US. See parameterBranches for applicable branches and default values per market."}},"required":["market","statusType"]}
