Skip to main content
POST
/athome/listings/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
pref
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
deal_type
enum<string>
default:rent
Available options:
rent,
used_mansion,
new_mansion,
used_house,
new_house,
land

Response

Successful Response

id
string
required
deal_type
string
required
url
string
required
@type
string
default:AthomeListingCard
name
string | null
building_type
string | null
room_number
string | null
address
string | null
stations
object[]
layout
string | null
area
number | null
building_area
number | null
land_area
number | null
built_year_month
string | null
floor
string | null
structure
string | null
rent
integer | null
price
integer | null
management_fee
integer | null
deposit
string | null
key_money
string | null
image
string | null