Skip to main content
POST
/yahoo/realestate/listings/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
pref
enum<string>
required
Available options:
hokkaido,
aomori,
iwate,
miyagi,
akita,
yamagata,
fukushima,
ibaraki,
tochigi,
gunma,
saitama,
chiba,
tokyo,
kanagawa,
niigata,
toyama,
ishikawa,
fukui,
yamanashi,
nagano,
gifu,
shizuoka,
aichi,
mie,
shiga,
kyoto,
osaka,
hyogo,
nara,
wakayama,
tottori,
shimane,
okayama,
hiroshima,
yamaguchi,
tokushima,
kagawa,
ehime,
kochi,
fukuoka,
saga,
nagasaki,
kumamoto,
oita,
miyazaki,
kagoshima,
okinawa
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
city
string | null
rent_min
integer | null
Required range: x >= 0
rent_max
integer | null
Required range: x >= 0
area_min
number | null
Required range: x >= 0
area_max
number | null
Required range: x >= 0
walk_max
integer | null
Required range: x >= 1
layouts
enum<string>[]
Available options:
one_room,
1k,
1dk,
1ldk,
2k,
2dk,
2ldk,
3k,
3dk,
3ldk,
4k,
4dk,
4ldk,
5k_plus
building_types
enum<string>[]
Available options:
mansion,
house,
apartment
structures
enum<string>[]
Available options:
reinforced_concrete,
steel,
wood,
block_other
max_age
enum<string> | null
Available options:
new,
within_2_years,
within_5_years,
within_10_years,
within_15_years,
within_20_years
facets
enum<string>[]
Available options:
air_conditioner,
auto_lock,
two_plus_balconies,
bicycle_parking,
bathroom_dryer,
bed,
barrier_free,
bs_antenna,
separate_bath_toilet,
counter_kitchen,
closet,
parking,
satellite_broadcast,
cable_tv,
delivery_box,
elevator,
first_floor,
floor_heating,
flooring,
free_rent,
garage,
gas_stove_ok,
reheating_bath,
ih_stove,
immediate_move_in,
card_key,
lighting,
loft,
women_only,
maisonette,
instruments_ok,
resident_manager,
video_intercom,
south_facing,
elderly_welcome,
two_plus_parking,
pets_ok,
propane_gas,
roof_balcony,
corner_room,
refrigerator,
security_24h,
second_floor_or_higher,
system_kitchen,
condo_type,
students_only,
specified_quality_rental,
storage,
top_floor,
city_gas,
terrace_garden,
two_person_ok,
exclude_fixed_term,
trunk_room,
veranda,
walk_in_closet,
washlet,
washer_space,
washstand
rent_conditions
enum<string>[]
Available options:
management_fee_included,
no_deposit,
no_key_money
online
enum<string>[]
Available options:
video_call,
online_viewing,
it_explanation
info_open
enum<string> | null
Available options:
today,
within_3_days,
within_5_days,
within_7_days
keyword
string | null
sort
enum<string>
default:newest
Available options:
newest,
price_incl_asc,
price_incl_desc,
price_asc,
price_desc,
area_desc,
station_near,
age_newest,
most_viewed

Response

Successful Response

id
string
required
url
string
required
@type
string
default:YahooRealestateListingCard
structure_id
string | null
building_name
string | null
building_type
string | null
stations
object[]
address
string | null
age
string | null
total_floors
string | null
structure
string | null
floor
string | null
rent
integer | null
management_fee
integer | null
deposit
string | null
key_money
string | null
layout
string | null
area
number | null
image
string | null