Skip to main content
POST
/
api
/
lifull
/
listings
/lifull/listings
curl --request POST \
  --url https://api.anysite.io/api/lifull/listings \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "listing": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "deal_type": "<string>",
    "url": "<string>",
    "@type": "@lifull_listing",
    "name": "<string>",
    "price": "<string>",
    "management_fee": "<string>",
    "maintenance_fee": "<string>",
    "deposit": "<string>",
    "key_money": "<string>",
    "layout": "<string>",
    "area": 123,
    "balcony_area": 123,
    "facing": "<string>",
    "floor": "<string>",
    "total_floors": "<string>",
    "total_units": "<string>",
    "built": "<string>",
    "address": "<string>",
    "transit": [],
    "structure": "<string>",
    "parking": "<string>",
    "status": "<string>",
    "available_from": "<string>",
    "contract_type": "<string>",
    "contract_period": "<string>",
    "renewal_fee": "<string>",
    "other_fees": "<string>",
    "guarantor_company": "<string>",
    "land_rights": "<string>",
    "use_district": "<string>",
    "management": "<string>",
    "transaction_type": "<string>",
    "pets": "<string>",
    "other_conditions": "<string>",
    "remarks": "<string>",
    "housing_insurance": "<string>",
    "handover": "<string>",
    "land_law_notification": "<string>",
    "published_at": "<string>",
    "updated_at": "<string>",
    "company_name": "<string>",
    "listing_number": "<string>",
    "location_path": [],
    "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

LIFULL HOME'S listing as a full URL, a rent room hash, or a buy building id. Rent: /chintai/room/{hash}/ ; Buy: /mansion/b-{id}/ (also kodate/tochi).

Minimum string length: 1
Examples:

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

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

"6745a4558d08f4166fbb81a23b03df51522e3e61"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
deal_type
string
required
url
string
required
@type
string
default:@lifull_listing
name
string | null
price
string | null
management_fee
string | null
maintenance_fee
string | null
deposit
string | null
key_money
string | null
layout
string | null
area
number | null
balcony_area
number | null
facing
string | null
floor
string | null
total_floors
string | null
total_units
string | null
built
string | null
address
string | null
transit
LifullTransit · object[]
structure
string | null
parking
string | null
status
string | null
available_from
string | null
contract_type
string | null
contract_period
string | null
renewal_fee
string | null
other_fees
string | null
guarantor_company
string | null
land_rights
string | null
use_district
string | null
management
string | null
transaction_type
string | null
pets
string | null
other_conditions
string | null
remarks
string | null
housing_insurance
string | null
handover
string | null
land_law_notification
string | null
published_at
string | null
updated_at
string | null
company_name
string | null
listing_number
string | null
location_path
string[]
image
string | null
images
string[]