Skip to main content
POST
/yahoo/realestate/projects/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
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
include_undecided_price
boolean
default:false
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:
upto_1ldk,
two_room,
three_room,
four_room_plus
move_in
enum<string> | null
Available options:
immediate,
within_3_months,
within_6_months
facets
enum<string>[]
Available options:
new_within_30_days,
has_floor_plan,
has_model_room,
actual_unit_viewable,
on_sale,
upcoming_sale,
online_service,
has_unit_layout_map,
tower,
low_rise,
large_scale,
all_units_south_facing,
eco,
quiet_residential_area,
supermarket_nearby,
park_nearby,
nursery_nearby,
elementary_school_nearby,
hospital_nearby,
all_electric,
full_parking,
pets_ok,
seismic_isolation,
resident_manager_24h,
childcare_friendly,
unit_security_system,
ene_farm,
solar_power,
flexible_reform,
multiple_train_lines,
terminal_station,
garbage_24h,
counter_kitchen,
independent_kitchen,
ih_stove,
disposer,
walk_in_closet,
shoes_in_closet,
study_room,
delivery_box,
shared_facilities,
guest_room,
full_flat_floor,
external_insulation,
floor_heating,
fiber_optic
sort
enum<string>
default:newest
Available options:
newest,
most_reviewed,
station_near,
price_asc,
price_desc,
area_asc,
area_desc,
most_viewed

Response

Successful Response

id
string
required
url
string
required
@type
string
default:YahooRealestateProjectCard
name
string | null
price
string | null
image
string | null
tags
string[]
lead
string | null