Skip to main content
POST
/
api
/
suumo
/
projects
/suumo/projects
curl --request POST \
  --url https://api.anysite.io/api/suumo/projects \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "project": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@suumo_project",
    "name": "<string>",
    "price": 123,
    "price_max": 123,
    "price_text": "<string>",
    "price_band": "<string>",
    "address": "<string>",
    "stations": [],
    "layout": "<string>",
    "area_range": "<string>",
    "other_area": "<string>",
    "total_units": 123,
    "total_units_text": "<string>",
    "units_for_sale": 123,
    "units_for_sale_text": "<string>",
    "structure": "<string>",
    "site_area": 123,
    "building_area": 123,
    "total_floor_area": 123,
    "use_district": "<string>",
    "land_rights": "<string>",
    "completion_date": "<string>",
    "delivery_time": "<string>",
    "management_fee": "<string>",
    "management_preparation_fee": "<string>",
    "repair_reserve_fund": "<string>",
    "repair_reserve_basic_fund": "<string>",
    "other_fees": "<string>",
    "parking": "<string>",
    "bicycle_parking": "<string>",
    "motorcycle_parking": "<string>",
    "management_form": "<string>",
    "property_kind": "<string>",
    "sales_schedule": "<string>",
    "restrictions": "<string>",
    "other_overview": "<string>",
    "terms_expire_at": "<string>",
    "sellers": [],
    "inquiry_name": "<string>",
    "inquiry_phone": "<string>",
    "floor_plans": [],
    "image": "<string>",
    "images": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
project
string
required

SUUMO new-build condominium project path (e.g. ms/shinchiku/tokyo/sc_minato/nc_67731397) or a full project URL

Minimum string length: 1
Examples:

"ms/shinchiku/tokyo/sc_minato/nc_67731397"

"https://suumo.jp/ms/shinchiku/tokyo/sc_minato/nc_67731397/"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@suumo_project
name
string | null
price
integer | null
price_max
integer | null
price_text
string | null
price_band
string | null
address
string | null
stations
SuumoStation · object[]
layout
string | null
area_range
string | null
other_area
string | null
total_units
integer | null
total_units_text
string | null
units_for_sale
integer | null
units_for_sale_text
string | null
structure
string | null
site_area
number | null
building_area
number | null
total_floor_area
number | null
use_district
string | null
land_rights
string | null
completion_date
string | null
delivery_time
string | null
management_fee
string | null
management_preparation_fee
string | null
repair_reserve_fund
string | null
repair_reserve_basic_fund
string | null
other_fees
string | null
parking
string | null
bicycle_parking
string | null
motorcycle_parking
string | null
management_form
string | null
property_kind
string | null
sales_schedule
string | null
restrictions
string | null
other_overview
string | null
terms_expire_at
string | null
sellers
string[]
inquiry_name
string | null
inquiry_phone
string | null
floor_plans
SuumoProjectFloorPlan · object[]
image
string | null
images
string[]