Skip to main content
POST
/suumo/properties

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
property_type
string
required
@type
string
default:SuumoProperty
name
string | null
price
integer | null
address
string | null
stations
object[]
layout
string | null
area
number | null
land_area
number | null
building_area
number | null
other_area
string | null
floor
string | null
facing
string | null
structure
string | null
total_units
integer | null
units_for_sale
integer | null
built_year_month
string | null
management_fee
string | null
repair_reserve_fund
string | null
land_rights
string | null
use_district
string | null
building_coverage
string | null
floor_area_ratio
string | null
land_category
string | null
land_status
string | null
private_road
string | null
parking
string | null
delivery_time
string | null
transaction_type
string | null
other_fees
string | null
renovation
string | null
restrictions
string | null
notes
string | null
agent_comment
string | null
info_provided_at
string | null
next_update_at
string | null
terms_expire_at
string | null
agent
object | null
image
string | null
images
string[]