Housing Market API entegrasyon kılavuzu

Referans tabloları, uç nokta açıklamaları, hata kodları ve örnekler API spesifikasyonundan oluşturulur ve her dilde İngilizce kalır. Adlar, parametreler ve kodlar her yerde aynıdır.

Filtreler

country parametresi zorunludur. Diğer tüm filtreler sonucu daraltır ve filtreler birlikte kullanılabilir.

Uç noktanın tanımlamadığı bir parametre yok sayılmak yerine invalid_parameter ile reddedilir; böylece yanlış yazılmış bir filtre sessizce filtrelenmemiş bir sayfa döndüremez.

Yerler tanımlayıcıya veya ada göre filtrelenebilir. Adlar büyük/küçük harf ayrımı yapılmadan eşleştirilir. Bir düzey için adı ya da tanımlayıcıyı kullanın, ikisini birden değil.

Fiyat filtreleri, sayıyı her ilanın kendi para biriminde, yayımlandığı haliyle karşılaştırır. Hiçbir şey dönüştürülmez.

Bir imleç, verildiği filtrelere aittir. Bir filtreyi değiştirmek için ilk sayfadan yeniden başlayın.

GET /v1/properties parametreleri

ParameterTypeRequiredValuesDescription
countrystringyespattern ^[A-Z]{2}$ISO 3166-1 alpha-2 code of the country, for example TH. A country outside your subscription is refused with country_not_entitled.
listing_typestringnoall sale rent
default all
Which kind of listing to include. all is the default.
property_typestringnoReturn only this property type, for example condominium. The value is the property_type that listings carry; an unknown value returns an empty page.
province_idintegernomin 1Return only listings in this province or state, by the province_id listings carry.
citystringnoReturn only listings in this city, matched by name without regard to case. Do not combine with city_id.
city_idintegernomin 1Return only listings in this city, by the city_id listings carry.
areastringnoReturn only listings in this district or area, matched by name without regard to case. Do not combine with area_id.
area_idintegernomin 1Return only listings in this district or area, by the area_id listings carry.
min_pricenumbernomin 0Lowest price to include, in the listing's own currency. Prices are never converted, so in a country with listings in more than one currency the filter compares the number as published.
max_pricenumbernomin 0Highest price to include, in the listing's own currency.
min_bedroomsintegernomin 0Fewest bedrooms to include. Listings that do not state a number of bedrooms are left out.
max_bedroomsintegernomin 0Most bedrooms to include. Listings that do not state a number of bedrooms are left out.
published_sincestringnoReturn only listings first published at or after this instant: a date (YYYY-MM-DD, read as midnight UTC) or a date-time with a time zone, for example 2026-10-01T00:00:00Z. A date-time without a time zone is refused with invalid_parameter.
updated_sincestringnoReturn only listings whose last_updated is at or after this instant, in the same format as published_since. Use it to fetch what changed since your last walk. A listing that has been withdrawn is not returned; request it by id to confirm it is gone.
limitintegernodefault 50
min 1
max 100
Page size. At most the maximum shown; larger values are refused with invalid_parameter.
cursorstringnoThe next_cursor of the previous page. Opaque: do not parse it, store it, or build one. It is bound to your key and to the filters of the request that produced it, and a cursor used with different filters is refused with invalid_cursor.