properties

Buscar propiedades

Filtros por transacción, tipo, precio, recámaras y radio geográfico (near + radius, sobre índice PostGIS). Sin login para lo básico.

get/properties

Request

  • Base URL: https://api.inmo.example/v1
  • URL: https://api.inmo.example/v1/properties
  • Auth: one of:
    • none
    • API key in header X-API-Key

Query parameters

transactionType'ForSale' | 'ForLease'

Conveniencia derivada de PropertyType para la superficie REST/agentes. No es un campo RESO; RESO lo expresa dentro de PropertyType.

propertyType'Residential' | 'Residential Lease' | 'Residential Income' | 'Commercial Sale' | 'Commercial Lease' | 'Business Opportunity' | 'Land' | 'Farm' | 'Manufactured In Park'

RESO PropertyType — lookup oficial. En RESO la transacción (venta/renta) ya está codificada en el tipo (p. ej. Residential Lease). transactionType es una conveniencia derivada, no reemplaza a este campo.

minPricenumber

Precio mínimo, en la moneda del filtro.

maxPricenumber
minBedroomsinteger
nearstring

Centro del radio de búsqueda, lat,lng.

radiusinteger

Radio en metros (requiere near).

citystring
postalCodestring
status'Active' | 'Active Under Contract' | 'Pending' | 'Closed' | 'Coming Soon' | 'Hold' | 'Withdrawn' | 'Canceled' | 'Expired' | 'Incomplete' | 'Delete'

RESO StandardStatus — lookup oficial. Se adopta el conjunto completo aunque el adaptador de Facebook sólo emita Active/Pending/Closed/Withdrawn.

cursorstring

Cursor de paginación devuelto en next.

limitinteger

Response

Lista paginada de propiedades (representación compacta).

countinteger required

Total de coincidencias (best-effort).

nextstring nullable

Cursor para la página siguiente; null si no hay más.

Example response

{
  "results": [
    {
      "listingKey": "fb:1664330911533509",
      "listPrice": 8000,
      "listPriceCurrency": "MXN"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.