Skip to main content
POST
/
api
/
suumo
/
projects
/
search
/suumo/projects/search
curl --request POST \
  --url https://api.anysite.io/api/suumo/projects/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "ward": "minato",
  "price_min": 1,
  "price_max": 1,
  "area_min": 1,
  "area_max": 1,
  "layouts": [],
  "walk_max": 2,
  "facets": []
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@suumo_project_card",
    "name": "<string>",
    "description": "<string>",
    "address": "<string>",
    "stations": [],
    "delivery_time": "<string>",
    "price": 123,
    "price_max": 123,
    "price_band": "<string>",
    "layout": "<string>",
    "area_range": "<string>",
    "layout_type_count": 123,
    "prices": [],
    "image": "<string>",
    "images": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
pref
enum<string>
required

Prefecture to search in

Available options:
tokyo,
kanagawa,
osaka,
saitama,
chiba,
aichi,
hyogo,
fukuoka,
hokkaido,
kyoto
​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
ward
string | null

City/ward to scope the search within the prefecture, as a readable slug (e.g. 'minato', 'setagaya') or the SUUMO numeric ward code (e.g. '13103')

Example:

"minato"

​
price_min
integer | null

Minimum price (JPY)

Required range: x >= 0
​
price_max
integer | null

Maximum price (JPY)

Required range: x >= 0
​
area_min
number | null

Minimum exclusive floor area (m2)

Required range: x >= 0
​
area_max
number | null

Maximum exclusive floor area (m2)

Required range: x >= 0
​
layouts
enum<string>[]

Floor-plan layouts to include (any of)

Available options:
studio,
one_room,
two_room,
three_room,
four_room,
five_room_plus
​
walk_max
integer | null

Maximum walking minutes to the nearest station

Required range: x >= 1
​
facets
enum<string>[]

Required features and conditions (all must match)

Available options:
new_arrival,
has_floor_plan,
has_coverage_report,
disposer,
induction_cooker,
water_purifier,
full_parking,
pets_allowed,
enhanced_security,
front_service,
shared_facilities,
manned_24h,
garbage_24h,
earthquake_resistant,
above_20_floors,
performance_certificate,
external_insulation,
fiber_optic,
all_electric,
multiple_lines,
terminal_station,
supermarket_5min,
sea_10min,
category1_low_rise,
tokyo_tower_view,
mount_fuji_view,
double_floor_ceiling,
floor_heating,
barrier_free,
large_bathroom,
roof_balcony,
private_garden,
walk_in_closet,
large_living,
high_sash,
wide_span,
high_ceiling,
top_floor,
above_10th_floor,
corner_unit,
below_4th_floor,
south_facing
​
sort
enum<string> | null

Sort order

Available options:
newest,
price_asc,
price_desc,
area_asc,
area_desc,
layout_asc,
layout_desc,
total_units_asc,
total_units_desc

Response

Successful Response

​
id
string
required
​
url
string
required
​
@type
string
default:@suumo_project_card
​
name
string | null
​
description
string | null
​
address
string | null
​
stations
SuumoStation · object[]
​
delivery_time
string | null
​
price
integer | null
​
price_max
integer | null
​
price_band
string | null
​
layout
string | null
​
area_range
string | null
​
layout_type_count
integer | null
​
prices
SuumoProjectPrice · object[]
​
image
string | null
​
images
string[]