ブレインマンション 入居募集中のお部屋紹介

「ブレインマンション 入居募集中のお部屋紹介」では、開発者の為にWeb APIを提供しております。　BRAIN MANSION Web API（以下「API」）は、「ブレインマンション 入居募集中のお部屋紹介」に登録されている各種情報に対して他の外部プログラムからアクセスする為のプログラムインターフェイスです。　注意点をお読みいただき、ご利用下さい。

※APIに関してのお問い合わせはフォームからお願いします。

※APIは開発中でありますので、予告無く仕様変更ならびに中止される場合があります。

※サンプルコードを用意しました。　あくまでもサンプルですので内容の保証は致しません。　またセキュリティー対策等も施しておりません。

1. new
2. near
3. pref
4. addr
5. shop
6. brainmansion

APIのご利用に当たっては、以下についてご注意下さい。

1. APIは非商用目的にのみ利用頂け、再許諾不可のライセンスを利用者に付与するものです。
2. APIのURL形式は以下の通りとなっており、リクエストは全てHTTP GETのみ受け付けます。

   http://search.brainmansion.jp/api/(method)/(id)

3. APIの文字コードはUTF-8のみで、レスポンスはXMLで戻ってきます。
4. レスポンスに失敗した場合、以下のように戻ります。　また、エラーステータスを付記します。

   <?xml version="1.0" encoding="UTF-8" ?>
   <error>
   <status>404</status>
   </error>
   

   400 ： 不正なパラメーター

   403 ： その日の利用回数を超えた

   404 ： パラメーターに対応するデータが存在しない

5. リクエストによっては含まれないレスポンスフィールドがあります。
6. APIによるアクセスは1IPあたり1日500リクエスト（レスポンスエラーを含む）を上限とします※。　また、APIサービスに影響を及ぼす過剰なリクエストに対しては、制限させて頂く場合があります。
   ※15分に1回、5リクエストをした場合を基準とする
7. APIは開発中でありますので、予告無く仕様変更ならびに中止される場合があります。
8. 本サービスは一切の保証を致しません。　APIの利用により発生した一切の問題・損害その他について、「ブレインマンション 入居募集中のお部屋紹介」はその責を負いません。

newメソッドは、新しく登録された物件情報を返します。

用例

http://search.brainmansion.jp/api/new/[number]

[number]パラメーターにはリクエストしたい物件数を入れます。　物件数は１件以上５件以下で、このパラメーターを省略した場合、最新の１件が返ります。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<incoming>

<id>*</id>

<name>最近登録された情報</name>

<brains>

<brain>*************</brain>

<brain>*************</brain>

</brains>

</incoming>

</brainmansion>

• idには返ってきた物件情報の件数が含まれます。
• 物件情報はbrainsの中に、件毎brainに物件IDとして含まれます。
  例）http://search.brainmansion.jp/brainmansion/*************

nearメソッドは、指定した座標の近くにある物件を、直線距離の近い順に返します。

用例

http://search.brainmansion.jp/api/near/[lat],[lng][&ct=x]

[lat]パラメーターには緯度、[lng]パラメーターには経度を指定し、値はGoogleMapによるものとします。　[ct]パラメーターを指定した場合、結果数を制限できます。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<near>

<id>*************,*************</id>

<name>お近くのブレインマンション</name>

<brains>

<brain>*************</brain>

<brain>*************</brain>

</brains>

</near>

</brainmansion>

• idには指定した緯度経度が含まれます。
• 物件情報はbrainsの中に、件毎brainに物件IDとして含まれます。
  例）http://search.brainmansion.jp/brainmansion/*************

prefメソッドは、指定した都道府県で登録された物件情報を返します。

用例

http://search.brainmansion.jp/api/pref/[number]

[number]パラメーターにはリクエストしたい都道府県IDを入れます。

都道府県ID

1 ： 北海道

2 ： 青森県

3 ： 岩手県

4 ： 宮城県

5 ： 秋田県

6 ： 山形県

7 ： 福島県

8 ： 茨城県

9 ： 栃木県

10 ： 群馬県

11 ： 埼玉県

12 ： 千葉県

13 ： 東京都

14 ： 神奈川県

15 ： 新潟県

16 ： 富山県

17 ： 石川県

18 ： 福井県

19 ： 山梨県

20 ： 長野県

21 ： 岐阜県

22 ： 静岡県

23 ： 愛知県

24 ： 三重県

25 ： 滋賀県

26 ： 京都府

27 ： 大阪府

28 ： 兵庫県

29 ： 奈良県

30 ： 和歌山県

31 ： 鳥取県

32 ： 島根県

33 ： 岡山県

34 ： 広島県

35 ： 山口県

36 ： 徳島県

37 ： 香川県

38 ： 愛媛県

39 ： 高知県

40 ： 福岡県

41 ： 佐賀県

42 ： 長崎県

43 ： 熊本県

44 ： 大分県

45 ： 宮崎県

46 ： 鹿児島県

47 ： 沖縄県

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<pref>

<id>*</id>

<name>***</name>

<brains>

<brain>*************</brain>

<brain>*************</brain>

</brains>

</pref>

</brainmansion>

• idには指定した都道府県IDが含まれます。
• nameには指定した都道府県IDの都道府県名が含まれます。
• 物件情報はbrainsの中に、件毎brainに物件IDとして含まれます。
  例）http://search.brainmansion.jp/brainmansion/*************

addrメソッドは、指定した地域で登録された物件情報を返します。

用例

http://search.brainmansion.jp/api/addr/[number]

[number]パラメーターにはリクエストしたい地域IDを入れます。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<address>

<id>**</id>

<name>***</name>

<brains>

<brain>*************</brain>

<brain>*************</brain>

</brains>

</address>

</brainmansion>

• idには指定した地域IDが含まれます。
• nameには指定した地域IDの地域名が含まれます。
• 物件情報はbrainsの中に、件毎brainに物件IDとして含まれます。
  例）http://search.brainmansion.jp/brainmansion/*************

shopメソッドは、業者情報とその業者が登録した物件情報を返します。

用例

http://search.brainmansion.jp/api/shop/[number][&fc=1][&ct=x]

[number]パラメーターにはリクエストしたい業者IDを入れます。　その業者がブレインマンション加盟店である場合、[fc]パラメータに1を指定する事で、登録している媒介業者の登録物件を含めた結果を返します。　[ct]パラメータを指定することで、結果数を制限する事が出来ます。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<shop>

<id>**</id>

<name><![CDATA[**********]]></name>

<zipcode>***-****</zipcode>

<pref>**</pref>

<address><![CDATA[**********]]></address>

<phone>****-****-****</phone>

<fax>****-****-****</fax>

<brainsite>http://subdomain.domain.tld/</brainsite>

<website>http://subdomain.domain.tld/</website>

<map>(**********,**********)</map>

<license>**県知事（*）第******号</license>

<brains>

<brain>*************</brain>

<brain>*************</brain>

</brains>

</shop>

</brainmansion>

• idには指定した業者IDが含まれます。
• nameには業者名が含まれます。
• zipcodeには業者の郵便番号が含まれます。
• prefは業者の都道府県IDが含まれます。（prefメソッドを参照）
• addressには業者の所在地（都道府県を除く）が含まれます。
• phoneには業者の電話番号が含まれます。
• faxには業者のFAX番号が含まれます。
• brainsiteにはブレインマンションの加盟店サイトが含まれます。
• websiteには業者のWebサイトが含まれます。
• mapには業者所在地の緯度経度が含まれます。
• licenseには業者の宅建免許番号が含まれます。
• 物件情報はbrainsの中に、件毎brainに物件IDとして含まれます。
  例）http://search.brainmansion.jp/brainmansion/*************

brainmansionメソッドは、物件情報を返します。

用例

http://search.brainmansion.jp/api/brainmansion/[number]

[number]パラメーターにはリクエストしたい物件ID（半角数字13桁）を入れます。

レスポンス例

<?xml version="1.0" encoding="UTF-8" ?>

<brainmansion>

<remote_addr>***.***.***.***</remote_addr>

<server_addr>***.***.***.***</server_addr>

<brain>

<date>****-**-**</date>

<id>*************</id>

<shop>**</shop>

<aspect>****</aspect>

<kind><![CDATA[*****************]]></kind>

<name><![CDATA[*****************]]></name>

<zipcode>***-****</zipcode>

<pref>**</pref>

<address><![CDATA[**************]]></address>

<map>(**********,**********)</map>

<plan>*****</plan>

<size>*****</size>

<plantext><![CDATA[***************]]></plantext>

<moveindate>*********</moveindate>

<price1>******</price1>

<price2>******</price2>

<price3>******</price3>

<price4>******</price4>

<builddate>****年*月</builddate>

<rooms>**</rooms>

<floors>*</floors>

<floor>*</floor>

<direction>***</direction>

<parking><![CDATA[**。*****]]></parking>

<insurance><![CDATA[**。*****]]></insurance>

<headline><![CDATA[********************]]></headline>

<condition><![CDATA[********************]]></condition>

<equipment><![CDATA[********************]]></equipment>

<images>

<imageurl>http://search.brainmansion.jp/pic/*/t1/**************.jpg</imageurl>

<imageurl>http://search.brainmansion.jp/pic/*/t1/**************.jpg</imageurl>

<imageurl>http://search.brainmansion.jp/pic/*/t1/**************.jpg</imageurl>

</images>

<stations>

<station><![CDATA[*********************]]></station>

<station><![CDATA[*********************]]></station>

</stations>

<amenities>

<aminity><![CDATA[*********************]]></aminity>

<aminity><![CDATA[*********************]]></aminity>

</amenities>

</brain>

</brainmansion>

• idには物件IDが含まれます。
• shopには登録業者名が含まれます。
• aspectには取引様態が含まれます。
• kindにはブレインマンションの種類が含まれます。
• nameには物件名が含まれます。
• zipcodeには物件の郵便番号が含まれます。
• prefは物件の都道府県IDが含まれます。（prefメソッドを参照）
• addressには物件の所在地（都道府県を除く）が含まれます。
• mapにはが物件の緯度経度含まれます。
• planには物件の間取りが含まれます。
• sizeには物件の専有面積が含まれます。
• plantextには物件の間取りの詳細が含まれます。
• moveindateには物件の入居可能日が含まれます。
• price1には物件の賃料が含まれます。
• price2には物件の管理費・共益費が含まれます。
• price3には物件の敷金が含まれます。
• price4には物件の礼金・権利金が含まれます。
• price5には物件の保証金が含まれます。
• price6には物件の償却・敷引が含まれます。
• builddateには物件の築年月が含まれます。
• roomsには物件全体の世帯数が含まれます。
• floorsには物件の総階数が含まれます。
• floorには物件の階数が含まれます。
• directionには物件の向きが含まれます。
• parkingには物件の駐車場情報が含まれます。
• insuranceには物件の保険情報が含まれます。
• headlineには物件の見出しが含まれます。
• conditionには物件の条件が含まれます。
• equipmentには物件の設備が含まれます。
• imagesにはimage別に画像のURLが含まれます。
• stationsにはstation別に最寄駅・沿線の情報が含まれます。
• amenitiesにはamenity別にポイントが含まれます。