(string): Code of the series. For further information about codes click this link.

(int): number of periods to retrieve. By default is set to 1 period.

(string): the initial date of the requested data. The required format is yyyy/mm/dd. Additionally, dateStart can be a vector of dates, where each date represents the start date of individual ranges where the end date should be found at the same position in the dateEnd vector. If dateStart and dateEnd are equal, the specified dates are retrieved. If no end date is entered, all dates will be queried, from the corresponding start date to the last available period.

(string): the end date of the requested data. The required format is yyyy/mm/dd. Additionally, dateEnd can be a vector of dates, where each date represents the end date of individual ranges where the initial date should be found at the same position in the dateStart vector. The length of the dateEnd vector must be less than or equal to the length of the dateStart vector.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.

(logical): print additional information, including the URL to call the API service.

(logical): set to TRUE to obtain a single data frame of data

(string): Code of the operation. To obtain a list of available operations see get_metadata_operations().

(list): list of variables and values.

Filtering data from series

When we request data from series there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. To get variables for a given operation see get_metadata_variables() and to get values for a specific variable see get_metadata_values(). See also get_metadata_series_varval() to get all the values at once.

Filter format

The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Using shortcuts

Additionally, shortcuts can be used to filter. They simplify the filtering approach by using standardized names for variable IDs and therefore simplify their use. The format is: list(shortcut_variable1 = name1, shortcut_variable2 = name2). Besides, the values wrapper can also be used: ⁠list(values = c(name1, name2)⁠. To see a list of all available shortcuts, see get_filter_shortcuts() function. Let’s also remark that for better performance is recommended to use numeric codes.

(int): id of the periodicity of the series. Common periodicities: 1 (monthly), 3 (quarterly), 6 (bi-annual), 12 (annual). To obtain a list of periodicities see get_metadata_periodicity().

(int): number of periods to retrieve. By default is set to 1 period.

(string): the initial date of the requested data. The required format is yyyy/mm/dd. Additionally, dateStart can be a vector of dates, where each date represents the start date of individual ranges where the end date should be found at the same position in the dateEnd vector. If dateStart and dateEnd are equal, the specified dates are retrieved. If no end date is entered, all dates will be queried, from the corresponding start date to the last available period.

(string): the end date of the requested data. The required format is yyyy/mm/dd. Additionally, dateEnd can be a vector of dates, where each date represents the end date of individual ranges where the initial date should be found at the same position in the dateStart vector. The length of the dateEnd vector must be less than or equal to the length of the dateStart vector.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated. Default value is set to 1.

(logical): validate the input parameters. A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

(logical): print additional information, including the URL to call the API service.

(logical): obtain a single data frame of data

(int): id of the table. For further information about ids click this link.

(list): list of variables and values.

Filtering data from tables

When we request data from tables there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. See get_metadata_table_varval() to get all the values at once. There are different approaches to build the filter depending on the table type.

Case one: tempus table

URL example. For a tempus table the filter is based on ids. The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Case two: px tables

URL example. For a px table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

Case three: tpx table

URL example. For a tpx table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

URL example. There are tpx tables that contain variable ids and value ids. In this case, we can use the ids instead of the codes to build the filter. To do this we add the alias ~id at the end of each id: ⁠list(id_variable1~id = id_value1~id, id_variable2~id = id_value2~id)⁠.

Using shortcuts

Additionally, shortcuts can be used to filter. They simplify the filtering approach by using standardized names for variable IDs and therefore simplify their use. The format for a tempus table is: list(shortcut_variable1 = name1, shortcut_variable2 = name2). However, for px and tpx tables the format is: ⁠list(values = c(name1, name2)⁠. The values wrapper can also be used with tempus tables. To see a list of all available shortcuts, see get_filter_shortcuts() function. Let’s also remark that for better performance is recommended to use numeric ids for tempus tables and alphanumeric codes for px and tpx tables.

(int): number of periods to retrieve. By default it retrieves all available periods.

(string): the initial date of the requested data. The required format is yyyy/mm/dd. Additionally, dateStart can be a vector of dates, where each date represents the start date of individual ranges where the end date should be found at the same position in the dateEnd vector. If dateStart and dateEnd are equal, the specified dates are retrieved. If no end date is entered, all dates will be queried, from the corresponding start date to the last available period.

(string): the end date of the requested data. The required format is yyyy/mm/dd. Additionally, dateEnd can be a vector of dates, where each date represents the end date of individual ranges where the initial date should be found at the same position in the dateStart vector. The length of the dateEnd vector must be less than or equal to the length of the dateStart vector.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate the input parameters. A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

(logical): print additional information, including the URL to call the API service.

(logical): set to TRUE to obtain a single data frame of data.

(logical): set to TRUE to extract the name of the values that defined the table. The names are extracted from the metadata information (it is mandatory to include 'M' in the tip parameter). Several columns are created corresponding to the values of the different variables.

(logical): set to TRUE to extract the codes and ids of the values that defined the table. The codes and ids are extracted from the metadata information (it is mandatory to include 'M' in the tip parameter). Several columns are created corresponding to the values of the different variables.

(string): language. Set to 'ES' for the Spanish version of the shortcuts or set to 'EN' for the English version of the shortcuts.

(logical): validate input parameters.

(logical): print additional information.

(string): Code of the operation. Provide code to get all the classifications for the given operation. To obtain a list of available operations see get_metadata_operations(). If no operation is specified then all the classifications will be shown.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): id of the table. For further information about ids click this link.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. To obtain a list of available operations see get_metadata_operations(). If no operation is specified then all the operations will be shown

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): set to 0 for operations with national data or set to 1 for operations with data with a greater level of disaggregation.

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(string): Code of the operation. Provide code to get all the periodicities for the given operation. To obtain a list of available operations see get_metadata_operations(). If no operation is specified then all the periodicities will be shown.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): id of the publication. To obtain a list of available publications see get_metadata_publications().

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. Provide code to get all the publications for the given operation. To obtain a list of available operations see get_metadata_operations(). If no operation is specified then all the publications will be shown.

(int): level of detail. Valid values: 0, 1 or 2.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(string): code of the series. For further information about codes click this link.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. To obtain a list of available operations see get_metadata_operations().

(list): list of variables and values.

Filtering data from series

When we request data from series there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. To get variables for a given operation see get_metadata_variables() and to get values for a specific variable see get_metadata_values(). See also get_metadata_series_varval() to get all the values at once.

Filter format

The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Using shortcuts

Additionally, shortcuts can be used to filter. They simplify the filtering approach by using standardized names for variable IDs and therefore simplify their use. The format is: list(shortcut_variable1 = name1, shortcut_variable2 = name2). Besides, the values wrapper can also be used: ⁠list(values = c(name1, name2)⁠. To see a list of all available shortcuts, see get_filter_shortcuts() function. Let’s also remark that for better performance is recommended to use numeric codes.

(int): id of the periodicity of the series. Common periodicities: 1 (monthly), 3 (quarterly), 6 (bi-annual), 12 (annual). To obtain a list of periodicities see get_metadata_periodicity().

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated. Default value is set to 1.

(logical): validate input parameters. A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. To obtain a list of available operations see get_metadata_operations().

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated. Default value is set to 1.

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): id of the table. For further information about ids click this link.

(list): list of variables and values.

Filtering data from tables

When we request data from tables there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. See get_metadata_table_varval() to get all the values at once. There are different approaches to build the filter depending on the table type.

Case one: tempus table

URL example. For a tempus table the filter is based on ids. The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Case two: px tables

URL example. For a px table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

Case three: tpx table

URL example. For a tpx table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

URL example. There are tpx tables that contain variable ids and value ids. In this case, we can use the ids instead of the codes to build the filter. To do this we add the alias ~id at the end of each id: ⁠list(id_variable1~id = id_value1~id, id_variable2~id = id_value2~id)⁠.

Using shortcuts

Additionally, shortcuts can be used to filter. They simplify the filtering approach by using standardized names for variable IDs and therefore simplify their use. The format for a tempus table is: list(shortcut_variable1 = name1, shortcut_variable2 = name2). However, for px and tpx tables the format is: ⁠list(values = c(name1, name2)⁠. The values wrapper can also be used with tempus tables. To see a list of all available shortcuts, see get_filter_shortcuts() function. Let’s also remark that for better performance is recommended to use numeric ids for tempus tables and alphanumeric codes for px and tpx tables.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters. A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

(logical): print additional information, including the URL to call the API service.

(logical): set to TRUE to extract the name of the values that defined the table. The names are extracted from the metadata information (it is mandatory to include 'M' in the tip parameter). Several columns are created corresponding to the values of the different variables.

(logical): set to TRUE to extract the codes and ids of the values that defined the table. The codes and ids are extracted from the metadata information (it is mandatory to include 'M' in the tip parameter). Several columns are created corresponding to the values of the different variables.

(string): code of the series. For further information about codes click this link.

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. To obtain a list of available operations see get_metadata_operations().

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): level of detail. Valid values: 0, 1 or 2.

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): id of the table. For further information about ids click this link.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.

(logical): print additional information, including the URL to call the API service.

(int): id of the table. For further information about ids click this link.

(int): id of the group of variables. To get all groups for a specific table see get_metadata_table_groups().

(int): level of detail. Valid values: 0, 1 or 2.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): id of the table. For further information about ids click this link.

(int): level of detail. Valid values: 0, 1 or 2.

(list): list of variables and values.

Filtering data from tables

When we request data from tables there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. There are different approaches to build the filter depending on the table type.

Case one: tempus table

URL example. For a tempus table the filter is based on ids. The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Case two: px tables

URL example. For a px table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

Case three: tpx table

URL example. For a tpx table the filter is based on codes. The format is list(cod_variable1 = cod_value1, cod_variable2 = cod_value2). Besides:

• A variable can take more than one value: list(cod_variable1 = c(cod_value11, cod_value12), id_variable2 = cod_value2).

• A variable can take a empty character "" to get all its possible values: list(cod_variable1 = cod_value1, cod_variable2 = "").

URL example. There are tpx tables that contain variable ids and value ids. In this case, we can use the ids instead of the codes to build the filter. To do this we add the alias ~id at the end of each id: ⁠list(id_variable1~id = id_value1~id, id_variable2~id = id_value2~id)⁠.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(logical): validate input parameters.A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. To obtain a list of available operations see get_metadata_operations().

(int): level of detail. Valid values: 0, 1 or 2.

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

(int): set to 0 for national tables or set to 1 for tables with a greater level of disaggregation.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(string): code of the operation. Provide code to get all the values for the given operation. To obtain a list of available operations see get_metadata_operations().

(int): id of a variable. To obtain a list of available variables see get_metadata_variables().

(int): id of a value. If an id value is specified, the children of the value are requested. To obtain a list of available values for a variable use get_metadata_values(variable = id_variable).

(int): level of detail. Valid values: 0, 1 or 2.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(int): id of a classification. To obtain a list of available classifications see get_metadata_classifications().

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.

(int): depth of the hierarchy tree.

(list): list of variables and values. When we request the hierarchy tree there is the possibility of filtering using metadata information about the variables and their values that define the series. The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

• A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).

• A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

(string): Code of the operation. Provide code to get all the variables for the given operation. To obtain a list of available operations see get_metadata_operations(). If no operation is specified then all the variables will be shown.

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

(int): level of detail. Valid values: 0, 1 or 2.

(int): page number. The retrieved result of the query is paginated (page=0 retrieves all pages).

(logical): validate input parameters. A FALSE value means fewer API calls.

(logical): print additional information, including the URL to call the API service.