Skip to main content
POST
/
api
/
suumo
/
listings
/suumo/listings
curl --request POST \
  --url https://api.anysite.io/api/suumo/listings \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "listing": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "building_id": "<string>",
    "room_id": "<string>",
    "url": "<string>",
    "@type": "@suumo_listing",
    "title": "<string>",
    "building_type": "<string>",
    "address": "<string>",
    "stations": [],
    "layout": "<string>",
    "layout_detail": "<string>",
    "area": 123,
    "floor": "<string>",
    "total_floors": "<string>",
    "facing": "<string>",
    "structure": "<string>",
    "built_year_month": "<string>",
    "age": "<string>",
    "rent": 123,
    "management_fee": 123,
    "deposit": "<string>",
    "key_money": "<string>",
    "guarantee_deposit": "<string>",
    "insurance": "<string>",
    "guarantor_company": "<string>",
    "brokerage_fee": "<string>",
    "other_initial_costs": "<string>",
    "other_fees": "<string>",
    "contract_period": "<string>",
    "parking": "<string>",
    "move_in": "<string>",
    "transaction_type": "<string>",
    "conditions": "<string>",
    "total_units": 123,
    "property_code": "<string>",
    "shop_property_code": "<string>",
    "info_updated_at": "<string>",
    "next_update_at": "<string>",
    "remarks": "<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
listing
string
required

SUUMO rental listing as jnc_{building_id}/{room_id} or a full listing URL

Minimum string length: 1
Examples:

"jnc_000107389936/100508328071"

"https://suumo.jp/chintai/jnc_000107389936/?bc=100508328071"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
building_id
string
required
room_id
string
required
url
string
required
@type
string
default:@suumo_listing
title
string | null
building_type
string | null
address
string | null
stations
SuumoStation · object[]
layout
string | null
layout_detail
string | null
area
number | null
floor
string | null
total_floors
string | null
facing
string | null
structure
string | null
built_year_month
string | null
age
string | null
rent
integer | null
management_fee
integer | null
deposit
string | null
key_money
string | null
guarantee_deposit
string | null
insurance
string | null
guarantor_company
string | null
brokerage_fee
string | null
other_initial_costs
string | null
other_fees
string | null
contract_period
string | null
parking
string | null
move_in
string | null
transaction_type
string | null
conditions
string | null
total_units
integer | null
property_code
string | null
shop_property_code
string | null
info_updated_at
string | null
next_update_at
string | null
remarks
string | null
agent
SuumoListingAgent · object
image
string | null
images
string[]