Module macrobond_data_api.web.web_types.search_methods
Classes
class SearchMethods (session: Session)-
Search for time series and other entites
Methods
def entities_for_display(self, request: SearchForDisplayRequest) ‑> SearchForDisplayResponse-
Search for time series and other entites matching attribute values and return the selected metadata formatted for presentation purposes.
OAuth scope: macrobond_web_api.read_structure
Codes
200 The operation was successful.
400 Request failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
404 At least one attribute was not found.
def filter_lists(self, entity_type: str) ‑> List[ItemListingResponse]-
Get a structured list of all saved filter lists of the specified type.
OAuth scope: macrobond_web_api.read_structure or macrobond_web_api.search_mb
Codes
200 The operation was successful.
400 Request failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
def get_entities(self, entity_type: List[str] = None, text: str = None, include_discontinued: bool = None, no_meta_data: bool = None, allow_long_result: bool = None) ‑> SearchResponse-
Search for time series and other entites matching attribute values. If the same attribute name is specified more than once, then entities matching any of them will be included. If the value is *, any value will match. If ! is specified before an attribute name, entities matching the value will be excluded instead of included.
OAuth scope: macrobond_web_api.search_mb
Codes
200 The operation was successful.
400 Request failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
404 At least one attribute was not found.
def post_entities(self, request: SearchRequest) ‑> SearchResponse-
Search for time series and other entites matching attribute values.
OAuth scope: macrobond_web_api.search_mb
Codes
200 The operation was successful.
400 Request failed.
401 Unauthorized. Missing, invalid or expired access token.
403 Forbidden. Not authorized.
404 At least one attribute was not found.