Module macrobond_data_api.common.types.search_result

Browse git

Classes

class SearchResult

The result of a entity search operation.

Browse git

Ancestors

  • collections.abc.Sequence
  • collections.abc.Reversible
  • collections.abc.Collection
  • collections.abc.Sized
  • collections.abc.Iterable
  • collections.abc.Container
  • typing.Generic

Instance variables

var entities : Sequence[Metadata]

A sequence of the metadata of the entities found.

var is_truncated : bool

Indicates whether the search result was too long and truncated.

Methods

def to_dict(self) ‑> List[Mapping[str, Any]]

Return the result as a dictionary.

Browse git
def to_pd_data_frame(self) ‑> DataFrame

Return the result as a DataFrame.

Browse git