Housing Market API इंटीग्रेशन गाइड
संदर्भ तालिकाएँ, एंडपॉइंट विवरण, त्रुटि कोड और उदाहरण API विनिर्देश से जनरेट किए जाते हैं और हर भाषा में अंग्रेज़ी में ही रहते हैं। नाम, पैरामीटर और कोड हर जगह एक जैसे हैं।
प्रॉपर्टी एंडपॉइंट और फ़ील्ड संदर्भ
GET /v1/properties एक देश की प्रकाशित लिस्टिंग लौटाता है, प्रॉपर्टी के उन सभी विवरणों के साथ जिन्हें स्टैंडर्ड कुंजी देख सकती है।
हर फ़ील्ड इनमें से किसी एक समूह से संबंधित है, जो पॉलिसी कॉलम में दिखाया गया है।
- संरचित (Structured): जैसा प्रकाशित हुआ, वैसा ही लौटाया जाता है।
- सामान्यीकृत (Coarsened): मकान नंबर कभी नहीं लौटाया जाता, और मालिक द्वारा स्वयं सूचीबद्ध किए गए घरों के लिए निर्देशांक को मोहल्ले के स्तर तक राउंड किया जाता है और पोस्ट कोड नहीं दिया जाता।
- साफ़ किया गया (Scrubbed): प्रॉपर्टी सूचीबद्ध करने वाले व्यक्ति का लिखा मुक्त पाठ, जिसमें से ईमेल पते, फ़ोन नंबर, वेब पते और मैसेजिंग हैंडल हटा दिए गए हैं।
- व्युत्पन्न (Derived): API द्वारा अन्य फ़ील्ड से गणना किया गया।
- प्रॉक्सी किया गया (Proxied): सीधे लिंक किए जाने के बजाय API के माध्यम से दिया जाता है।
लिस्टिंग अभी बिना तस्वीरों के आती हैं: images फ़ील्ड एक खाली सूची है। तस्वीरों के लिंक आने वाले हैं; मूल तस्वीरें Housing Market पोर्टलों पर सार्वजनिक रहती हैं।
कभी नहीं लौटाया जाता: प्रॉपर्टी सूचीबद्ध करने वाले व्यक्ति के संपर्क विवरण, एजेंटों और मालिकों की पहचान, और किसी लिस्टिंग से जुड़ी कोई भी निजी जानकारी।
कीमतें लिस्टिंग की अपनी मुद्रा में होती हैं और कभी परिवर्तित नहीं की जातीं। जिस फ़ील्ड का कोई मान नहीं है, वह null होता है।
प्रॉपर्टी रिकॉर्ड
GET /v1/properties: List published properties in one country
| Field | Type | Policy | Description |
|---|---|---|---|
id required | string | Structured | Stable identifier of the listing. Treat it as opaque. |
country required | string | Structured | ISO 3166-1 alpha-2 code of the country the listing is in. |
listing_type required | string | Structured | What the listing offers. Requesting listing_type=all returns every value. sale rent vacation_rental co_living |
property_type required | string | null | Structured | The kind of property in lower case, for example condominium or house. Null when the listing does not state one. |
province | string | null | Structured | Name of the province or state. |
province_id | integer | null | Structured | Identifier of the province or state, for the province_id filter. |
city | string | null | Structured | Name of the city. |
city_id | integer | null | Structured | Identifier of the city, for the city_id filter. |
area | string | null | Structured | Name of the district or area. |
area_id | integer | null | Structured | Identifier of the district or area, for the area_id filter. |
address | string | null | Coarsened | Street name or locality line. The street number is never included. |
post_code | string | null | Coarsened | Postal code. Null for owner-listed homes. |
latitude | number | null | Coarsened | Latitude in decimal degrees. For owner-listed homes it is rounded so that it identifies a neighbourhood, not a building; see location_precision. |
longitude | number | null | Coarsened | Longitude in decimal degrees. Same precision rule as latitude. |
location_precision required | string | Derived | approximate when the coordinates and post code have been coarsened because the home is listed by its owner; otherwise exact. exact approximate |
price | number | null | Structured | Published price in the listing's own currency. For rent listings it is the published amount per month. Never converted. |
price_max | number | null | Structured | Upper end when the listing publishes a price range; otherwise null. |
currency required | string | null | Structured | ISO 4217 code of the currency price and price_max are in. Null when the listing states none. |
bedrooms | number | null | Structured | Number of bedrooms. |
bathrooms | number | null | Structured | Number of bathrooms. |
rooms | number | null | Structured | Total number of rooms, where the listing states it. |
living_area | number | null | Structured | Living area in the unit the lister used. Use living_area_sqm to compare listings. |
living_area_sqm | number | null | Structured | Living area in square metres. |
lot_area | number | null | Structured | Plot area in the unit the lister used. Use lot_area_sqm to compare listings. |
lot_area_sqm | number | null | Structured | Plot area in square metres. |
build_year | integer | null | Structured | Year the property was built. |
published_date required | string | null (date-time) | Structured | When the listing was first published. Null when the portal does not record it. |
last_updated required | string | null (date-time) | Structured | When the listing last changed, or published_date when no change is recorded. This is the value updated_since compares. |
features | array of string | Structured | Feature names, for example the facilities of the building. |
appliances | array of string | Structured | Appliance names included with the property. |
neighbourhood | array of string | Structured | Names of neighbourhood features, such as nearby transport. |
tags | array of string | Structured | Tag names the lister attached to the listing. |
developer | string | null | Structured | Name of the development company, where the listing names one. Never a person. |
summary | string | null | Scrubbed | Short description. Email addresses, phone numbers, web addresses and messaging handles are removed. |
description | string | null | Scrubbed | Full description as plain text. Email addresses, phone numbers, web addresses and messaging handles are removed. |
location_text | string | null | Scrubbed | The lister's description of the location, scrubbed in the same way. |
images required | array of Image | Proxied | Watermarked, signed, expiring photographs. Never a direct storage or CDN address. Empty until the image service is available. |
images[]
| Field | Type | Description |
|---|---|---|
url required | string (uri) | Signed address of the watermarked image. Valid for your key only, until expires_at. |
expires_at required | string (date-time) | When the URL stops working. |
position required | integer | Order of the photograph on the listing. 1 is the lead photograph. |
GET /v1/properties/{id}
Get one published property
Returns one published listing by the id a listing page carried, in the same shape. The country must be the listing's own country and one your key covers. A listing that has been withdrawn, an id from another country, and an id that never existed all return not_found.
Parameters
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
id | string | yes | The id of a listing, exactly as a listing page returned it. | |
country | string | yes | pattern ^[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. |
Responses
| Status | Description | Error codes |
|---|---|---|
200 | The listing. | |
400 | The request is invalid. | invalid_parameter invalid_cursor |
401 | The key is missing, unknown or revoked. | unauthenticated |
403 | The request is refused for the key, the address or the country. | country_not_entitled ip_not_allowed key_paused |
404 | The listing does not exist, is not in that country, or has been withdrawn. | not_found |
429 | A rate limit or a quota has been reached. | rate_limited quota_exceeded |
500 | Something went wrong on our side. | internal_error |
503 | The service cannot answer right now. | service_unavailable |