Skip to main content
POST
/
api
/
lifull
/
listings
/
search
/lifull/listings/search
curl --request POST \
  --url https://api.anysite.io/api/lifull/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "pref": "<string>",
  "count": 2,
  "timeout": 300,
  "deal_type": "rent",
  "price_min": 1,
  "price_max": 1,
  "area_min": 1,
  "area_max": 1,
  "walk_minutes": 2,
  "built_within": 2,
  "sort": "recommended"
}
'
[
  {
    "id": "<string>",
    "deal_type": "<string>",
    "url": "<string>",
    "@type": "@lifull_search_card",
    "name": "<string>",
    "price": "<string>",
    "layout": "<string>",
    "area": 123,
    "facing": "<string>",
    "floor": "<string>",
    "room_number": "<string>",
    "address": "<string>",
    "transit": [],
    "image": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
pref
string
required

Prefecture slug

Minimum string length: 1
Examples:

"tokyo"

"osaka"

"kanagawa"

​
count
integer
required

Max number of results to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
deal_type
enum<string>
default:rent

rent or buy

Available options:
rent,
buy
​
price_min
integer | null

Minimum price (rent JPY/month, buy JPY)

Required range: x >= 0
​
price_max
integer | null

Maximum price (rent JPY/month, buy JPY)

Required range: x >= 0
​
area_min
integer | null

Minimum exclusive area (m²)

Required range: x >= 0
​
area_max
integer | null

Maximum exclusive area (m²)

Required range: x >= 0
​
walk_minutes
integer | null

Max walking minutes from the nearest station

Required range: x >= 1
​
built_within
integer | null

Max building age in years

Required range: x >= 1
​
structure
enum<string> | null

Building structure filter

Available options:
rebar,
wooden,
steelframe,
blockother
​
sort
enum<string>
default:recommended

Sort order

Available options:
recommended,
price_asc,
price_desc,
area_desc,
newest_built,
newest

Response

Successful Response

​
id
string
required
​
deal_type
string
required
​
url
string
required
​
@type
string
default:@lifull_search_card
​
name
string | null
​
price
string | null
​
layout
string | null
​
area
number | null
​
facing
string | null
​
floor
string | null
​
room_number
string | null
​
address
string | null
​
transit
string[]
​
image
string | null