gs_quant.markets.index.Index.get_underlier_tree¶

Index.get_underlier_tree(refresh_tree=False)[source]¶

Get the root node of the tree formed by the Index, as an AssetTreeNode object.

Parameters:: refresh_tree (Optional[bool]) – Refresh the underliers information of the entire tree

Please refer to the documenation of the AssetTreeNode class for more information. Currently supports STS indices only.

Return type:: AssetTreeNode
Returns:: root node of the tree formed by the Index, as an AssetTreeNode object.

Examples

>>> from gs_quant.markets.index import Index
>>>
>>> index = Index.get("GSMBXXXX")
>>> index.get_underlier_tree()