paramsobjectOptional
Business parameters selected by endpoint; do not nest params again.
compare_funds: {"type":"object","properties":{"fund_ids":{"type":"array","items":{"type":"string"},"description":"List of fund entity identifiers; combined with fund_class_ids, total 2–10 items, no duplicates allowed."},"fund_class_ids":{"type":"array","items":{"type":"string"},"description":"List of fund share class identifiers; combined with fund_ids, total 2–10 items, no duplicates allowed."}},"required":[]}
get_country_code: {"type":"object","properties":{"countryName":{"type":"string","description":"Country or region name in Chinese or English, ISO2, ISO3, or common alias (e.g., United States, US, USA); maximum length: 128 characters."}},"required":["countryName"]}
get_fund_benchmark: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_distributions: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"start_date":{"type":"string","description":"Dividend start date, format YYYY-MM-DD; maximum query range is 3650 days."},"end_date":{"type":"string","description":"Dividend end date, format YYYY-MM-DD; maximum query range is 3650 days."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":["start_date","end_date"],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_exposure: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["asset","sector","country"],"default":"asset","type":"string","description":"Configuration type: asset = asset allocation, sector = sector allocation, country = country/region allocation."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_holdings: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["default","top","history"],"default":"default","type":"string","description":"Query content: default=Latest full portfolio holdings, top=Top 10 holdings, history=Historical holdings."},"start_date":{"type":"string","description":"Start date, format YYYY-MM-DD; required when operation=history."},"end_date":{"type":"string","description":"End date, format YYYY-MM-DD; required when operation=history."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"allOf":[{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["start_date"]}},{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["end_date"]}}],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_managers: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["current","history","bio","education"],"default":"current","type":"string","description":"Query content: current=Current manager, history=Employment history, bio=Biography, education=Educational background."},"start_date":{"type":"string","description":"Start date, format YYYY-MM-DD; required when operation=history."},"end_date":{"type":"string","description":"End date, format YYYY-MM-DD; required when operation=history."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"allOf":[{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["start_date"]}},{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["end_date"]}}],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_nav: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["latest","history"],"default":"latest","type":"string","description":"Query content: latest=Latest NAV, history=Historical NAV."},"start_date":{"type":"string","description":"Start date, format YYYY-MM-DD; required when operation=history."},"end_date":{"type":"string","description":"End date, format YYYY-MM-DD; required when operation=history."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"allOf":[{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["start_date"]}},{"if":{"properties":{"operation":{"const":"history"}},"required":["operation"]},"then":{"required":["end_date"]}}],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_performance: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["latest","custom"],"default":"latest","type":"string","description":"Query content: latest=Latest period performance, custom=Custom period return."},"start_date":{"type":"string","description":"Start date, format YYYY-MM-DD; required when operation=custom."},"end_date":{"type":"string","description":"End date, format: YYYY-MM-DD; required when operation=custom."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"allOf":[{"if":{"properties":{"operation":{"const":"custom"}},"required":["operation"]},"then":{"required":["start_date"]}},{"if":{"properties":{"operation":{"const":"custom"}},"required":["operation"]},"then":{"required":["end_date"]}}],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_profile: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["default","size"],"default":"default","type":"string","description":"Query content: default=Basic information, size=Asset scale history."},"start_date":{"type":"string","description":"Start date, format YYYY-MM-DD; optional date-range filter when operation=size; start_date and end_date must be provided as a pair."},"end_date":{"type":"string","description":"End date, format YYYY-MM-DD; used to filter by date range when operation=size; start_date and end_date must be provided as a pair."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}],"dependencies":{"start_date":["end_date"],"end_date":["start_date"]}}
get_fund_risk: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"operation":{"enum":["default","rating","debt"],"default":"default","type":"string","description":"Query content: default=Risk metrics, rating=Fund ratings, debt=Bond portfolio statistics."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_sales_markets: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
get_fund_terms: {"type":"object","properties":{"fund_id":{"type":"string","description":"Fund entity identifier (e.g., FS...); mutually exclusive with fund_class_id — only one may be provided."},"fund_class_id":{"type":"string","description":"Fund share class identifier (e.g., F0...); mutually exclusive with fund_id — only one may be provided."},"kind":{"enum":["fees","constraints","purchase"],"default":"fees","type":"string","description":"Clause Type: fees=fee rate, constraints=investor restrictions, purchase=subscription information."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"oneOf":[{"required":["fund_id"],"not":{"required":["fund_class_id"]}},{"required":["fund_class_id"],"not":{"required":["fund_id"]}}]}
rank_funds: {"type":"object","properties":{"rank_field":{"enum":["return_1d","return_1w","return_1m","return_3m","return_6m","return_ytd","return_1y","return_3y","return_5y","return_10y","rank_1y","rank_3y"],"default":"return_1y","type":"string","description":"Ranking field."},"category":{"type":"string","description":"Fund category code or name."},"provider_id":{"type":"string","description":"Fund management company identifier."},"currency":{"type":"string","description":"Fund valuation currency."},"sales_market":{"type":"string","description":"Registered sales market country code."},"min_return_1y":{"type":"number","description":"Minimum one-year yield, entered as a percentage (e.g., 5.0 means 5%)."},"max_fee":{"type":"number","description":"Maximum actual management fee rate, e.g., 1.5."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[]}
screen_funds: {"type":"object","properties":{"rank_field":{"enum":["return_1d","return_1w","return_1m","return_3m","return_6m","return_ytd","return_1y","return_3y","return_5y","return_10y","rank_1y","rank_3y"],"default":"return_1y","type":"string","description":"Ranking field."},"category":{"type":"string","description":"Fund category code or name."},"provider_id":{"type":"string","description":"Fund management company identifier."},"currency":{"type":"string","description":"Fund valuation currency."},"sales_market":{"type":"string","description":"Registered sales market country code."},"min_return_1y":{"type":"number","description":"Minimum one-year yield, entered as a percentage (e.g., 5.0 means 5%)."},"max_fee":{"type":"number","description":"Maximum actual management fee rate, e.g., 1.5."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[]}
search_funds: {"type":"object","properties":{"mode":{"enum":["search","categories","providers","share_classes"],"default":"search","type":"string","description":"Query mode; when using share_classes mode, fund_id must be provided."},"query":{"type":"string","description":"Search fund names, ISINs, tickers, CUSIPs, or SEDOLs; plain text must be at least 2 characters long."},"category":{"type":"string","description":"Fund category code or name."},"provider_id":{"type":"string","description":"Fund management company identifier."},"currency":{"type":"string","description":"Fund valuation currency."},"sales_market":{"type":"string","description":"Registered sales market; supports ISO3, ISO2, or country name."},"fund_id":{"type":"string","description":"Fund entity identifier; required when mode=share_classes."},"page":{"default":0,"minimum":0,"type":"integer","description":"Page number, starting from 0."},"page_size":{"default":50,"minimum":1,"maximum":200,"type":"integer","description":"Number of records per page"}},"required":[],"allOf":[{"if":{"properties":{"mode":{"const":"share_classes"}},"required":["mode"]},"then":{"required":["fund_id"]}}]}