/yahoo/realestate/buildings

POST /api/yahoo/realestate/buildings

Price: 5 credits

Get a Yahoo! Real Estate Japan (Yahoo!不動産) mansion catalog building profile by id or catalog URL: building name, address, nearest stations, built year, total floors and units, structure, overall and per-category resident ratings, review count and building facilities.

How to use it

Fetch a Yahoo! Real Estate (Yahoo!不動産) mansion catalog building by id (e.g. 'abf774390cdb7cb43cbacd11ff86a93d934277ae') or a full catalog URL. Returns name, rating and review_count, address, stations (line/station/walk_min), built_year_month, age, total_floors, unit_count, structure, per-category ratings (overall/room/design/safety/residents/facilities/surroundings/childcare/management/community), common_facilities, parking, security and image.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• building string required — Yahoo! Real Estate catalog building id or a full catalog URL (examples: "abf774390cdb7cb43cbacd11ff86a93d934277ae", "https://realestate.yahoo.co.jp/catalog/detail/abf774390cdb7cb43cbacd11ff86a93d934277ae/"; minLength: 1)

Response

• @type string (default: "YahooRealestateBuilding")
• id string required
• url string required
• name string nullable
• rating number nullable
• review_count integer nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "YahooRealestateStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• built_year_month string nullable
• age string nullable
• total_floors string nullable
• unit_count integer nullable
• structure string nullable
• overall_rating number nullable
• room_rating number nullable
• design_rating number nullable
• safety_rating number nullable
• residents_rating number nullable
• facilities_rating number nullable
• surroundings_rating number nullable
• childcare_rating number nullable
• management_rating number nullable
• community_rating number nullable
• common_facilities array (default: [])
• parking array (default: [])
• security array (default: [])
• image string nullable

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 — Building not found (well-formed id but the catalog 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.