Uncategorized

get_search_filters(facets)

Description: 

Returns a list of available filter values for the specified search facets. These filters can be used to refine symbol search results via get_search(). This is useful for building dropdowns, autocomplete lists, or dynamic filter UIs. 

Function Signature: 

get_search_filters(facets: Union[str, List[str]]) -> tuple

Parameters: 

Name Type Required Default Description
facets str or List[str] Yes — A facet name, or list of facet names, to return filter values for (e.g., 'types').

Return:

Returns a tuple of (code, label, level) entries, where code is the filter code you pass to get_search(), label is the human-readable name, and level is the hierarchy depth.

Notes:

  • Use get_search_facets() first to retrieve valid facet names.
  • Returned filter codes (e.g., 'F.TYP.7') are passed directly to the filters argument in get_search().