Skip to main content
POST
/
api
/
athome
/
listings
/athome/listings
curl --request POST \
  --url https://api.anysite.io/api/athome/listings \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "listing": "<string>",
  "timeout": 300,
  "deal_type": "rent"
}
'
[
  {
    "id": "<string>",
    "deal_type": "<string>",
    "url": "<string>",
    "@type": "@athome_listing",
    "name": "<string>",
    "building_type": "<string>",
    "address": "<string>",
    "locality": "<string>",
    "region": "<string>",
    "stations": [],
    "layout": "<string>",
    "area": 123,
    "exclusive_area": 123,
    "building_area": 123,
    "land_area": 123,
    "balcony_area": "<string>",
    "floor": "<string>",
    "facing": "<string>",
    "structure": "<string>",
    "built_year_month": "<string>",
    "unit_count": 123,
    "land_right": "<string>",
    "rent": 123,
    "price": 123,
    "management_fee": 123,
    "price_per_sqm": 123,
    "management_form": "<string>",
    "repair_reserve_fund": "<string>",
    "deposit": "<string>",
    "key_money": "<string>",
    "brokerage_fee": "<string>",
    "rent_guarantee": "<string>",
    "insurance": "<string>",
    "other_lump_sum": "<string>",
    "parking": "<string>",
    "bicycle_parking": "<string>",
    "is_pets_allowed": true,
    "bath_toilet": [],
    "kitchen": [],
    "security": [],
    "storage": [],
    "amenities": [],
    "zoning": "<string>",
    "building_coverage_ratio": "<string>",
    "floor_area_ratio": "<string>",
    "road_access": "<string>",
    "land_category": "<string>",
    "topography": "<string>",
    "city_planning": "<string>",
    "building_permit_number": "<string>",
    "private_road_area": "<string>",
    "setback": "<string>",
    "tsubo": "<string>",
    "features": "<string>",
    "development_area": "<string>",
    "total_unit_count": 123,
    "sale_unit_count": 123,
    "contract_period": "<string>",
    "renewal_fee": "<string>",
    "transaction_type": "<string>",
    "current_status": "<string>",
    "move_in": "<string>",
    "property_code": "<string>",
    "published_date": "<string>",
    "remarks": "<string>",
    "agent": {
      "@type": "@athome_listing_agent",
      "name": "<string>",
      "image": "<string>",
      "address": "<string>",
      "telephone": "<string>",
      "fax": "<string>",
      "latitude": 123,
      "longitude": 123,
      "license_number": "<string>",
      "business_hours": "<string>",
      "holidays": "<string>",
      "memberships": [],
      "url": "<string>"
    },
    "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

athome listing as numeric property id or a full listing URL

Minimum string length: 1
Examples:

"1123919117"

"https://www.athome.co.jp/chintai/1123919117/"

"6988014156"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

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

Property deal type (used to resolve a bare numeric id to its URL)

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
name
string | null
building_type
string | null
address
string | null
locality
string | null
region
string | null
stations
AthomeStation · object[]
layout
string | null
area
number | null
exclusive_area
number | null
building_area
number | null
land_area
number | null
balcony_area
string | null
floor
string | null
facing
string | null
structure
string | null
built_year_month
string | null
unit_count
integer | null
land_right
string | null
rent
integer | null
price
integer | null
management_fee
integer | null
price_per_sqm
integer | null
management_form
string | null
repair_reserve_fund
string | null
deposit
string | null
key_money
string | null
brokerage_fee
string | null
rent_guarantee
string | null
insurance
string | null
other_lump_sum
string | null
parking
string | null
bicycle_parking
string | null
is_pets_allowed
boolean | null
bath_toilet
string[]
kitchen
string[]
security
string[]
storage
string[]
amenities
string[]
zoning
string | null
building_coverage_ratio
string | null
floor_area_ratio
string | null
road_access
string | null
land_category
string | null
topography
string | null
city_planning
string | null
building_permit_number
string | null
private_road_area
string | null
setback
string | null
tsubo
string | null
features
string | null
development_area
string | null
total_unit_count
integer | null
sale_unit_count
integer | null
contract_period
string | null
renewal_fee
string | null
transaction_type
string | null
current_status
string | null
move_in
string | null
property_code
string | null
published_date
string | null
remarks
string | null
agent
AthomeListingAgent · object
image
string | null
images
string[]