Module macrobond_data_api.common.types.unified_series

Classes

class UnifiedSeries

Represents a Macrobond time series in the response from Api.get_unified_series().

Browse git

Instance variables

var error_message

Contains an error message if UnifiedSerie.is_error is True.

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 metadata

The metadata of the series.

Browse git

var name

The name of the requested series.

Browse git

var values

The values of the series.

Browse git

Methods

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

Browse git

class UnifiedSeriesDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Browse git

Ancestors

• builtins.dict

Class variables

var Dates : Sequence[datetime.datetime]

var Series : Sequence[Dict[str, Any]]

class UnifiedSeriesList

The response from Api.get_unified_series().

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 dates : Sequence[datetime.datetime]

The dates of the observations

Browse git

var is_error : bool

True if any of the series has an error.

Browse git

var series : Sequence[UnifiedSeries]

The list of series

Browse git

Methods

def get_errors(self) ‑> Dict[str, str]

Browse git

def to_dict(self) ‑> UnifiedSeriesDict

Browse git

def to_pd_data_frame(self) ‑> DataFrame

Browse git