Listar propiedades publicadas

GEThttps://api.bydomu.com/v1/properties

Propiedades activas y publicadas en el portal, con filtros y paginación (pageSize máximo 48). Las notas internas y los campos personalizados nunca salen por aquí. Con cursor (el id de la última propiedad recibida) no se cuenta el total y meta.total / meta.totalPages llegan en null.

Permiso

portal:read

Claves

Publicable o secreta

Encabezados

X-API-Keystringobligatorio

Tu clave publicable o secreta.

Parámetros de consulta

pageinteger

Página, desde 1 · default=1 · ≥ 1

pageSizeinteger

Propiedades por página (máximo 48) · default=12 · 1–48

cursorstring

Paginación por cursor: id de la última propiedad recibida

includeTotalboolean

Se interpreta con Boolean(): cualquier valor no vacío (incluso false) cuenta como verdadero. Para no contar el total, pagina con cursor · nullable

transactionTypestring

Venta, arriendo o ambas SALERENTSALE_OR_RENT

typestring

Tipo de inmueble APARTMENTHOUSEOFFICECOMMERCIALLANDWAREHOUSEROOMFARMOTHER

citystring

Ciudad (coincidencia parcial, sin distinguir mayúsculas)

neighborhoodstring

Barrio (coincidencia parcial, sin distinguir mayúsculas)

priceMinnumber

Precio mínimo · ≥ 0 · nullable

priceMaxnumber

Precio máximo · ≥ 0 · nullable

bedroomsMininteger

Habitaciones mínimas · ≥ 0 · nullable

bathroomsMininteger

Baños mínimos · ≥ 0 · nullable

areaMinnumber

Área mínima en m² · ≥ 0 · nullable

stratuminteger

Estrato socioeconómico (1-6) · 1–6

searchstring

Texto libre en título, barrio, dirección, ciudad y código · ≤ 200 chars

hasPoolboolean

Solo con piscina. Como todos los has*, cualquier valor no vacío cuenta como verdadero · nullable

hasGymboolean

Solo con gimnasio · nullable

hasElevatorboolean

Solo con ascensor · nullable

hasSecurityboolean

Solo con vigilancia 24 h · nullable

hasPetFriendlyboolean

Solo si admiten mascotas · nullable

hasParkingboolean

Solo con al menos un parqueadero · nullable

hasBalconyboolean

Solo con balcón · nullable

hasACboolean

Solo con aire acondicionado · nullable

hasFurnishedboolean

Solo amobladas · nullable

hasGardenboolean

Solo con jardín · nullable

sortBystring

Campo de orden pricecreatedAtarea · default="createdAt"

sortOrderstring

Dirección del orden ascdesc · default="desc"

Respuestas

200Página de propiedades

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

const url = new URL("https://api.bydomu.com/v1/properties"); url.searchParams.set("neighborhood", "Laureles"); url.searchParams.set("bedroomsMin", "2"); const res = await fetch(url, { headers: { "X-API-Key": process.env.BYDOMU_API_KEY }, }); const data = await res.json();

import os, requests r = requests.get( "https://api.bydomu.com/v1/properties", params={"neighborhood": "Laureles", "bedroomsMin": "2"}, headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]} ) data = r.json()

{ "data": [ { "id": "clx1prop001", "code": "P-0042", "title": "Apartamento en Chapinero con vista", "description": "Apartamento de 85 m² con balcón y vista a los cerros.", "type": "APARTMENT", "transactionType": "SALE", "rentalServiceType": "BROKERAGE", "status": "DRAFT", "price": "450000000.00", "rentPrice": "3500000.00", "currency": "COP", "adminFee": "380000.00", "securityDeposit": "3500000.00", "neighborhood": "Chapinero", "city": "Bogotá", "state": "Cundinamarca", "country": "CO", "bedrooms": 3, "bathrooms": 2, "halfBathrooms": 1, "parkingSpots": 1, "area": 85, "builtArea": 80, "floor": 8, "stratum": 4, "yearBuilt": 2015, "elevator": true, "petFriendly": true, "furnished": "UNFURNISHED", "amenities": [ "pool" ], "virtualTourUrl": "https://my.matterport.com/show/?m=abc123", "videoUrl": "https://youtu.be/abc123", "tour3dUrl": "https://cdn.bydomu.com/tours/clx1prop001/model.splat", "isFeatured": false, "viewCount": 128, "agentId": "clx1usr001", "createdAt": "2026-08-01T14:30:00.000Z", "updatedAt": "2026-09-20T10:00:00.000Z", "latitude": 4.6486, …