/yahoo/realestate/properties

POST /api/yahoo/realestate/properties

Price: 10 credits

Get full Yahoo! Real Estate Japan (Yahoo!不動産) for-sale property details by id or detail URL (used condo, used house, new house or land): price, address, layout, area, balcony area, building age, facing, floor, structure, land rights, management and repair fees, stations, equipment and handling agent.

How to use it

Fetch a single Yahoo! Real Estate (Yahoo!不動産) for-sale property by id (e.g. 'b0024803626') or a full detail URL. For a bare id, set property_type (used_mansion/used_house/new_house/land); a full URL detects the type automatically. Returns name, price (JPY), address, stations (line/station/walk_min), layout, area and balcony_area (m2), built_year_month, age, facing, floor, total_floors, building_status, occupancy_status, handover_timing, use_district, structure, land_rights, leasehold, management_fee and repair_reserve_fee (JPY), manager, management_type, parking, common_facilities, facilities, storage, water, gas, transaction_type, property_code, agent and image/images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Yahoo! Real Estate for-sale property id or a full detail URL (examples: "b0024803626", "https://realestate.yahoo.co.jp/used/mansion/detail_corp/b0024803626/"; minLength: 1)
• property_type string — For-sale product type, used when a bare id (not a full URL) is given (default: "used_mansion"; one of: "used_mansion", "used_house", "new_house", "land")

Response

• @type string (default: "YahooRealestateProperty")
• id string required
• url string required
• property_type string required
• name string nullable
• price integer nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "YahooRealestateStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• layout string nullable
• area number nullable
• building_area number nullable
• land_area number nullable
• balcony_area number nullable
• land_category string nullable
• building_coverage string nullable
• floor_area_ratio string nullable
• private_road string nullable
• setback string nullable
• road_access string nullable
• built_year_month string nullable
• age string nullable
• facing string nullable
• floor string nullable
• total_floors string nullable
• building_status string nullable
• occupancy_status string nullable
• handover_timing string nullable
• use_district string nullable
• structure string nullable
• land_rights string nullable
• leasehold string nullable
• management_fee integer nullable
• repair_reserve_fee integer nullable
• manager string nullable
• management_type string nullable
• parking string nullable
• common_facilities array (default: [])
• facilities array (default: [])
• storage array (default: [])
• water string nullable
• gas string nullable
• transaction_type string nullable
• property_code string nullable
• agent object nullable
  • @type string (default: "YahooRealestateAgent")
  • name string nullable
  • license_number string nullable
  • business_hours string nullable
  • holidays string nullable
  • address string nullable
• image string nullable
• images array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Property not found (well-formed id but the property page does not exist) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.