Skip to main content
POST
/suumo/listings/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
pref
enum<string>
required
Available options:
tokyo,
kanagawa,
osaka,
saitama,
chiba,
aichi,
hyogo,
fukuoka,
hokkaido,
kyoto
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
line
string | null
Minimum string length: 1
stations
string[]
rent_min
integer | null
Required range: x >= 0
rent_max
integer | null
Required range: x >= 0
area_min
number | null
Required range: x >= 0
area_max
number | null
Required range: x >= 0
walk_max
integer | null
Required range: x >= 1
layouts
enum<string>[]
Available options:
one_room,
1k,
1dk,
1ldk,
2k,
2dk,
2ldk,
3k,
3dk,
3ldk,
4k,
4dk,
4ldk,
5k_plus
building_types
enum<string>[]
Available options:
mansion,
apartment,
house,
other
max_age
enum<string> | null
Available options:
new,
within_1_year,
within_3_years,
within_5_years,
within_7_years,
within_10_years,
within_15_years,
within_20_years,
within_25_years,
within_30_years
facets
enum<string>[]
Available options:
above_2nd_floor,
top_floor,
corner_room,
south_facing,
first_floor,
gas_stove_ready,
ih_stove,
two_plus_burners,
all_electric,
system_kitchen,
counter_kitchen,
separate_bath_toilet,
washlet,
bathroom_dryer,
reheating_bath,
shower_room,
internet_available,
bs_antenna,
cs_antenna,
cable_tv,
free_internet,
indoor_washer_space,
separate_washroom,
flooring,
maisonette,
loft,
soundproof_room,
basement,
furnished,
air_conditioner,
floor_heating,
kerosene_heating,
gas_heating,
under_floor_storage,
shoe_box,
trunk_room,
walk_in_closet,
auto_lock,
caretaker,
video_intercom,
security_company,
security_camera,
parking,
bicycle_parking,
motorcycle_parking,
elevator,
delivery_box,
on_site_garbage_area,
balcony,
roof_balcony,
private_garden,
parking_two_plus,
on_site_parking,
city_gas,
propane_gas,
barrier_free,
designers,
condo_for_rent,
no_guarantor,
tower_mansion,
reformed,
renovated,
online_contract,
initial_cost_card_payment,
rent_card_payment,
immediate_move_in,
pets_allowed,
instruments_allowed,
office_use_allowed,
room_share_allowed,
exclude_fixed_term,
diy_allowed,
women_only,
customizable,
elderly_welcome,
lgbt_friendly,
free_rent,
specified_quality_rental,
floor_plan_image,
photo,
new_today,
new_recent,
property_video,
panorama
rent_conditions
enum<string>[]
Available options:
management_fee_included,
no_key_money,
no_deposit
sort
enum<string>
default:recommended
Available options:
recommended,
rent_asc,
rent_desc,
newest,
age_newest,
area_desc,
by_address

Response

Successful Response

id
string
required
building_id
string
required
room_id
string
required
url
string
required
@type
string
default:SuumoListingCard
building_name
string | null
building_type
string | null
address
string | null
stations
object[]
age
string | null
total_floors
string | null
floor
string | null
rent
integer | null
management_fee
integer | null
deposit
string | null
key_money
string | null
layout
string | null
area
number | null
image
string | null