API reference: search
Endpoint: /search
/search endpoint allows to look for series using a string, being able to filter results with other attributes (ie.: by theme or units).
Parameters
| Name | Required | Type | Default | Examples |
|---|---|---|---|---|
| q | Yes | String | N/A | q=ipc |
| dataset_theme | No | One of the listed values in /search/dataset_theme | N/A | dataset_theme="Finanzas Públicas" |
| units | No | One of the listed values in /search/field_units | N/A | units="Millones de pesos" |
| dataset_publisher_name | No | One of the listed values in /search/dataset_publisher_name | N/A | dataset_publisher_name="Subsecretaría de Programación Macroeconómica." |
| dataset_source | No | One of the listed values in /search/dataset_source | N/A | dataset_source="Ministerio de Hacienda" |
| catalog_id | No | One of the listed values in /search/catalog_id | N/A | catalog_id="sspm" |
| limit | No | Positive integer, not greater than 1000. | 10 | limit=50 |
| start | No | Positive integer or 0. | 0 | start=100 |
q
String to input for looking in the database. It can be of any long, but is recommended to input one or more key words.
dataset_theme, units, dataset_publisher_name, dataset_source, catalog_id
These parameters can be used as filters in the search results. When applied, only matching results are shown.
Example: units=Millones de pesos will only contain results where units series are in "millones de pesos".
Valid filtering values for the parameters are specified in auxiliary endpoints of search main one that return a complete list of accepted values in the filters.
Example: /search/field_units returns a list of valid values to be used with units parameter. Any other option will return an empty list (because there will be no matches). Parameters table have all auxiliary endpoints available.
limit
Parameter used together with start to control pagination of API call results. Must be a positive integer not greater than 1000. Default value is 100.
start
Parameter used together with limit to control pagination of API call results. Must be a positive integer or 0. Default value is 0.
start parameter indicates the "number of periods after start_date" (or the "number of periods before end_date", depending on asc or desc sorting criteria specified on sort parameter) that should be skipped from beginning or end of the series before staring to return values.