Module macrobond_data_api.common.types.entity

Classes

class Entity

Represents a Macrobond entity.

Browse git

Subclasses

• Series

Instance variables

var entity_type : str

The type of the entity. Common types are TimeSeries, Region, Release and Source.

Browse git

var error_message : str

Contains an error message if Entity.is_error is True.

var is_discontinued : bool

Returns True if the entity is discontinued and no longer updated.

Browse git

var is_error : bool

True if there was an error downloading this entity. Entity.error_message will contain any error message.

Browse git

var last_modified : datetime.datetime

The time of the last modification of the entity.

Browse git

var metadata : Metadata

The metadata of the entity.

var name : str

The name of the entity.

var primary_name : str

The primary name of the entity. This can be different from the name requested if an alias was used in the request.

Browse git

var status_code : StatusCode

The status code of the Entity

var title : str

The title of the entity.

Browse git

Methods

def metadata_to_pd_series(self, name: str = None) ‑> Series

Returns a Pandas series containing all the metadata.

Browse git

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

Returns a dictionary containing all the metadata.

Browse git