Skip to main content
POST
/
api
/
suumo
/
properties
/suumo/properties
curl --request POST \
  --url https://api.anysite.io/api/suumo/properties \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "property": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "property_type": "<string>",
    "@type": "@suumo_property",
    "name": "<string>",
    "price": 123,
    "address": "<string>",
    "stations": [],
    "layout": "<string>",
    "area": 123,
    "land_area": 123,
    "building_area": 123,
    "other_area": "<string>",
    "floor": "<string>",
    "facing": "<string>",
    "structure": "<string>",
    "total_units": 123,
    "units_for_sale": 123,
    "built_year_month": "<string>",
    "management_fee": "<string>",
    "repair_reserve_fund": "<string>",
    "land_rights": "<string>",
    "use_district": "<string>",
    "building_coverage": "<string>",
    "floor_area_ratio": "<string>",
    "land_category": "<string>",
    "land_status": "<string>",
    "private_road": "<string>",
    "parking": "<string>",
    "delivery_time": "<string>",
    "transaction_type": "<string>",
    "other_fees": "<string>",
    "renovation": "<string>",
    "restrictions": "<string>",
    "notes": "<string>",
    "agent_comment": "<string>",
    "info_provided_at": "<string>",
    "next_update_at": "<string>",
    "terms_expire_at": "<string>",
    "agent": {
      "@type": "@suumo_listing_agent",
      "name": "<string>",
      "license_number": "<string>"
    },
    "image": "<string>",
    "images": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required

SUUMO sale property path (e.g. ms/chuko/tokyo/sc_minato/nc_20197336) or a full property URL

Minimum string length: 1
Examples:

"ms/chuko/tokyo/sc_minato/nc_20197336"

"https://suumo.jp/ms/chuko/tokyo/sc_minato/nc_20197336/"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
property_type
string
required
@type
string
default:@suumo_property
name
string | null
price
integer | null
address
string | null
stations
SuumoStation · 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
SuumoListingAgent · object
image
string | null
images
string[]