paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
get_bond_chart: {"type":"object","properties":{"market":{"enum":["GLOBAL"],"type":"string","description":"Market code, fixed as GLOBAL (bonds); optional, defaults to GLOBAL."},"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\"];"},"bondType":{"enum":["history","trend","yield_kline","yield_trend","treasury_yield"],"type":"string","description":"bondType values: history, trend, yield_kline, yield_trend, treasury_yield."},"type":{"type":"integer","description":"Yield K-line type; yield_kline is required in combination; integer enumeration is defined by the API."}},"required":["bondType"],"allOf":[{"if":{"properties":{"bondType":{"const":"history"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"trend"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"yield_kline"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"yield_trend"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"yield_kline"}},"required":["bondType"]},"then":{"required":["type"]}}]}
get_bond_rankings: {"type":"object","properties":{"market":{"enum":["GLOBAL"],"type":"string","description":"Market code, fixed as GLOBAL (bonds); optional, defaults to GLOBAL."},"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\"];"},"bondType":{"enum":["rank","rank_simple","etf_rank"],"type":"string","description":"bondType values: rank, rank_simple, etf_rank."}},"required":["bondType"]}
get_bond_trading_status: {"type":"object","properties":{"market":{"enum":["GLOBAL"],"type":"string","description":"Market code, fixed as GLOBAL (bonds); optional, defaults to GLOBAL."},"symbol":{"default":"US91282CHZ77","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\"];"},"bondType":{"enum":["bond","yield"],"type":"string","description":"bondType values: bond, yield."}},"required":["bondType"]}
get_bond_yield: {"type":"object","properties":{"market":{"enum":["GLOBAL"],"type":"string","description":"Market code, fixed as GLOBAL (bonds); optional, defaults to GLOBAL."},"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\"];"},"bondType":{"enum":["codes","snapshot","kline","trend"],"type":"string","description":"bondType values: codes, snapshot, kline, trend."},"type":{"type":"integer","description":"Yield K-line type; kline is required in combination; integer enumeration is defined by the API."}},"required":["bondType"],"allOf":[{"if":{"properties":{"bondType":{"const":"kline"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"trend"}},"required":["bondType"]},"then":{"required":["symbol"]}},{"if":{"properties":{"bondType":{"const":"kline"}},"required":["bondType"]},"then":{"required":["type"]}}]}