Series¶

class leveropen.l_series.LSeries(uuid: str, name: str, units: str, magnitude: str, link: str, date_time: dict, location: dict, categories: List[dict], client: leveropen.client.Client)¶

Represents a Lever Open data series

Parameters

uuid (str) – unique id
name (str) – series name
units (str) – Unit type
magnitude (str) –
link (str) – URL of series
date_time (dict) – e.g. {'name': 'Month', 'range': ['January 1997', 'December 2020']}
location (dict) – e.g. {'type': 'Country', 'name': 'UK'}
categories (List[dict]) – e.g. [{'type': 'Adjustment', 'name': 'Seasonally adjusted'}, {'type': 'Total', 'name': 'Monthly GDP'}]
client (leveropen.client.Client) – API Client

get_categories() → pandas.core.frame.DataFrame¶

Returns: Type and Categories
Return type: pandas.DataFrame
Example

>>> self.get_categories()

         type                 name
0  Adjustment  Seasonally adjusted
1       Total          Monthly GDP

get_data() → pandas.core.frame.DataFrame¶

Returns

Values of the Series data

Columns: ['Value', 'DateTime', 'DateFrom', 'DateTo', 'SeriesName', 'Country']

Index: pd.DatetimeIndex

Return type

pandas.DataFrame

Example

>>> self.get_data()
            Value    ... Country
1997-01-01  6.7701   ...      UK
1997-02-01  8.9410   ...      UK
1997-03-01  1.9841   ...      UK
1997-04-01  5.6258   ...      UK
1997-05-01  10.2138  ...      UK