/apamanshop/listings/search

POST /api/apamanshop/listings/search

Price: 10 credits

Search Apamanshop (アパマンショップ) rental rooms in a city with rent, initial cost, layout, size, walk time, building age, property type and feature filters: one row per room with rent, fees, layout, size, floor, building, stations and the handling shop

How to use it

Pass a returned id to apamanshop/listings for the full room, building_id to apamanshop/buildings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city_code string required — Japanese city code (JIS) (examples: "13112", "27127")
• rent_min integer nullable — Minimum monthly rent, yen (one of: 20000, 25000, 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, 210000, 220000, 230000, 240000, 250000, 260000, 270000, 280000, 290000, 300000, 500000, 1000000)
• rent_max integer nullable — Maximum monthly rent, yen (one of: 20000, 25000, 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, 210000, 220000, 230000, 240000, 250000, 260000, 270000, 280000, 290000, 300000, 500000, 1000000)
• rent_includes_fees boolean — Apply the rent bounds to rent plus management fee (default: false)
• no_deposit boolean — Only rooms without deposit (敷金ゼロ) (default: false)
• no_key_money boolean — Only rooms without key money (礼金ゼロ) (default: false)
• free_rent boolean — Only rooms with free-rent months (フリーレント) (default: false)
• double_zero boolean — Only ダブルゼロ (double-zero) plan rooms: no deposit and no key money (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+")
• 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: 1, 5, 7, 10, 15, 20)
• building_age_max integer nullable — Maximum building age, years; 0 is new build (one of: 0, 1, 3, 5, 10, 15, 20)
• property_types array nullable — Property types; any may match (one of: "mansion", "apartment", "house", "store_office", "parking")
• features array nullable — Room and building features; all must match (one of: "rent_card_payment", "initial_cost_card_payment", "steel", "reinforced_concrete", "steel_reinforced_concrete", "light_steel", "wood", "other_structure", "renovated", "refurbished", "sunny", "quiet_residential_area", "tiled_exterior", "furnished", "designer", "condominium_for_rent", "tower_mansion", "move_in_now", "pets_negotiable", "instruments_negotiable", "no_guarantor", "women_only", "office_use", "room_share", "two_people", "seniors", "public_quality_rental", "monthly", "share_house", "elevator", "barrier_free", "garbage_station", "delivery_box", "all_electric", "city_gas", "propane_gas", "catv", "cs_antenna", "bs_antenna", "internet", "digital_tv", "cable_broadcast", "optical_fiber", "free_internet", "tv_intercom", "auto_lock", "security_camera", "emergency_support_24h", "on_site_manager", "dimple_key", "flooring", "loft", "maisonette", "air_conditioner", "ground_floor", "second_floor_or_above", "corner_room", "private_garden", "balcony", "bay_window", "south_facing", "floor_heating", "roof_balcony", "balcony_two_sides", "ventilation_24h", "system_kitchen", "gas_kitchen", "ih_cooker", "two_burners", "counter_kitchen", "refrigerator", "dishwasher", "disposer", "separate_bath_toilet", "indoor_laundry", "separate_washbasin", "shampoo_dresser", "hot_water", "reheating_bath", "heated_toilet_seat", "bathroom_dryer", "trunk_room", "underfloor_storage", "shoe_box", "closet", "walk_in_closet", "parking", "parking_two_cars", "bicycle_parking", "motorbike_parking", "share_cycle", "for_single_women", "for_child_raising", "for_cooking", "for_pets", "for_storage", "for_room_share", "renovated_or_refurbished", "warm_in_winter", "for_seniors", "panorama_photo", "video")
• sort string — Result order (default: "recommended"; one of: "recommended", "newest", "rent_asc", "rent_desc", "area_desc", "building_age_asc")
• count integer required — Max number of rooms to return (min: 1; max: 3000)

Response

• @type string (default: "ApamanshopRoom")
• id string required
• url string required
• building_id string nullable
• building_name string nullable
• building_type string nullable
• address string 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
• floors_total integer nullable
• age_years 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
• comment string nullable
• tags array (default: [])
• shop object nullable
  • @type string (default: "ApamanshopRoomShop")
  • id string nullable
  • name string nullable
  • rating number 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 — Apamanshop serves no room list for this city 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.