metadata
======================================

+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| metadata(series=None, big_theme=None, source=None, country=None, frequency=None, unit=None, measure=None, status=None, source_ext=None, source_url=None, last_update=None, code=None, comment=None, name=None, numerica=None, theme_code=None) |
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                                                                                                                                                                                                                                                |
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| series                       | str, optional                     | Time series code. For the available time series run list_series()                                                                                                           |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| big_theme                    | str, optional                     | Big theme by which the return will be fitered. Options: "Macroeconômico", "Regional" or "Social"                                                                            |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| source                       | str, optional                     | Source by which the return will be filtered. For available sources run sources() function.                                                                                  |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| country                      | str, optional                     | Country ID by which the return will be filtered. For available countries and their IDs run countries() function.                                                            |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| frequency                    | str, optional                     | Frequency by which the return will be filtered.                                                                                                                             |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unit                         | str, optional                     | Unit by which the return will be filtered.                                                                                                                                  |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| measure                      | str, optional                     | Measure by which the return will be filtered.                                                                                                                               |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status                       | str, optional                     | Status by which the return will be filtered. Available options: "A" and "I"                                                                                                 |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| source_ext                   | str, optional                     | Source extended name by which the return will be filtered.                                                                                                                  |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| source_url                   | str, optional                     | Source URL by which the return will be filtered.                                                                                                                            |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| last_update                  | str, optional                     | Last update date by which the return will be filtered.                                                                                                                      |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| code                         | str, optional                     | Time series code by which the return will be filtered.                                                                                                                      |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| comment                      | str, optional                     | Time series comment by which the return will be filtered.                                                                                                                   |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name                         | str, optional                     | Time series name by which the return will be filtered.                                                                                                                      |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numerica                     | bool, optional                    | Numeric? True or False.                                                                                                                                                     |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| theme_id                     | str, optional                     | Theme by which the return will be filtered. For available themes run themes() function                                                                                      |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| return                       | pandas.DataFrame                  | If no keyword is specified, returns a data frame containing all Ipeadata's time series. Else, returns only the ones that respects the specified parameters                  |
+------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
`[source] <https://github.com/luanborelli/ipeadatapy/blob/master/ipeadatapy/metadata.py>`__