どのようなデータを取得できますか?
リファレンスに記載されたすべての物件項目を含む公開中の物件情報を取得できます。Advanced では、集計された Insights を近日提供予定です。掲載者、仲介会社、所有者、問い合わせのデータが返されることは一切ありません。
GET /v1/properties は、キーの対象となっている国の公開中の物件情報を一ページ分ずつ返します。各物件には次の項目が含まれます。
- 物件の基本情報に関する項目で、id、country、listing_type、property_type が返されます。それぞれ物件の識別子、国、掲載の種類、物件の種類を表します。
- province、province_id、city、city_id、area、area_id、address、post_code(それぞれ州・県、州・県の識別子、市区町村、市区町村の識別子、地区、地区の識別子、住所、郵便番号を表します)
- 位置に関する項目で、latitude、longitude、location_precision が返されます。それぞれ緯度、経度、所在地の精度を表します。
- price、price_max、currency(価格、価格の上限、通貨)
- bedrooms、bathrooms、rooms(寝室数、浴室数、部屋数)
- 面積に関する項目で、living_area と living_area_sqm、lot_area と lot_area_sqm が返されます。それぞれ居住面積と敷地面積を、物件固有の単位と平方メートルで表します。
- 日付に関する項目で、build_year、published_date、last_updated が返されます。それぞれ築年、公開日、最終更新日を表します。
- 物件の特徴に関する項目で、features、appliances、neighbourhood、tags が返されます。それぞれ設備・特徴、家電、周辺環境、タグを表します。
- 説明に関する項目で、developer、summary、description、location_text が返されます。それぞれデベロッパー、概要、説明文、所在地の説明を表します。
- images(画像)
説明文はプレーンテキストで、連絡先は削除されています。所有者自身が掲載した住宅は、所在地を粗くし、番地を除いた形で返され、location_precision で各所在地の精度がわかります。現在、物件情報には画像が含まれていません。画像リンクが追加されるまで、images 項目は空のリストです。
どのエンドポイントでも、どのティアでも、掲載者、仲介会社、所有者、問い合わせのデータは返されません。項目名はどの言語でも同じで、各項目の型はリファレンスに記載されています。