Skip to main content
POST
/
api
/
suumo
/
properties
/
search
/suumo/properties/search
curl --request POST \
  --url https://api.anysite.io/api/suumo/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "ward": "<string>",
  "count": 2,
  "timeout": 300,
  "property_type": "used_mansion"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@suumo_property_card",
    "name": "<string>",
    "headline": "<string>",
    "price": 123,
    "address": "<string>",
    "transport": "<string>",
    "area": 123,
    "land_area": 123,
    "layout": "<string>",
    "balcony_area": "<string>",
    "built_year_month": "<string>",
    "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
ward
string
required

Ward/city slug to scope the search within the prefecture

Examples:

"minato"

"setagaya"

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
property_type
enum<string>
default:used_mansion

Property category to search

Available options:
used_mansion,
new_mansion,
used_house,
new_house,
land

Response

Successful Response

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