Retorna un listado de localidades.

GET

/localidades

curl --request GET \
  --url 'https://apis.datos.gob.ar/georef/api/localidades?provincia=Santa%20Fe&departamento=Rosario&municipio=Granadero%20Baigorria&localidad_censal=Granadero%20Baigorria&orden=id&aplanar=true&campos=estandar&max=10&inicio=0&exacto=true&formato=json'

Permite realizar búsquedas sobre el listado de localidades.

Parameters

Query Parameters

id

string

>= 1 characters

Filtrar por ID. Se pueden especificar varios IDs separados por comas.

nombre

string

>= 1 characters

Filtrar por nombre.

provincia

string

>= 1 characters

Example

Santa Fe

Filtrar por nombre o ID de provincia. Se pueden especificar varios IDs separados por comas.

departamento

string

>= 1 characters

Example

Rosario

Filtrar por nombre o ID de departamento. Se pueden especificar varios IDs separados por comas.

municipio

string

>= 1 characters

Example

Granadero Baigorria

Filtrar por nombre o ID de municipio. Se pueden especificar varios IDs separados por comas.

localidad_censal

string

>= 1 characters

Example

Granadero Baigorria

Filtrar por nombre o ID de localidad censal. Se pueden especificar varios IDs separados por comas.

orden

string

Allowed values: id nombre

Campo por el cual ordenar los resultados.

aplanar

Example

true

Cuando está presente, muestra el resultado JSON con una estructura plana.

campos

string

>= 1 characters

Example

estandar

Campos a incluir en la respuesta separados por comas, sin espacios. Algunos campos siempre serán incluidos, incluso si no se agregaron en la lista. Para incluir campos de sub-entidades, separar los nombres con un punto, por ejemplo: provincia.id. También se pueden especificar los valores especiales basico, estandar y completo.

max

integer

>= 1 <= 5000

Example

10

Cantidad máxima de resultados a devolver.

inicio

integer

<= 10000

Example

0

Cantidad de resultados a saltear.

exacto

Example

true

Cuando está presente, se activa el modo de búsqueda por texto exacto. Sólo tiene efecto cuando se usan campos de búsqueda por texto (por ejemplo, nombre).

formato

string

Allowed values: json csv geojson xml

Formato de datos en el cual devolver los resultados.

Responses

200

Listado de localidades.

Media typeapplication/json

object

cantidad

integer

total

integer

inicio

integer

parametros

object

localidades

Array<object>

object

departamento

object

id

string

nombre

string

id

string

nombre

string

provincia

object

id

string

nombre

string

municipio

object

id

string

nombre

string

localidad_censal

object

id

string

nombre

string

categoria

string

Allowed values: Entidad (E) Componente de localidad compuesta (LC) Localidad simple (LS) Localidad simple con entidad (LSE) Componente de localidad compuesta con entidad (LCE)

centroide

object

lat

number

lon

number

Example

{
  "cantidad": 10,
  "total": 4901,
  "inicio": 0,
  "parametros": {},
  "localidades": [
    {
      "departamento": {
        "id": "82084",
        "nombre": "Rosario"
      },
      "id": "82084160000",
      "nombre": "Granadero Baigorria",
      "provincia": {
        "id": "82",
        "nombre": "Santa Fe"
      },
      "municipio": {
        "id": "820196",
        "nombre": "Granadero Baigorria"
      },
      "localidad_censal": {
        "id": "82084160",
        "nombre": "Granadero Baigorria"
      },
      "categoria": "Entidad (E)",
      "centroide": {
        "lat": -32.861364,
        "lon": -60.706216
      }
    }
  ]
}

400

Error al procesar la consulta.

Media typeapplication/json

object

errores

Array<object>

object

codigo_interno

integer

mensaje

string

nombre_parametro

string

ubicacion

string

Example

{
  "errores": [
    {
      "codigo_interno": 1000,
      "mensaje": "El parámetro especificado no existe.",
      "nombre_parametro": "prueba",
      "ubicacion": "querystring"
    }
  ]
}