/athome/listings

POST /api/athome/listings

Price: 10 credits

Get full athome (アットホーム) real-estate listing details by numeric property id (or listing URL): rent or sale price, management fee, deposit and key money, layout, area, floor, facing, structure, building age, address, nearest stations with walking time, amenities, parking, transaction type, handling agent and photos. Covers rentals and for-sale mansion, house and land.

How to use it

Fetch a single athome (アットホーム) listing by numeric property id (e.g. '1000491169' for a rental, '6988014156' for a for-sale mansion) or a full listing URL. Set deal_type when passing a bare id (rent / used_mansion / new_mansion / used_house / new_house / land). Returns name, building_type, address (locality/region), stations (line/station/walk_min), layout, area/exclusive_area/building_area/land_area (m2), balcony_area, floor, facing, structure, built_year_month, unit_count, land_right, rent or price (JPY), management_fee, repair_reserve_fund, deposit, key_money, brokerage_fee, rent_guarantee, insurance, other_lump_sum, parking, bicycle_parking, is_pets_allowed, bath_toilet/kitchen/security/storage/amenities, and (for houses/land) zoning, building_coverage_ratio, floor_area_ratio, road_access, land_category, topography, city_planning, building_permit_number, private_road_area, setback, tsubo, development_area, total_unit_count, sale_unit_count, contract_period, renewal_fee, transaction_type, current_status, move_in, property_code, published_date, remarks, agent (name/image/address/telephone/license_number/memberships/geo) and image/images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — athome listing as numeric property id or a full listing URL (examples: "1000491169", "https://www.athome.co.jp/chintai/1000491169/", "6988014156"; minLength: 1)
• deal_type string — Property deal type (used to resolve a bare numeric id to its URL) (default: "rent"; one of: "rent", "used_mansion", "new_mansion", "used_house", "new_house", "land")

Response

• @type string (default: "AthomeListing")
• id string required
• deal_type string required
• url string required
• name string nullable
• building_type string nullable
• address string nullable
• locality string nullable
• region 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
• exclusive_area number nullable
• building_area number nullable
• land_area number nullable
• balcony_area string nullable
• floor string nullable
• facing string nullable
• structure string nullable
• built_year_month string nullable
• unit_count integer nullable
• land_right string nullable
• rent integer nullable
• price integer nullable
• management_fee integer nullable
• price_per_sqm integer nullable
• management_form string nullable
• repair_reserve_fund string nullable
• deposit string nullable
• key_money string nullable
• brokerage_fee string nullable
• rent_guarantee string nullable
• insurance string nullable
• other_lump_sum string nullable
• parking string nullable
• bicycle_parking string nullable
• is_pets_allowed boolean nullable
• bath_toilet array (default: [])
• kitchen array (default: [])
• security array (default: [])
• storage array (default: [])
• amenities array (default: [])
• zoning string nullable
• building_coverage_ratio string nullable
• floor_area_ratio string nullable
• road_access string nullable
• land_category string nullable
• topography string nullable
• city_planning string nullable
• building_permit_number string nullable
• private_road_area string nullable
• setback string nullable
• tsubo string nullable
• features string nullable
• development_area string nullable
• total_unit_count integer nullable
• sale_unit_count integer nullable
• contract_period string nullable
• renewal_fee string nullable
• transaction_type string nullable
• current_status string nullable
• move_in string nullable
• property_code string nullable
• published_date string nullable
• remarks string nullable
• agent object nullable
  • @type string (default: "AthomeListingAgent")
  • name string nullable
  • image string nullable
  • address string nullable
  • telephone string nullable
  • fax string nullable
  • latitude number nullable
  • longitude number nullable
  • license_number string nullable
  • business_hours string nullable
  • holidays string nullable
  • memberships array (default: [])
  • url 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 — 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.