Métodos genéricos
Todas las librerías tienen los mismos métodos, por tanto cubriremos sus nombres y sus parámetros aquí. Así evitamos duplicar información.
Un método tiene el mismo nombre que la parte final (acción) de cualquier URL usada para hacer una petición a GeoAPI, entre el ultimo / y justo antes de los parámetros. Por ejemplo:
| URL | Método |
|---|---|
| apiv1.geoapi.es/comunidades | comunidades() |
| apiv1.geoapi.es/poblaciones?CPRO=22&CMUM=907 | poblaciones() |
Listado completo de acciones y sus parámetros
Todos los parámetros son obligatorios, al menos que se especifique lo contrario.
| Acción | Parámetros | Descripción |
|---|---|---|
| calles | CPRO, CMUM, CUN, CPOS | Devuelve un listado completo de todas las calles |
| comunidades | Devuelve un listado de todas las comunidades | |
| cps | CPRO, CMUM, CUN | Devuelve un listado de todos los códigos postales |
| municipios | CPRO | Devuelve un listado de todos los municipios |
| nucleos | CPRO, CMUM, NENTSI50 | Devuelve un listado de los núcleos de un municipio. Suele haber, aunque no se limita, 1 núcleo que representa el municipio en sí y un núcleo DISEMINADO que representa áreas, caminos, carreteras, fincas, etc, más alejadas del municipio, pero que están dentro de los límites territoriales del mismo e incluso llegan a compartir código postal con éste. |
| poblaciones | CPRO, CMUM | Devuelve un listado de todas las poblaciones |
| provincias | CCOM | Devuelve un listado de una o de todas las provincias. CCOM no es obligatorio. |
| qcalles | QUERY | Ésta es una acción especial que acepta cadenas de texto y realiza búsquedas basándose en los nombres de las calles. Es decir, es una búsqueda libre para calles. |