/yahoo/realestate/listings

POST /api/yahoo/realestate/listings

Price: 20 credits

Get full Yahoo! Real Estate Japan (Yahoo!不動産) rental listing details by id or listing URL: rent, management fee, deposit, key money, layout, area, floor, facing, structure, building age, address, nearest stations with walking time, parking, equipment groups, contract terms, handling agent and primary photo.

How to use it

Fetch a single Yahoo! Real Estate (Yahoo!不動産) rental listing by id (e.g. '0000037845828eab7423049567553f87e7dd0696a69f') or a full listing URL. Returns building_name, rent and management_fee (JPY), deposit, guarantee_deposit, key_money, key_money_amortization, layout, layout_detail, area (m2), age, built_year_month, floor, total_floors, facing, structure, address, stations (line/station/walk_min), parking, contract_period, move_in, insurance, equipment groups (bath_toilet, kitchen, indoor_equipment, storage, appliances, communication, balcony, security, occupancy_conditions, other_features), info_source, remarks, transaction_type, property_code, agent (name/license_number/business_hours/holidays/address) and image.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "YahooRealestateListing")
• id string required
• url string required
• building_name string nullable
• rent integer nullable
• management_fee integer nullable
• deposit string nullable
• guarantee_deposit string nullable
• key_money string nullable
• key_money_amortization string nullable
• layout string nullable
• layout_detail string nullable
• area number nullable
• age string nullable
• built_year_month string nullable
• floor string nullable
• total_floors string nullable
• facing string nullable
• structure string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "YahooRealestateStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• parking string nullable
• conditions string nullable
• contract_period string nullable
• move_in string nullable
• insurance string nullable
• bath_toilet array (default: [])
• kitchen array (default: [])
• indoor_equipment array (default: [])
• storage array (default: [])
• appliances array (default: [])
• communication array (default: [])
• balcony array (default: [])
• security array (default: [])
• occupancy_conditions array (default: [])
• other_features array (default: [])
• info_source string nullable
• remarks 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

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