Skip to main content
POST
/yahoo/realestate/buildings/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
keyword
string | null

Response

Successful Response

id
string
required
url
string
required
@type
string
default:YahooRealestateBuildingCard
name
string | null
image
string | null
rating
number | null
review_count
integer | null
comment_count
integer | null
address
string | null
transit
string | null
built_year_month
string | null
age
string | null
total_floors
string | null
unit_count
integer | null
for_rent
boolean
default:false
for_sale
boolean
default:false