读取公开的房源目录 — property、rental 和 complex(在建项目)。响应遵循明确而稳定的读取契约(白名单),因此内部字段绝不会外泄,模型新增的字段也不会突然出现。读取使用 GET,且免费(不占用您的 API 调用额度)。
基础地址:https://developers.grem.capital/api/v1。
列表
GET /objects?kind=property&city=Kyiv&page=1&limit=20&sort=newest
Authorization: Bearer gsk_live_...
查询参数:
kind(必填)—property、rental或complexcity、country(可选)— 精确匹配的筛选page(默认 1)、limit(默认 20,最大 50)sort—newest(默认)或oldest
响应:
{
"data": [ { "id": "...", "kind": "property", "name": "...", "price": 120000, "currency": "USD", ... } ],
"paginate": { "currentPage": 1, "totalPages": 471, "totalCount": 9412 },
"requestId": "req_..."
}
获取单个
GET /objects/{kind}/{id}
Authorization: Bearer gsk_live_...
{kind} 为 property、rental 或 complex。返回结构相同的单个对象,外加 requestId。id 不存在时返回 404。
对象结构
通用字段(具体集合随类型而异):
id、kind、name、slug、status(active或sold)、createdAtprice、currency(property/rental);price: { from, to, currency }(complex)address— 完整地址,包含street和location坐标constructionYear— 普通的四位年份(未知时为null)- 面积是对象:
spaceAll: { "value": 50, "unit": "m2" };展示单位提示为nativeAreaUnit photos—[{ id, isMain, mimetype, variants, ready }]author— 该房源的经纪人或机构(经整理的公开信息块)- 在建项目另有
apartmentPlans[](单元户型)和progress[](施工进度)
分类和属性字段(type、condition、utilitySystem、apartType、amenities、status 等)以代码形式返回。请用词典接口解码。
每张照片都有 ready 标志。在带水印的版本尚在生成时,它为 false。请反复查询(或先显示占位图),直到 ready 变为 true,不要缓存尚未处理完的图片。
您能看到什么
响应内容取决于您的身份:
- 任意对象 — 房源的公开卡片(访客在 grem.capital 上看到的内容)。
- 带开放佣金的房源 — 作为已鉴权的经纪人,您还能看到已批准合同中的报酬,据此决定是否推送线索。
- 您自己的对象 — 完整的所有者视图。
任何人都看不到的内容:业主的私人联系方式、导入的卖方数据、审核备注、无水印的照片原图,以及内部标识符。