Tipos de asentamiento
GET
/v1/settlement-typesTodos los planes¿Qué hace?
Los tipos de asentamiento que usa SEPOMEX, para filtrar búsquedas por type.
Colonia, Fraccionamiento, Ranchería, Barrio, Pueblo, Ejido, etc. (24 tipos). Sin paginar.
La petición
No lleva parámetros.
Ejemplo
curl -H "x-api-key: TU_LLAVE" "https://colonix.silgaru.mx/v1/settlement-types"const url = new URL("https://colonix.silgaru.mx/v1/settlement-types");
const res = await fetch(url, { headers: { "x-api-key": process.env.COLONIX_API_KEY }, signal: AbortSignal.timeout(5000),});const data = await res.json();if (!res.ok) throw new Error(`${data.type}: ${data.detail}`);
console.log(data);import osimport requests
res = requests.get( "https://colonix.silgaru.mx/v1/settlement-types", headers={"x-api-key": os.environ["COLONIX_API_KEY"]}, timeout=5,)data = res.json()if not res.ok: raise RuntimeError(f"{data['type']}: {data['detail']}")
print(data)<?php$url = "https://colonix.silgaru.mx/v1/settlement-types";$ch = curl_init($url);curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("COLONIX_API_KEY")], CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 5,]);$data = json_decode(curl_exec($ch), true);if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) !== 200) { throw new RuntimeException("{$data['type']}: {$data['detail']}");}
print_r($data);Cambia TU_LLAVE por tu llave; en los lenguajes, se lee de la variable de entorno COLONIX_API_KEY. Esta petición es la que produjo la respuesta de abajo.
La respuesta
Respuesta real a la petición del ejemplo. Viene con los encabezados ETag, X-Data-Version, Cache-Control.
{ "data": [ { "id": "01", "name": "Aeropuerto" }, { "id": "02", "name": "Barrio" }, { "id": "04", "name": "Campamento" }, { "id": "09", "name": "Colonia" }, { "id": "10", "name": "Condominio" }, { "id": "12", "name": "Conjunto habitacional" }, { "id": "15", "name": "Ejido" }, { "id": "17", "name": "Equipamiento" }, { "id": "18", "name": "Exhacienda" }, { "id": "20", "name": "Finca" }, { "id": "21", "name": "Fraccionamiento" }, { "id": "23", "name": "Granja" }, { "id": "24", "name": "Hacienda" }, { "id": "45", "name": "Paraje" }, { "id": "28", "name": "Pueblo" }, { "id": "40", "name": "Puerto" }, { "id": "29", "name": "Ranchería" }, { "id": "48", "name": "Rancho" }, { "id": "31", "name": "Unidad habitacional" }, { "id": "33", "name": "Zona comercial" }, { "id": "34", "name": "Zona federal" }, { "id": "37", "name": "Zona industrial" }, { "id": "47", "name": "Zona militar" }, { "id": "46", "name": "Zona naval" } ], "data_version": "2026.11.05-36a7823b"}Campos
| Campo | Tipo | Descripción |
|---|---|---|
data | lista de objetos | |
data[].id | texto | Clave oficial |
data[].name | texto | Nombre |
data_version | texto | Versión del dato |
Errores
Todos en formato application/problem+json; ninguno cuenta para tu cuota. Qué hacer con cada uno: Errores.
| Estado | Cuándo |
|---|---|
401 | Credenciales faltantes (/errors/missing-api-key) o inválidas (/errors/invalid-api-key). |
403 | Llave suspendida (/errors/api-key-suspended) o endpoint fuera de tu plan (/errors/plan-not-allowed). |
429 | Se alcanzó la cuota mensual (/errors/quota-exceeded) o el límite por minuto (/errors/rate-limited). La respuesta del límite por minuto trae el mismo cuerpo, pero con Content-Type: application/json. |
5XX | Error inesperado (/errors/internal-error) o servicio no disponible por un momento (503, que puede llegar sin cuerpo). Reintenta unas cuantas veces, esperando cada vez más. |
© 2026 Silgaru