Permite, a partir de identificadores, obtener los valores de una o más series de tiempo.También permite filtrar dichos valores o realizar operaciones con los mismos.

GET

/series

const url = 'http://apis.datos.gob.ar/series/api/series?ids=example&representation_mode=value&collapse=year&collapse_aggregation=avg&limit=100&start=0&format=json&header=titles&sort=asc&metadata=none&decimal=.&sep=%2C';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://apis.datos.gob.ar/series/api/series?ids=example&representation_mode=value&collapse=year&collapse_aggregation=avg&limit=100&start=0&format=json&header=titles&sort=asc&metadata=none&decimal=.&sep=%2C'

Mediante este endpoint, la API permite acceder a los valores de una o varias series a partir de sus identificadores únicos. También da la posibilidad de filtrar por fechas para sólo obtener datos de un período específico. Así mismo permite cambiar los intervalos de tiempo utilizados por la serie, las unidades de medida con que están representados los valores, entre otras cosas.

Parameters

Query Parameters

ids

required

Array<string>

Parámetro obligatorio que consiste en el indentificador único de la serie o de las series cuyos valores queremos consultar. Si son varias series, sus ids se deben enlistar separándolos por comas. Se pueden obtener los ids de las series en la columna ‘serie_id’ del siguiente csv: https://apis.datos.gob.ar/series/api/dump/series-tiempo-metadatos.csv. .

representation_mode

string

default: value

Allowed values: value change percent_change change_a_year_ago percent_change_a_year_ago

Este parámetro opcional da la posibilidad de consultar la variación que han experimentado los valores de una serie. En otras palabras, que tanto aumentaron o disminuyeron periodo a periodo. Las opciones son:

change: Muestra la diferencia que hay entre los valores consecutivos de una serie.
percentage_change: Lo mismo que ‘change’ pero esa diferencia se expresa porcentualmente.
change_a_year_ago: En cada período se muestra la diferencia respecto al mismo período del año anterior.
percentage_change_a_year_ago: En cada período, se muestra la diferencia porcentual respecto al mismo período del año anterior.
value: Opción por defecto. No muestra variación ni diferencia, sino que arroja los valores de la serie.

Ejemplos:

Si el IPC de marzo fue 0.11 y el de abril 0.088, usando el parámetro ‘change’ obtendremos un valor de -0.022 para abril.
Si el IPC de marzo fue 0.11 y el de abril 0.088, usando el parámetro ’percentage_change’obtendremos un valor de -2.2% para abril.
Si el IPC de marzo 2023 fue 0.077 y el de marzo 2024 fue 0.11, usando el parámetro ‘change_a_year_ago’ obtendremos un valor de 0.033 para abril 2024.
Si el IPC de marzo 2023 fue 0.077 y el de marzo 2024 fue 0.11, usando el parámetro ‘percentage_change_a_year_ago’ obtendremos un valor de 3.3% para abril 2024.

collapse

string

Allowed values: year quarter semester month week day

El parámetro opcional ‘collapse’ permite modificar el intervalo de tiempo utilizado por la serie. Si no se indica nada en este parámetro, se mantiene la frecuencia original de la serie. Las opciones disponibles son:

year: la API transforma los datos de la serie para mostrarlos con frecuencia anual.
quarter: la API transforma los datos de la serie para mostrarlos con frecuencia trimestral.
semester: la API transforma los datos de la serie para mostrarlos con frecuencia semestral.
month: la API transforma los datos de la serie para mostrarlos con frecuencia mensual.
week: la API transforma los datos de la serie para mostrarlos con frecuencia semanal.
day: Muestra los datos con frecuencia diaria.

Observaciones:

Cada serie tiene una frecuencia original, si en este parámetro se indica una frecuencia más alta que esta (ejemplo ‘week’ para una serie que es originalmente mensual), la API arrojará error.
Si se están consultando varias series al mismo tiempo, el parámetro ‘collapse’ afecta a todas ellas y debe ser válido para todas.
Salvo que se de otras indicaciones en el parámetro ‘collapse_aggregation’, los datos que se obtienen al aplicar el parámetro collapse, son promedios

collapse_aggregation

string

default: avg

Allowed values: avg sum end_of_period min max

Este parámetro opcional da la posibilidad de obtener los promedios, la sumatoria de los valores y los valores máximos y mínimos de una serie de tiempo. Estos datos podrán ser anuales, semestrales, trimestrales, mensuales o semanales según lo que se haya especificado en el parámetro ‘collapse’. Los valores disponibles para el parámetro son:

avg: Promedia los valores del intervalo. Es la opción por defecto.
sum: Suma todos los valores del intervalo.
end_of_period: Brinda el último valor del intervalo.
min: Mínimo valor del intervalo.
max: Máximo valor del intervalo.

Observaciones:

Para que ‘collapse_aggregation’ funcione es necesario brindar un valor en collapse que sea válido y no de error.
Si se está consultando por varias series, no es obligatorio especificar nada en el parámetro ‘collapse’, se tomará
por defecto el intervalo de la serie con intervalos más largos (si tengo una serie mensual y otra semestral, se calcularán valores por semestre).

limit

integer

default: 100 >= 1 <= 1000

Este parámetro opcional permite especificar la cantidad máxima de valores que se desean obtener. Debe especificarse un número entero positivo, no mayor que 1000, ya que esa es la cantidad máxima de resultados devueltos por la API. El valor por defecto si no se especifica valor alguno es 100.

start_date

string

Fecha y hora en formato ISO 8601. En el parámetro ‘start_date’ se especifica la fecha a partir de la cual nos interesa obtener datos. Admite AAAA-MM o AAAA-MM-DD.

end_date

string

Fecha y hora en formato ISO 8601. El parámetro ‘end_date’ indica la última fecha de la que nos interesa obtener datos.Admite AAAA-MM o AAAA-MM-DD

start

integer

El parámetro opcional ‘start’ nos permite hacer un filtro extra y excluir valores de la serie.Se debe brindar un entero positivo que corresponderá a la cantidad de valores que se dejarán afuera, contando desde el comienzo de la serie.

format

string

default: json

Allowed values: json csv

Este parámetro opcional nos permite especificar en qué formato deseamos los datos solicitados. Las opciones disponibles son:

json: Devuelve un objeto json con datos y metadatos de las series.
csv: Devuelve las series seleccionadas en formato separado por comas. Este tipo de formato no incluye metadatos de las series seleccionadas.

header

string

default: titles

Allowed values: titles ids descriptions

Este parámetro opcional sólo se puede usar si se ha elegido format= csv. Con él especificamos como queremos que sean los ‘headers’ de nuestro csv. Las opciones disponibles son:

titles: Títulos de las series, por ejemplo ‘oferta_global_pib’ (especificación por defecto).
ids: Identificadores únicos de las series, los mismos pasados al parámetro ids.
descriptions: Descripciones completas de las series, por ejemplo ‘Plazo fijo entre 60-89 días en millones de pesos. Categoría II-VI’.

sort

string

default: asc

Allowed values: asc desc

Especifica el orden temporal de los resultados devueltos, siendo asc el valor por defecto.Las opciones disponibles son:

asc: Se devuelven los valores más antiguos primero (indicación por defecto).
desc: Se devuelven los valores más recientes primero.

metadata

string

default: simple

Allowed values: none only simple full

Este parámetro opcional, sólo lo podemos usar si hemos seleccionado format=json. Especifica el nivel de detalle de metadatos deseado.Las opciones disponibles son:

none: No se devuelven metadatos, sólo datos.
only: No se devuelven datos, sólo metadatos.
simple: Se devuelven los metadatos más importantes para comprender y utilizar las series (especificación por defecto).
full: Se devuelven todos los metadatos disponibles que tengan relación con cada serie.

decimal

string

default: .

Allowed values: . ,

Sólo aplica cuando format=csv.Especifica el caracter utilizado para los números decimales, siendo el punto (.) el valor por defecto. Las opciones disponibles son:

,: Coma.
.: Punto.

sep

string

default: ,

Sólo aplica cuando format=csv. Especifica el caracter separador de valores, siendo la coma (,) el valor por defecto. Se puede utilizar cualquier caracter UTF-8, si bien se recomienda preservar el uso de la coma en la mayoría de los casos.

last

integer

<= 1000

Este parámetro opcional no se debe usar en conjunto con ‘start’, ‘sort’ o ‘limit’. Consiste en un número entero y permitirá obtener los últimos valores de la serie, tantos como el número que hayamos indicado.

Responses

200

La consulta se ejecutó exitosamente

application/json

Array<object>

object

data

object

meta

object

params

object

Example^generated

[
  {
    "data": {},
    "meta": {},
    "params": {}
  }
]

400

Solicitud incorrecta

Permite, a partir de identificadores, obtener los valores de una o más series de tiempo.También permite filtrar dichos valores o realizar operaciones con los mismos.

Parameters

Query Parameters

Responses

200

Examplegenerated

400

Example^generated