Docs

Objetos (lectura)

Última actualización: 2026-07-243 min de lectura

Lea el catálogo público de anuncios: property, rental y complex (promoción). Las respuestas siguen un contrato de lectura explícito y estable (una lista permitida), de modo que los campos internos nunca se filtran y los campos nuevos del modelo no aparecen por sorpresa. Las lecturas son GET y son gratuitas (no cuentan contra su cuota de llamadas de API).

Dirección base: https://developers.grem.capital/api/v1.

Listado

GET /objects?kind=property&city=Kyiv&page=1&limit=20&sort=newest
Authorization: Bearer gsk_live_...

Parámetros de la petición:

  • kind (obligatorio): property, rental o complex
  • city, country (opcionales): filtros de coincidencia exacta
  • page (por defecto 1), limit (por defecto 20, máximo 50)
  • sort: newest (por defecto) u oldest

Respuesta:

{
  "data": [ { "id": "...", "kind": "property", "name": "...", "price": 120000, "currency": "USD", ... } ],
  "paginate": { "currentPage": 1, "totalPages": 471, "totalCount": 9412 },
  "requestId": "req_..."
}

Obtener uno

GET /objects/{kind}/{id}
Authorization: Bearer gsk_live_...

{kind} es property, rental o complex. Devuelve un único objeto con la misma forma, más un requestId. Un id desconocido devuelve 404.

La forma del objeto

Campos comunes (el conjunto exacto depende del tipo):

  • id, kind, name, slug, status (active o sold), createdAt
  • price, currency (property/rental); price: { from, to, currency } (complex)
  • address: la dirección completa, con street y las coordenadas en location
  • constructionYear: un año simple de cuatro cifras (null si se desconoce)
  • Las superficies son objetos: spaceAll: { "value": 50, "unit": "m2" }; la pista de presentación es nativeAreaUnit
  • photos: [{ id, isMain, mimetype, variants, ready }]
  • author: el agente o la agencia del anuncio (bloque público curado)
  • El complejo añade apartmentPlans[] (planos de las unidades) y progress[] (avance de obra)

Los campos de categoría y atributos (type, condition, utilitySystem, apartType, amenities, status, ...) se devuelven como códigos. Descífrelos con el endpoint de diccionarios.

Cada foto tiene la marca ready. Vale false mientras se están generando las versiones con marca de agua. Vuelva a consultar (o muestre un marcador) hasta que ready sea true, en vez de cachear una imagen sin terminar.

Qué ve usted

La respuesta se ajusta a quién es usted:

  • Cualquier objeto: la ficha pública del anuncio (lo que ven los visitantes en grem.capital).
  • Un anuncio con comisión abierta: como bróker autenticado ve además la recompensa de un contrato aprobado, para decidir si envía un lead.
  • Sus propios objetos: su vista completa de propietario.

Nunca se muestran a nadie: contactos privados del propietario, datos importados del vendedor, notas de moderación, originales de fotos sin marca de agua e identificadores internos.

¿Le resultó útil este artículo?