お部屋サーチAPI仕様

【更新履歴】

1. 検索方法

下記URLへ必要なGETパラメータを付与しアクセスすることでXML情報を返却します。
http://xml.accesstrade.net/at/ws.html

2. 必須パラメータ

パラメータ 備考
ws_type searchapartment_atm APIタイプ。通常は固定値です。
ws_ver 1 バージョン。通常は固定値です。
ws_id ** 管理画面で取得したWS_ID
area ** エリア ※エリア一覧参照

3. 任意パラメータ

パラメータ名 パラメータ 設定例 備考
商品ID item_id 3459-a10000 カンマ区切りで10件まで複数指定可
プログラムID program_id 12345 カンマ区切りで10件まで複数指定可
物件タイプ apart_type 1 カンマ区切りで10件まで複数指定可
物件タイプを参照
検索キーワード keyword %e3%81%82%e3%81%8b UTF-8、スペースで複数指定可能
賃料上限(円) rent_max 100000 整数値>0
賃料下限(円) rent_min 50000 整数値>0
賃料(管理費・共益費込み)上限(円) rent_alpha_max 110000 整数値>0
賃料(管理費・共益費込み)上限(円) rent_alpha_min 55000 整数値>0
専有面積上限(平米) area_max 40 整数値>0
専有面積下限(平米) area_min 25 整数値>0
沿線名 line 山手線(%E5%B1%B1%E6%89%8B%E7%B7%9A) UTF8エンコード
最寄駅名 station 下北沢(%E4%B8%8B%E5%8C%97%E6%B2%A2) UTF8エンコード
徒歩(分以内) walk 5 整数値>0
バス(分以内) bus 10 整数値>0
都道府県 prefecture 東京(%E6%9D%B1%E4%BA%AC) UTF8エンコード
市区町村 city 中野区(%E4%B8%AD%E9%87%8E%E5%8C%BA) UTF8エンコード
間取り上限 layout_max 15 10の位:部屋数1の位:間取り(R/K/DK/SDK/LDK/SLDK)
間取り下限 layout_min 12 10の位:部屋数1の位:間取り(R/K/DK/SDK/LDK/SLDK)
2階以上 over2floor 1 1:対応
floor 3 整数値>0
階建 story 20 整数値>0
築年XX年以内 built_year 5 整数値
バス・トイレ別 separate 1 1:対応
エアコン air_con 1 1:対応
ペット可否 pet 1 1:対応
新築 new 1 1:対応
室内洗濯機置き場 washer 1 1:対応
楽器相談 instrument 1 1:対応
オートロック auto_lock 1 1:対応
フローリング flooring 1 1:対応
エレベータ elevator 1 1:対応
分譲タイプ condminium 1 1:対応
女性限定 ladys 1 1:対応
角部屋 corner 1 1:対応
南向き south 1 1:対応
追い炊き機能 cook_follow 1 1:対応
ガスキッチン gas_kitchen 1 1:対応
IHクッキングヒーター ih_kitchen 1 1:対応
システムキッチン system_kitchen 1 1:対応
インターネット対応 internet 1 1:対応
光ファイバー ftth 1 1:対応
CATV catv 1 1:対応
最上階 top_floor 1 1:対応
バルコニー balcony 1 1:対応
ベランダ veranda 1 1:対応
ロフト loft 1 1:対応
モニタ付きインターフォン intercom 1 1:対応
宅配ボックス delivery_box 1 1:対応
事務所可(SOHO) soho 1 1:対応
保証人不要 guarantor 1 1:対応
ルームシェア可 roommate 1 1:対応
リフォーム済み renovated 1 1:対応
バリアフリー barrier_free 1 1:対応
ウォシュレット washlet 1 1:対応
シャンプードレッサー dresser_shampoo 1 1:対応
独立洗面台 separate_sink 1 1:対応
浴室乾燥機 bathroom_dry 1 1:対応
冷蔵庫あり refrigerator 1 1:対応
オール電化 all_electric 1 1:対応
コンロ二口以上 multi_burner_gas 1 1:対応
カウンターキッチン kitchen_counter 1 1:対応
トランクルーム storage_room 1 1:対応
床下収納 underfloor_storage 1 1:対応
ウォークインクローゼット walk_in_closet 1 1:対応
BS電子 bs 1 1:対応
石油暖房 oil_heat 1 1:対応
ガス暖房 gas_heat 1 1:対応
床暖房 floor_heat 1 1:対応
24時間セキュリティー security_24h 1 1:対応
敷金 sikikin 1 1:対応
礼金 reikin 1 1:対応
表示件数 row 1 1ページの出力件数,1~30の範囲で指定
ページ page 1 整数値>0
ソート sort 1 整数値>0
※ソート条件参照

4. 出力項目

パラメータ名 設定値 内容
AllResult - 検索結果タグ
Request - 入力パラメータの結果タグ
ws_type searchreserve_atm サービスタイプ(固定値:必須)
ws_ver 1 サービスバージョン(固定値:必須)
ws_id 入力値 パートナーID(WS_ID:必須)
TotalCount 検索結果の数
TotalPage 検索結果の総ページ数
CurrentCount 現在のページに含まれる検索数
CurrentPage 現在のページ
ErrorCode エラーコード
ErrorMsg エラーメッセージ エラーがあればメッセージが表示される。
Apartment タグ開始
ItemId 検索結果 商品ID(ユニークキー)
HandlingCom 検索結果 取扱会社名
HandlingUrl 検索結果 取扱会社URL
RecordType 検索結果 レコード特性
DlvDate 検索結果 引渡可能日(yyyy/mm/dd)
UpdDate 検索結果 物件更新日(yyyy/mm/dd)
LmtDate 検索結果 広告有効期限(yyyy/mm/dd)
Rent 検索結果 賃料/価格(円)
AdministrativeExpense 検索結果 管理費・共益費(円)
Sikikin 検索結果 敷金(正数値:「円」 負数値:「ヶ月」)
Reikin 検索結果 礼金(正数値:「円」 負数値:「ヶ月」)
Hoshokin 検索結果 保証金(正数値:「円」 負数値:「ヶ月」)
Kenrikin 検索結果 権利金(正数値:「円」 負数値:「ヶ月」)
Line 検索結果 沿線名
Station 検索結果 最寄駅名
Walk 検索結果 徒歩所要時間(分)
Bus 検索結果 バス所要時間(分)
Prefecture 検索結果 都道府県
Address 検索結果 詳細住所
LandArea 検索結果 土地面積(平米)
BuildArea 検索結果 建物面積(平米)
MonopolyArea 検索結果 専有面積(平米)
FloorRatio 検索結果 容積率
CoverageRatio 検索結果 建蔽率
Layout 検索結果 間取り
ApartType 検索結果 物件タイプ
BuildStruct 検索結果 構造
Floor 検索結果
Story 検索結果 階建
YearBuilt 検索結果 築年(yyyy/mm/dd)
Separate 検索結果 バス・トイレ別(1:対応)
AirCon 検索結果 エアコン(1:対応)
Pet 検索結果 ペット可否(1:対応)
New 検索結果 新築(1:対応)
IndoorWasherPit 検索結果 室内洗濯機置き場(1:対応)
Instrument 検索結果 楽器(1:対応)
AutoLock 検索結果 オートロック(1:対応)
Flooring 検索結果 フローリング(1:対応)
Elevator 検索結果 エレベータ(1:対応)
Condominium 検索結果 分譲タイプ(1:対応)
Ladys 検索結果 女性限定(1:対応)
Corner 検索結果 角部屋(1:対応)
South 検索結果 南向き(1:対応)
CookFollow 検索結果 追い炊き機能(1:対応)
GasKitchen 検索結果 ガスキッチン(1:対応)
IhKitchen 検索結果 IHクッキングヒーター(1:対応)
SystemKitchen 検索結果 システムキッチン(1:対応)
Internet 検索結果 インターネット対応(1:対応)
Ftth 検索結果 光ファイバー(1:対応)
Catv 検索結果 CATV(1:対応)
TopFloor 検索結果 最上階(1:対応)
Balcony 検索結果 バルコニー(1:対応)
Veranda 検索結果 ベランダ(1:対応)
Loft 検索結果 ロフト(1:対応)
Intercom 検索結果 モニタ付きインターフォン(1:対応)
DeliveryBox 検索結果 宅配ボックス(1:対応)
Soho 検索結果 事務所可(SOHO)(1:対応)
Guarantor 検索結果 保証人不要(1:対応)
Roommate 検索結果 ルームシェア(1:対応)
Renovated 検索結果 リフォーム済み(1:対応)
BarrierFree 検索結果 バリアフリー(1:対応)
Washlet 検索結果 ウォシュレット(1:対応)
DresserShampoo 検索結果 シャンプードレッサー(1:対応)
SeparateSink 検索結果 独立洗面台(1:対応)
BathroomDry 検索結果 浴室乾燥機(1:対応)
Refrigerator 検索結果 冷蔵庫あり(1:対応)
AllElectric 検索結果 オール電化(1:対応)
MultiBurnerGas 検索結果 コンロ二口以上(1:対応)
KitchenCounter 検索結果 カウンターキッチン(1:対応)
StorageRoom 検索結果 トランクルーム(1:対応)
UnderfloorStorage 検索結果 床下収納(1:対応)
WalkInCloset 検索結果 ウォークインクローゼット(1:対応)
Bs 検索結果 BS電子(1:対応)
OilHeat 検索結果 石油暖房(1:対応)
GasHeat 検索結果 ガス暖房(1:対応)
FloorHeat 検索結果 床暖房(1:対応)
Security 検索結果 24時間セキュリティー(1:対応)
SikikinCk 検索結果 敷金(1:対応)
ReikinCk 検索結果 礼金(1:対応)
LinkCode 検索結果 3キャリア共通リンクコード(docomo
LayoutUrl_1 検索結果 間取り図画像1(大)URL
LayoutWidth_1 検索結果 横サイズ(px)
LayoutHeight_1 検索結果 縦サイズ(px)
LayoutUrl_2 検索結果 間取り図画像1(小)URL
LayoutWidth_2 検索結果 横サイズ(px)
LayoutHeight_2 検索結果 縦サイズ(px)
InteriorUrl_1 検索結果 内観画像1(大)URL
InteriorWidth_1 検索結果 横サイズ(px)
InteriorHeight_1 検索結果 縦サイズ(px)
InteriorUrl_2 検索結果 内観画像1(小)URL
InteriorWidth_2 検索結果 横サイズ(px)
InteriorHeight_2 検索結果 縦サイズ(px)
InteriorUrl_3 検索結果 内観画像2(大)URL
InteriorWidth_3 検索結果 横サイズ(px)
InteriorHeight_3 検索結果 縦サイズ(px)
InteriorUrl_4 検索結果 内観画像2(小)URL
InteriorWidth_4 検索結果 横サイズ(px)
InteriorHeight_4 検索結果 縦サイズ(px)
ExteriorUrl_1 検索結果 外観画像1(大)URL
ExteriorWidth_1 検索結果 横サイズ(px)
ExteriorHeight_1 検索結果 縦サイズ(px)
ExteriorUrl_2 検索結果 外観画像1(小)URL
ExteriorWidth_2 検索結果 横サイズ(px)
ExteriorHeight_2 検索結果 縦サイズ(px)
ExteriorUrl_3 検索結果 外観画像2(大)URL
ExteriorWidth_3 検索結果 横サイズ(px)
ExteriorHeight_3 検索結果 縦サイズ(px)
ExteriorUrl_4 検索結果 外観画像2(小)URL
ExteriorWidth_4 検索結果 横サイズ(px)
ExteriorHeight_4 検索結果 縦サイズ(px)
ExteriorUrl_5 検索結果 外観画像3(大)URL
ExteriorWidth_5 検索結果 横サイズ(px)
ExteriorHeight_5 検索結果 縦サイズ(px)
ExteriorUrl_6 検索結果 外観画像3(小)URL
ExteriorWidth_6 検索結果 横サイズ(px)
ExteriorHeight_6 検索結果 縦サイズ(px)
Description 検索結果 説明文
RewardType 検索結果 報酬タイプ(0:クリック、1:定額、2:売上)
RewardRate 検索結果 報酬率
Reward 検索結果 報酬額(円)
AfStatus 検索結果 提携ステータス(0:未提携 1:提携中)
ProgramID 検索結果 プログラムID
ProgramName 検索結果 プログラム名
SiteDescription 検索結果 マーチャント概要
  • レスポンスデータには,未入力の項目もありますので事前に取得した結果を確認してください。

5. 検索例

ws_idは管理画面で取得されたws_idに置き換えてください。

■ エリア:関東,最寄駅:下北沢で探す。

http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchapartment_atm&ws_id=****&area=%e9%96%a2%e6%9d%b1&station=%E4%B8%8B%E5%8C%97%E6%B2%A2

■ エリア:関東,最寄駅:下北沢,賃料:100000円以下で探す。

http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchapartment_atm&ws_id=****&area=%e9%96%a2%e6%9d%b1&station=%E4%B8%8B%E5%8C%97%E6%B2%A2&rent_max=100000



エリア一覧

6. エリア

エリア 値(UTF-8)
北海道・東北 %e5%8c%97%e6%b5%b7%e9%81%93%e3%83%bb%e6%9d%b1%e5%8c%97
甲信越 %e7%94%b2%e4%bf%a1%e8%b6%8a
北陸 %e5%8c%97%e9%99%b8
関東 %e9%96%a2%e6%9d%b1
東海 %e6%9d%b1%e6%b5%b7
近畿 %e8%bf%91%e7%95%bf
中国 %e4%b8%ad%e5%9b%bd
四国 %e5%9b%9b%e5%9b%bd
九州・沖縄 %e4%b9%9d%e5%b7%9e%e3%83%bb%e6%b2%96%e7%b8%84

物件タイプ一覧

7. 物件タイプ

物件タイプ
マンション 1
アパート 2
一戸建て 3
デザイナーズマンション 4
土地 5
駐車場 6
店舗 7
事務所 8
倉庫 9
その他 99

ソート一覧

8. ソート条件

ソート項目
賃料(昇順) 1
賃料(降順) 2
賃料+管理費(昇順) 3
賃料+管理費(降順) 4
徒歩(昇順) 5
徒歩(降順) 6
専有面積(昇順) 7
専有面積(降順) 8
間取り(昇順) 9
間取り(降順) 10
引渡可能日(昇順) 11
物件更新日(降順) 12
広告有効期限(昇順) 13
ランダム検索 14


TOPへ |  ATMWSサンプルの使用について |  API仕様 |  絵文字一覧 |  ダウンロード