/able/listings/search

POST /api/able/listings/search

Price: 20 credits

Search Able (エイブル) rental rooms in a city, town, railway line or station with rent, layout, size, walk time, building age and type, equipment and condition filters: one row per room with rent, fees, layout, size, floor, building, location, stations and the handling Able shop

How to use it

City, town, line and station codes come from able/areas. Pass a returned id to able/listings for the full room.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city_code string nullable — Japanese city or town code (JIS) (examples: "13112", "13112001")
• prefecture string nullable — Prefecture of the railway line or station (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")
• railway_code string nullable — Able railway line or station code (examples: "101001", "101001024")
• rent_min integer nullable — Minimum monthly rent, yen (one of: 30000, 35000, 40000, 45000, 50000, 55000, 60000, 65000, 70000, 75000, 80000, 85000, 90000, 95000, 100000, 110000, 120000, 130000, 140000, 150000, 160000, 170000, 180000, 190000, 200000, 250000, 300000, 400000, 500000, 1000000)
• rent_max integer nullable — Maximum monthly rent, yen (one of: 30000, 35000, 40000, 45000, 50000, 55000, 60000, 65000, 70000, 75000, 80000, 85000, 90000, 95000, 100000, 110000, 120000, 130000, 140000, 150000, 160000, 170000, 180000, 190000, 200000, 250000, 300000, 400000, 500000, 1000000)
• rent_includes_fees boolean — Apply the rent bounds to rent plus management fee (default: false)
• no_key_money boolean — Only rooms without key money (礼金なし) (default: false)
• no_deposit boolean — Only rooms without deposit (敷金/保証金なし) (default: false)
• layouts array nullable — Room layouts; any may match (one of: "1R", "1K", "1DK", "1LDK", "2K/2DK", "2LDK", "3K/3DK", "3LDK", "4K/4DK", "4LDK", "5K/5DK", "5LDK+")
• area_min integer nullable — Minimum floor area, m² (one of: 15, 20, 25, 30, 35, 40, 45, 50, 60, 70, 80, 90, 100)
• area_max integer nullable — Maximum floor area, m² (one of: 15, 20, 25, 30, 35, 40, 45, 50, 60, 70, 80, 90, 100)
• walk_minutes_max integer nullable — Maximum walk to the station, minutes (one of: 3, 5, 7, 10, 15, 20)
• building_age_max integer nullable — Maximum building age, years; 0 is new build (one of: 0, 1, 3, 5, 7, 10, 15, 20, 25, 30)
• building_types array nullable — Building types; any may match (one of: "apartment", "mansion", "house", "store_office")
• equipment array nullable — Room equipment; all must match (one of: "separate_bath_toilet", "indoor_laundry", "air_conditioner", "balcony", "gas_stove", "auto_lock", "flooring", "closet", "shower_washbasin", "separate_washbasin", "reheating_bath", "furnished", "free_internet", "top_floor", "corner_room", "loft", "shoe_box", "walk_in_closet", "cooling", "bathroom_dryer", "heated_toilet_seat", "system_kitchen", "ih_cooker", "two_burners", "catv", "bs_antenna", "cs_antenna", "internet", "monitor_intercom", "delivery_box", "bicycle_parking", "garbage_station", "all_electric", "elevator", "rent_card_payment", "initial_cost_card_payment")
• conditions array nullable — Conditions; all must match (one of: "parking", "second_floor_or_above", "south_facing", "one_free_parking", "two_or_more_parking", "motorbike", "move_in_now", "piano_negotiable", "instruments_negotiable", "office_use", "women_only", "seniors_negotiable", "guarantor_service", "pets_negotiable", "foreign_students", "free_rent", "two_people", "condominium_for_rent", "floor_plan", "exterior_photo", "interior_photo", "panorama_photo")
• ground_floor boolean — Only ground-floor rooms (default: false)
• exclude_fixed_term boolean — Leave out fixed-term leases (定期借家) (default: false)
• new_within_days integer nullable — Only rooms posted within this many days (one of: 3, 7)
• sort string — Result order (default: "recommended"; one of: "recommended", "rent_asc", "rent_desc", "building_age_asc", "area_desc")
• count integer required — Max number of rooms to return (min: 1; max: 2000)

Response

• @type string (default: "AbleRoom")
• id string required
• url string required
• building_name string nullable
• building_type string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• stations array (default: [])
  • @type string (default: "JpRentalStation")
  • line string nullable
  • station string nullable
  • walk_minutes integer nullable
  • bus_minutes integer nullable
  • access string nullable
• built_at integer nullable
• age_years integer nullable
• floors_total integer nullable
• structure string nullable
• building_image string nullable
• floor integer nullable
• rent integer nullable
• management_fee integer nullable
• deposit string nullable
• key_money string nullable
• layout string nullable
• area number nullable
• floor_plan_image string nullable
• move_in_now boolean nullable
• tags array (default: [])
• comment string nullable
• shop object nullable
  • @type string (default: "AbleRoomShop")
  • id string nullable
  • name string nullable
  • phone string nullable
• registered_at integer 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 — Able serves no room list for this location 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.