/athome/listings/search

POST /api/athome/listings/search

Price: 10 credits

Search athome (アットホーム) real-estate listings by prefecture and deal type (rentals or for-sale mansion, house and land). Returns listing cards with name, building type, room number, address, nearest stations, layout, area, building age, floor, structure, rent or price, management fee, deposit and key money, and image.

How to use it

Search athome (アットホーム) listings. Provide pref (e.g. 'tokyo', 'osaka', 'kanagawa') and deal_type (rent / used_mansion / new_mansion / used_house / new_house / land). Each result has id (numeric property id), url, name, building_type, room_number, address, stations (line/station/walk_min), layout, area (m2), built_year_month, floor, structure, rent or price (JPY), management_fee, deposit, key_money and image.

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 (examples: "tokyo", "osaka", "kanagawa"; minLength: 1)
• deal_type string — Property deal type (default: "rent"; one of: "rent", "used_mansion", "new_mansion", "used_house", "new_house", "land")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "AthomeListingCard")
• id string required
• deal_type string required
• url string required
• name string nullable
• building_type string nullable
• room_number string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "AthomeStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• layout string nullable
• area number nullable
• building_area number nullable
• land_area number nullable
• built_year_month string nullable
• floor string nullable
• structure string nullable
• rent integer nullable
• price integer nullable
• management_fee integer nullable
• deposit string nullable
• key_money 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 — 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.