Skip to main content
POST
/athome/listings

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
listing
string
required
Minimum string length: 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:AthomeListing
name
string | null
building_type
string | null
address
string | null
locality
string | null
region
string | null
stations
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
object | null
image
string | null
images
string[]