GeoAPI (1.0.0)

Download OpenAPI specification:

Jerarquía de los datos

Recomendamos encarecidamente tener en todo momento abierta la página de prueba de la API y, usando los desplegables, seleccionar lugares conocidos para poder entender mejor las explicaciones a continuación. Visualizar los lugares usando Google Maps o cualquier otro servicio de mapas también puede ser de gran ayuda.

Para entender la jerarquía de los datos, ayuda pensar en los mismos como si fueran una estructura de árbol invertido. En la parte mas alta están las comunidades, seguidas de las provincias, luego los municipios, etc... hasta llegar a las vías (calles, avenidas, plazas, etc...).

Veamoslo con mas detalle:

Comunidad
    │
Provincia
    │
Municipio
    │
    ├─ Entidad colectiva
    │
Población (Entidad singular)
    │
Núcleo urbano / Zona diseminada
    │
Vías / Pseudovías
  • Comunidad: Entidad territorial dotada de autonomía. Por ejemplo, Andalucía, Cataluña, etc...
  • Provincia: Demarcación administrativa usada para dividir las comunidades autónomas. Por ejemplo, Almería, Barcelona, etc...
  • Municipio: Entidad local básica usara para dividir las provincias. Por ejemplo, Abla (Almería), Abrera (Barcelona)
    • De los municipios pueden derivar directamente las poblaciones (entidades singulares) o las entidades colectivas.
  • Entidad colectiva: No son comunes. En ciertas regiones de España, varias poblaciones (entidades singulares) pueden estar agrupadas en una entidad colectiva. Según cada región, estas entidades colectivas pueden tener diferentes nombres. Por ejemplo, en Asturias y Galicia se les conoce como parroquias, mientras que en otras regiones pueden ser conocidas como hermandades, concejos, etc... Ejemplo práctico: En la comunidad de Galicia, en la provincia de Orense, el municipio llamado Entrimo tiene 16 poblaciones que estan agrupadas en 5 parroquías (entidades colectivas):

Mapa de Entrimo

├─ Entrimo (Santa María la Real)
│    ├─ O Casal
│    ├─ Ferreiros
│    ├─ A Terrachá
├─ Galez (San Félix)
│    ├─ Asperelo e Olin
│    ├─ A Feira Vella
│    ├─ Galez
│    ├─ As Quintáns
├─ Illa (San Lorenzo)
│    ├─ A Illa
│    ├─ Lantemil
│    ├─ Olelas
├─ Pereira (San Facundo)
│    ├─ Bouzadrago
│    ├─ Guxinde
│    ├─ A Pereira
├─ Venceáns (Santo Tomás)
│    ├─ Queguas
│    ├─ Venceáns
│    ├─ Vilar
  • Población (Entidad singular): Subdivisión geografica de los municipios. Normalmente suele tener una relación directa 1:1 con el municipio al que pertenece. Por ejemplo, la población Almería pertenece al municipio de Almería. Pero también existen casos donde un municipio puede tener varias poblaciones:
    • en la provincia de Almería, el municipio de Alboloduy tiene 2 poblaciones (Alboloduy y Las Alcubillas Altas)
    • en la provincia de Orense, el municipio de Allariz tiene 1376 poblaciones
  • Núcleo urbano / Zona diseminada: Una población puede tener núcleo(s) urbano(s), es decir, la zona donde se agrupan las viviendas y edificios, calles, avenidas, plazas, etc... Pero también existen casos en los que puede haber viviendas y edificios, calles, avenidas, plazas, etc... dispersas fuera de lo que se considera el núcleo urbano. Es común en zonas rurales y pueblos. En estos casos, se les llama zonas diseminadas. Por ejemplo:
    • en la provincia de La Coruña, en el municipio de Ferrol, la población de Ferrol tiene un único núcleo (Ferrol) y ningúna zona diseminada. Mapa de Ferrol
    • en la provincia de Almería, en el municipio de Abla, la población Las Adelfas tiene únicamente una zona diseminada. Mapa de Las Adelfas
    • en la provincia de Almería, en el municipio de Albox, la población La Rambla tiene 2 núcleos urbanos ( Llano de Las Animas y Llano del Espino) y 1 zona diseminada. Mapa de La Rambla
  • Código postal: Código numérico de 5 dígitos que se asigna a una zona geográfica. Se debe tener en cuenta que un código postal puede pertenecer a varias poblaciones, núcleos urbanos o zonas diseminadas.
  • Vías / Pseudovías: Calles, avenidas, plazas, etc... que conforman el núcleo urbano o la zona diseminada.

Vías y pseudovías

Listado de vías y pseudovías

Endpoint usado para obtener un listado de todas las vías y pseudovías de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debe usarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la vía o pseudovía.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de vías y pseudovías

Endpoint usado para obtener un listado de todas las vías y pseudovías de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debe usarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la vía o pseudovía.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de vías y pseudovías

Endpoint usado para obtener un listado de todas las vías y pseudovías de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debe usarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la vía o pseudovía.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de vías y pseudovías

Endpoint usado para obtener un listado de todas las vías y pseudovías de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debe usarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la vía o pseudovía.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Códigos postales

Listado de códigos postales

Endpoint usado para obtener un listado de todos los códigos postales de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debeusarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de códigos postales

Endpoint usado para obtener un listado de todos los códigos postales de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debeusarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Comunidades

Listado de comunidades

Endpoint usado para obtener un listado de todas las comunidades. El dato importante en la respuesta es el CCOM que es el código de la comunidad.

query Parameters
CPOS
string

Filtro por código postal.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Municipios

Listado de municipios

Endpoint usado para obtener un listado de todos los municipios de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre del municipio.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de municipios

Endpoint usado para obtener un listado de todos los municipios de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre del municipio.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Núcleos

Listado de núcleos

Endpoint usado para obtener un listado de todos los núcleos de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CNUC
string

Filtro por ID de núcleo urbano.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

CUN
string

Nota Filtro por ID de núcleo urbano (único solo en el contexto del municipio, por lo que debe usarse en combinación con CMUM)

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

NENTSI50
string

Filtro por nombre de la población.

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Poblaciones

Listado de poblaciones

Endpoint usado para obtener un listado de todas las poblaciones de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CMUM
string

Nota Filtro por ID de municipio (único solo en el contexto de la provincia, por lo que debe usarse en combinación con CPRO)

CMUN
string

Filtro por ID de municipio.

CPOB
string

Filtro por ID de población.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Provincias

Listado de provincias

Endpoint usado para obtener un listado de todas las provincias de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la provincia.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

Listado de provincias

Endpoint usado para obtener un listado de todas las provincias de España.

query Parameters
CCOM
string

Filtro por ID de comunidad autónoma.

CPOS
string

Filtro por código postal.

CPRO
string

Filtro por ID de provincia.

FORMAT
string
Enum: "csv" "json" "msgpack" "xml" "yaml"

Tipo de respuesta. Por defecto es json

KEY
string

Clave de autenticación (se obtiene en el área de usuario)

PAGE
integer

Número de página en el resultado. Empieza en 1

PAGE_SIZE
integer

Número de elementos por página. Por defecto es 1.000

QUERY
string

Texto a buscar en el nombre de la provincia.

VERSION
string

Versión de la base de datos que se desea usar. Si no se especifica nada, se usará la última versión disponible.

Responses

Response samples

Content type
application/json
{
  • "previous": null,
  • "size": 1,
  • "current_page": 1,
  • "data": [
    ],
  • "update_date": "2024.01",
  • "warning": "API inoperativa por mantenimiento durante el proximo día 2022-04-08"
}

versiones

versiones_list

Responses

Response samples

Content type
application/json
[
  • {
    }
]