Skip to main content
POST
/
api
/
suumo
/
listings
/
search
/suumo/listings/search
curl --request POST \
  --url https://api.anysite.io/api/suumo/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "rent_min": 1,
  "rent_max": 1,
  "area_min": 1,
  "area_max": 1,
  "walk_max": 2,
  "sort": "recommended"
}
'
[
  {
    "id": "<string>",
    "building_id": "<string>",
    "room_id": "<string>",
    "url": "<string>",
    "@type": "@suumo_listing_card",
    "building_name": "<string>",
    "building_type": "<string>",
    "address": "<string>",
    "stations": [],
    "age": "<string>",
    "total_floors": "<string>",
    "floor": "<string>",
    "rent": 123,
    "management_fee": 123,
    "deposit": "<string>",
    "key_money": "<string>",
    "layout": "<string>",
    "area": 123,
    "image": "<string>"
  }
]

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
rent_min
integer | null

Minimum monthly rent (JPY)

Required range: x >= 0
rent_max
integer | null

Maximum monthly rent (JPY)

Required range: x >= 0
area_min
number | null

Minimum floor area (m2)

Required range: x >= 0
area_max
number | null

Maximum floor area (m2)

Required range: x >= 0
walk_max
integer | null

Maximum walking minutes to the nearest station

Required range: x >= 1
sort
enum<string>
default:recommended

Sort order

Available options:
recommended,
rent_asc,
newest,
area_desc,
age_asc

Response

Successful Response

id
string
required
building_id
string
required
room_id
string
required
url
string
required
@type
string
default:@suumo_listing_card
building_name
string | null
building_type
string | null
address
string | null
stations
SuumoStation · 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