Skip to main content
POST
/
api
/
suumo
/
listings
/
averages
/suumo/listings/averages
curl --request POST \
  --url https://api.anysite.io/api/suumo/listings/averages \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "timeout": 300,
  "building_type": "mansion"
}
'
[
  {
    "id": "<string>",
    "location_type": "<string>",
    "location_code": "<string>",
    "pref": "<string>",
    "name": "<string>",
    "building_type": "<string>",
    "url": "<string>",
    "@type": "@suumo_rent_average",
    "updated_at": "<string>",
    "averages": [],
    "nearby": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
location
string
required

Ward path ('tokyo/sc_chiyoda'), station path ('tokyo/ek_06640'), or full SUUMO soba URL

Minimum string length: 1
Examples:

"tokyo/sc_chiyoda"

"tokyo/ek_06640"

"osaka/sc_osakashikita"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
building_type
enum<string>
default:mansion

Building type the rent average is computed for

Available options:
mansion,
apartment,
house

Response

Successful Response

​
id
string
required
​
location_type
string
required
​
location_code
string
required
​
pref
string
required
​
name
string
required
​
building_type
string
required
​
url
string
required
​
@type
string
default:@suumo_rent_average
​
updated_at
string | null
​
averages
SuumoRentAverageLayout · object[]
​
nearby
SuumoRentAverageNearby · object[]