Skip to content

Referencia API: series

Recurso: /series

El recurso /series permite obtener datos y metadatos de una o más series, permitiendo hacer filtros por el índice de tiempo, cambios de granularidad en la dimensión temporal y cambios en la unidad de medida de los valores de la serie, entre otras operaciones.

Tabla de parámetros

Nombre Requerido Descripción Default Ejemplos
ids Si Lista de caracteres alfanuméricos separados por comas.

Contiene la especificación de las series a consultar, junto a transformaciones y operaciones.
N/A ids=2.4_DGI_1993_T_19,134.2_B_0_0_6
representation_mode No Uno de: value, change, percent_change, percent_change_a_year_ago value representation_mode=percent_change
collapse No Uno de: day, week, month, quarter, year La frecuencia propia de la serie collapse=year
collapse=quarter
collapse_aggregation No Uno de: avg, sum, end_of_period, min, max avg collapse_aggregation=sum
limit No Número entero positivo, no mayor que 1000. 100 limit=50
start No Número entero positivo o 0. 0 start=100
start_date No Fecha y hora en formato ISO 8601.

Si no se especifica este parámetro, se devuelven los datos disponibles para la serie o series desde el valor más antiguo.
N/A start_date=2016-11-30
start_date=2016-11
start_date=2016
end_date No Fecha y hora en formato ISO 8601.

Si no se especifica este parámetro, se devuelven los datos disponibles para la serie o series hasta el valor más reciente.
N/A end_date=2016-11-30
end_date=2016-11
end_date=2016
format No Uno de: json, csv json format=csv
header No Uno de: titles, ids, descriptions titles header=ids
sort No Uno de: asc, desc asc sort=desc
metadata No Uno de: none, simple, full, only simple metadata=none
decimal No Caracter utilizado para los decimales.

Uno de: "," o "."
. decimal=,
sep No Caracter separador de los valores del CSV.

Cualquier caracter UTF-8
. sep=|
flatten No Aplana la respuesta de metadatos en un objeto con un único nivel (sin objetos anidados). No es necesario darle valor flatten

ids

Lista separada por comas de los identificadores de las series a seleccionar para armar la respuesta. Los datos del resultado de la llamada tendrán una columna por cada serie seleccionada, en el mismo orden.

Este parámetro es requerido para la llamada. En caso de no suministrarse, se devolverá un error.

Cada identificador de serie podrá ser sufijado con:

Cuando estos atributos se utilizan como parte del parámetro ids, se deben separar usando el caracter ":". El orden de los componentes no incide en el resultado de la operación.

Ejemplos:

ids=2.4_DGI_1993_T_19,134.2_B_0_0_6:change
ids=2.4_DGI_1993_T_19,134.2_B_0_0_6:sum:change
ids=2.4_DGI_1993_T_19,134.2_B_0_0_6:change:sum
ids=2.4_DGI_1993_T_19:percent_change,134.2_B_0_0_6:sum:change
ids=2.4_DGI_1993_T_19:end_of_period:percent_change,134.2_B_0_0_6:sum:change

representation_mode

Este parámetro indica el modo de representación de las series, y se aplica a todas aquellas que no tengan otro modo de representación distinto indicado en el parámetro ids en forma individual.

El modo de representación por defecto es el valor medido en la serie (value).

Los modos de representación disponibles son:

  • value: Es el modo de representación por defecto. Devuelve el valor medido en la serie.
  • change: Devuelve la diferencia absoluta entre el valor del período t y el de t-1.
  • percent_change: Devuelve la variación porcentual entre el valor del período t y el de t-1.
  • percent_change_a_year_ago: Devuelve la variación porcentual entre el valor del período t y el del período t equivalente de hace un año atrás.

Las funciones de transformación disponibles en representation_mode también pueden especificarse para series individuales usando la notación :percent_change junto al id de la serie:

El parámetro representation_mode seguirá afectando a todas las series para las cuales no se especifique individualmente una función de transformación.

collapse

El parámetro collapse modifica la frecuencia de muestreo de los datos de la serie o las series solicitadas. Debe usarse en combinación con collapse_aggregation para indicar una funnción de agregación temporal, cuando corresponda.

Las opciones disponibles son:

  • year: Muestra datos agregados anualmente.
  • quarter: Muestra datos agregados trimestralmente.
  • month: Muestra datos agregados mensualmente.
  • week: Muestra datos agregados semanalmente.
  • day: Muestra datos agregados diariamente.

Si no se indica, se retornan los datos con la frecuencia original de la serie.

Si se solicitan múltiples series de distintas frecuencias, se utilizará la menor frecuencia de todas ellas (Ej.: si se solicitan a la vez una serie diaria, una mensual y una trimestral, se convertirán todas las series a la frecuencia trimestral).

Si la granularidad temporal solicitada en el valor de collapse es menor a la granularidad propia de alguna de las series solicitadas, la consulta devolverá un error.

El parámetro collapse afecta globalmente a todas las series seleccionadas por el parámetro ids en la llamada.

collapse_aggregation

El parámetro collapse_aggregation indica la función de agregación temporal que debe usarse para homogeneizar la frecuencia temporal de todas las series solicitadas (Ej.: qué operación realizar para convertir una serie mensual en anual).

Esta función de agregación actuará sobre:

  • Las series agrupadas de mayor granularidad temporal (frecuencia más alta) que la granularidad indicada por el parámetro collapse
  • En caso de que no se especifique el parámetro collapse, las series agrupadas de mayor granularidad temporal que la de la serie de menor frecuencia temporal.

Los valores disponibles para el parámetro son:

  • avg: Realiza el promedio de todos los valores agrupados. Es la opción por defecto si no se indica valor para collapse_aggregation.
  • sum: Suma todos los valores agrupados.
  • end_of_period: Último valor del período.
  • min: Mínimo entre los valores agrupados.
  • max: Máximo entre los valores agrupados.

Las funciones de agregación temporal disponibles en collapse_aggregation también pueden especificarse para series individuales usando la notación :sum junto al id de la serie:

El parámetro collapse_aggregation seguirá afectando a todas las series para las cuales no se especifique individualmente una función de agregación temporal.

limit

Este parámetro es utilizado junto a start para controlar el paginado de los resultados devueltos por la API. 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

Este parámetro es utilizado junto a limit para controlar el paginado de los resultados devueltos por la API. Debe especificarse un número entero positivo o 0. El valor por defecto si no se especifica valor alguno es 0.

El start indica el "número de períodos después de start_date" (o el "número de períodos antes de end_date", dependiendo del ordenamiento asc o desc del parámetro sort) que se saltean desde el comienzo o el final de la serie antes de empezar a devolver valores.

start_date

El parámetro start_date indica la fecha menor a partir de la cual se comenzarán a recolectar datos para la respuesta. Los valores cuyo índice de tiempo coincida con el valor de start_date se incluirán en el resultado retornado. Se utilizará como filtro sobre el índice de tiempo de las series de datos.

end_date

El parámetro end_date indica la fecha mayor hasta la cual se recolectarán datos para la respuesta. Los valores cuyo índice de tiempo coincida con el valor de end_date se incluirán en el resultado retornado. Se utilizará como filtro sobre el índice de tiempo de las series de datos.

format

Especifica el formato de la respuesta, siendo json el valor por defecto.

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.

Especifica los atributos de las series a utilizar como headers (cabeceras) de las columnas del archivo CSV generado. Por defecto usa titles, que son los títulos de las series.

Las opciones disponibles son:

  • titles: Títulos de las series, por ejemplo oferta_global_pib (default).
  • 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

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 (default).
  • desc: Se devuelven los valores más recientes primero.

metadata

Especifica el nivel de detalle de metadatos requerido por el usuario, siendo simple el valor por defecto. Sólo aplica cuando format=json.

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 (default).
  • full: Se devuelven todos los metadatos disponibles que tengan relación con cada serie.

decimal

Especifica el caracter utilizado para los números decimales, siendo . el valor por defecto. Sólo aplica cuando format=csv.

Las opciones disponibles son:

  • ,: Coma.
  • .: Punto.

sep

Especifica el caracter separador de valores, siendo , el valor por defecto. Sólo aplica cuando format=csv.

Se puede utilizar cualquier caracter UTF-8, si bien se recomienda preservar el uso de la coma en la mayoría de los casos.

flatten

Especifica si la respuesta de los metadatos de las series pedidas deberían devolverse en una jerarquía plana.

Cuando el parámetro no es incluido, la respuesta tiene la siguiente estructura:

    {
        "catalog": [<catalog_meta>],
        "dataset": [<dataset_meta>],
        "distribution": [<distribution_meta>],
        "field": [<field_meta>],
    }

Una consulta con parámetro flatten incluido tendrá la siguiente respuesta de metadatos:

    {
        catalog_meta1: ...,
        catalog_meta2: ...,
        dataset_meta1: ...,
        <nivel>_<meta_key>: <meta_value>
        ...
    }