Todos los recursos de la API de Georef aceptan una serie de parámetros comunes que permiten ajustar la forma en que se realiza la consulta y cómo se entrega la respuesta. Estos parámetros son útiles para filtrar, paginar, personalizar y estructurar la información de manera más eficiente.

A continuación se describen los principales:

id

Permite buscar una entidad por su identificador único.
Es útil cuando ya se conoce el ID exacto del registro que se desea obtener.

• Tipo: string (coincidencia exacta)
• Ejemplo: id=060063100

nombre

Permite buscar por nombre aproximado de la entidad.
La API interpreta variantes, errores comunes y diferencias de capitalización.
Es el parámetro más habitual para búsquedas libres.

• Tipo: string (coincidencia aproximada por defecto)
• Ejemplo: nombre=rosario

campos

Permite especificar el o los campos que se desean incluir en la respuesta. Esto permite optimizar el tamaño y el contenido de la respuesta según la necesidad.

• Tipo: lista separada por comas, sin espacios
• Ejemplo: campos=id,nombre,provincia.nombre

Es posible:

• Incluir campos específicos de la entidad o de sus subcomponentes (por ejemplo: provincia.id)
• Utilizar valores especiales que representan conjuntos predefinidos de campos:
  • basico: campos mínimos esenciales
  • estandar: conjunto estándar (valor por defecto)
  • completo: todos los campos disponibles

max

Define la cantidad máxima de resultados que se desean obtener en la respuesta. Es útil para limitar el volumen de datos cuando se trabaja con listados extensos o para controlar la paginación.

• Tipo: entero
• Valor por defecto: 10
• Máximo permitido: 5000
• Ejemplo: max=50

inicio

Cantidad de resultados a saltear.
Permite establecer el índice de inicio para la respuesta, útil para paginar resultados.
Se utiliza en combinación con max.

• Tipo: entero
• Valor por defecto: 0
• Ejemplo: inicio=100 (comienza desde el resultado número 101)

orden

Permite ordenar los resultados de la respuesta según un campo determinado.
El orden es siempre ascendente

• Tipo: string
• Valores permitidos: id o nombre
• Ejemplo: orden=nombre

aplanar

Transforma la estructura jerárquica de la respuesta en una forma más plana.
Cuando está activado, los objetos anidados se reemplazan por campos compuestos.

• Tipo: booleano (true / false)
• Valor por defecto: false
• Ejemplo:

Jerárquico (por defecto):

"provincia": 
 { 
     "id": "06", 
     "nombre": "Buenos Aires" 
 }

Aplanado:

"provincia_id": "06", 
"provincia_nombre": "Buenos Aires"

formato

Permite definir el formato de salida de los resultados devueltos por la API.

• Tipo: string
• Valores posibles:
  • json (valor por defecto)
  • csv
  • geojson
  • shp (ShapeFile, empaquetado como ZIP)
  • xml
• Ejemplos:
  • formato=csv
  • formato=geojson
  • formato=shp

exacto

Aplica una búsqueda estricta por coincidencia exacta, en lugar de aproximada.

• Tipo: booleano (true / false)
• Valor por defecto: false
• Ejemplo: exacto=true (solo devuelve coincidencias idénticas al texto ingresado)

Estos parámetros están disponibles en la mayoría de los endpoints, aunque su efecto puede variar según el tipo de entidad consultada. En la siguiente sección se describen los parámetros específicos de cada recurso.