Skip to main content
POST
/
api
/
athome
/
listings
/
search
/athome/listings/search
curl --request POST \
  --url https://api.anysite.io/api/athome/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "pref": "<string>",
  "count": 2,
  "timeout": 300,
  "deal_type": "rent"
}
'
[
  {
    "id": "<string>",
    "deal_type": "<string>",
    "url": "<string>",
    "@type": "@athome_listing_card",
    "name": "<string>",
    "building_type": "<string>",
    "room_number": "<string>",
    "address": "<string>",
    "stations": [],
    "layout": "<string>",
    "area": 123,
    "building_area": 123,
    "land_area": 123,
    "built_year_month": "<string>",
    "floor": "<string>",
    "structure": "<string>",
    "rent": 123,
    "price": 123,
    "management_fee": 123,
    "deposit": "<string>",
    "key_money": "<string>",
    "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 to search in

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

Property deal type

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:@athome_listing_card
name
string | null
building_type
string | null
room_number
string | null
address
string | null
stations
AthomeStation · 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