Skip to main content
POST
/suumo/properties/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
ward
string | null
line
string | null
Minimum string length: 1
stations
string[]
property_type
enum<string>
default:used_mansion
Available options:
used_mansion,
used_house,
new_house,
land
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
area_min
number | null
Required range: x >= 0
area_max
number | null
Required range: x >= 0
building_area_min
number | null
Required range: x >= 0
building_area_max
number | null
Required range: x >= 0
land_area_min
number | null
Required range: x >= 0
land_area_max
number | null
Required range: x >= 0
layouts
enum<string>[] | null
Available options:
studio,
one_room,
two_room,
three_room,
four_room,
five_room_plus
max_age
enum<string> | null
Available options:
new,
1,
3,
5,
7,
10,
15,
20,
25,
30
walk_max
integer | null
Required range: x >= 1
sort
enum<string> | null
Available options:
newest,
price_asc,
price_desc,
area_asc,
area_desc,
built_oldest,
built_newest
condo_facets
enum<string>[]
Available options:
pets_allowed,
parking_available,
south_facing,
elevator,
roof_balcony
house_facets
enum<string>[]
Available options:
parking_two_cars,
has_movie,
city_gas,
ldk_15_tatami_plus,
south_facing
land_facets
enum<string>[]
Available options:
hilltop,
regular_shape,
flat_ground,
city_gas,
public_sewer
build_condition
enum<string> | null
Available options:
without,
with

Response

Successful Response

id
string
required
url
string
required
@type
string
default:SuumoPropertyCard
name
string | null
headline
string | null
price
integer | null
address
string | null
transport
string | null
area
number | null
building_area
number | null
land_area
number | null
layout
string | null
balcony_area
string | null
built_year_month
string | null
image
string | null