/yahoo/realestate/buildings/search

POST /api/yahoo/realestate/buildings/search

Price: 10 credits

Search the Yahoo! Real Estate Japan (Yahoo!不動産) mansion catalogue (マンションカタログ) for buildings by prefecture, optionally narrowed to a municipality, with a keyword (building, station or place name). Returns building cards with name, image, resident-review rating and counts, address, transit, built year/month, age, total floors, unit count and for-rent / for-sale availability flags.

How to use it

Search the Yahoo! Real Estate (Yahoo!不動産) mansion catalogue for buildings. Provide pref (e.g. 'tokyo'); optionally city (5-digit municipality code) and keyword (building/station/place name). Each result has id, url, name, image, rating, review_count, comment_count, address, transit, built_year_month, age, total_floors, unit_count, for_rent and for_sale.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pref string required — Prefecture to search in (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
• city string nullable — 5-digit municipality (JIS) code to narrow the search, e.g. '13104' for Shinjuku
• keyword string nullable — Keyword to filter by (building name, station or place name)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "YahooRealestateBuildingCard")
• id string required
• url string required
• name string nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• comment_count integer nullable
• address string nullable
• transit string nullable
• built_year_month string nullable
• age string nullable
• total_floors string nullable
• unit_count integer nullable
• for_rent boolean (default: false)
• for_sale boolean (default: false)

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 — The entity was not found, or a precondition failed 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.