មគ្គុទ្ទេសក៍សមាហរណកម្ម Housing Market API
តារាងយោង ការពិពណ៌នាចំណុចបញ្ចប់ (endpoint) កូដកំហុស និងឧទាហរណ៍ ត្រូវបានបង្កើតចេញពីលក្ខណៈបច្ចេកទេសរបស់ 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 |