Uncategorized

get_search_facets()

Description: 

Returns the full list of available search facets that can be used as filters or attributes when performing symbol searches using search_symbols(). Search facets define the categories or metadata fields (e.g., market sector, exchange, asset class) that can be used to narrow down search results. 

Function Signature: 

get_search_facets() -> tuple

Parameters: 

Parameter  Type  Required  Default  Description 
(none)  —  —  —  This function does not take any input parameters. 

Return:

Returns a tuple of available search facets. Each facet can then be passed to get_search_filters() to retrieve its filter values.

Notes:

  • Returned facets are used in conjunction with get_search() to perform filtered searches.
  • Pass a facet to get_search_filters() to see the valid filter codes for it.