Skip to main content
POST
/
api
/
lifull
/
listings
/
reviews
/lifull/listings/reviews
curl --request POST \
  --url https://api.anysite.io/api/lifull/listings/reviews \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "listing": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "@type": "@lifull_listing_review",
    "area": "<string>",
    "age_band": "<string>",
    "gender": "<string>",
    "text": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
listing
string
required

LIFULL HOME'S listing as a full URL, a rent room hash, or a buy building id. Returns neighborhood (area) resident reviews shown on the listing page.

Minimum string length: 1
Examples:

"https://www.homes.co.jp/chintai/room/6745a4558d08f4166fbb81a23b03df51522e3e61/"

"https://www.homes.co.jp/mansion/b-1090830005006/"

​
count
integer
required

Max number of reviews to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
@type
string
default:@lifull_listing_review
​
area
string | null
​
age_band
string | null
​
gender
string | null
​
text
string | null