Module `macrobond_data_api.web.web_types.unified_series_request`

Classes

class UnifiedSeriesEntry (*args, **kwargs)

Request of a list of series converted to the same calendar

var missingValueMethod : SeriesMissingValueMethod | None: The method for filling in missing values. The default is the automatic method.
var name : str: The name of the series.
var partialPeriodsMethod : SeriesPartialPeriodsMethod | None: The method to use for converting partial periods to lower frequency. The default is not to extend the series.
var toHigherFrequencyMethod : SeriesToHigherFrequencyMethod | None: The method to converting to higher frequency. The default is the automatic method.
var toLowerFrequencyMethod : SeriesToLowerFrequencyMethod | None: The method to converting to lower frequency. The default is the automatic method.
var vintage : str | None: The vintage of the series. The default is the latest version of the series.

class UnifiedSeriesRequest (*args, **kwargs)

Request of a list of series converted to the same calendar

var calendarMergeMode : CalendarMergeMode | None: The merge mode determines how the series calendars are used when forming the new shared calendar. The default is to use all observations that are in any calendar.
var currency : str | None: The currency to use for currency conversion or omitted for no conversion.
var endDateMode : CalendarDateMode | None: The end date mode determines how the end date is calculated. By default the mode is to end when there is no data in any series.
var endPoint : str | None: The end point. By default, this is determined by the endDateMode. It can be a date on the format yyyy-mm-dd or a number of observations relative the end of the series.
var frequency : SeriesFrequency | None: The frequency to convert all series to. The default is to convert to the highest frequency of the series in the request.
var seriesEntries : List[UnifiedSeriesEntry]: The list of series entries that defines the series to request.
var startDateMode : CalendarDateMode | None: The start date mode determines how the start date is calculated. By default the mode is to start when there is data in any series.
var startPoint : str | None: The start point. By default, this is determined by the startDateMode. It can be a date on the format yyyy-mm-dd or a number of observations relative the end of the series.
var weekdays : SeriesWeekdays | None: The days of the week used for daily series. The default is Monday to Friday.