Module macrobond_data_api.web.web_types.series_tree_methods

Classes

class SeriesTreeMethods (session: Session)

Operations related to the visual series database tree structure

Methods

def find_locations(self, series_name: str) ‑> List[SeriesTreeLocationPart]

Find the locations where this series can be found in the database tree.

OAuth scope: macrobond_web_api.read_structure

Codes

200 The operation was successful.

401 Unauthorized. Missing, invalid or expired access token.

403 Forbidden. Not authorized.

def get_leaf_series(self, path: str, *dp: str) ‑> SeriesTreeListingResponse

Get a structured list of series for a leaf in the database tree identified by the path of the tree branches.

OAuth scope: macrobond_web_api.read_structure

Codes

200 The operation was successful.

401 Unauthorized. Missing, invalid or expired access token.

403 Forbidden. Not authorized.

404 The path was not found.

def get_nodes(self, path: str = None, filter_path: str = None) ‑> List[Union[SeriesTreeNodeLeaf, SeriesTreeNodeBranchRef, SeriesTreeNodeBranch]]

Get the nodes of a branch of the series database tree.

OAuth scope: macrobond_web_api.read_structure

Codes

200 The operation was successful.

401 Unauthorized. Missing, invalid or expired access token.

403 Forbidden. Not authorized.