gs_quant.markets.indices_utils.get_flagship_baskets

get_flagship_baskets(fields=[], basket_type=['Custom Basket', 'Research Basket'], asset_class=[Equity], region=None, styles=None, as_of=None, **kwargs)[source]

Retrieve flagship baskets

Parameters:

  • fields (List[str]) – Fields to retrieve in addition to mqid, name, ticker, region, basket type, description, styles, live date, and asset class

  • basket_type (List[BasketType]) – Basket type(s)

  • asset_class (List[AssetClass]) – Asset class (defaults to Equity)

  • region (Optional[List[Region]]) – Basket region(s)

  • styles (Optional[List[Union[CustomBasketStyles, ResearchBasketStyles]]]) – Basket style(s)

  • as_of (Optional[datetime]) – Datetime for which to retrieve baskets (defaults to current time)

Return type:

DataFrame

Returns:

flagship baskets

Usage

Retrieve a list of flagship baskets

Examples

Retrieve a list of flagship baskets

>>> from gs_quant.markets.indices_utils import *
>>>
>>> get_flagship_baskets()

See also

get_flagships_with_assets() get_flagships_performance() get_flagships_constituents()