Travel/HotelRanking

Description

Gets the top 10 hotels by hotel genre.

Resource URL

https://app.rakuten.co.jp/services/api/Travel/HotelRanking/20131024

Resource Information

Auth Type App Key
Affiliation Support Yes

Parameters

App ID (string)

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

Genre (string)

This field allows you to specify more than one in CSV format.

Example: genre=all,onsen

If you specify the above, the API server will return the two types of rankings of overall ranking and the hot spring inn rankings.

Valid Values:

  • all overall ranking
  • onsen hot spring inn rankings
  • premium luxury hotel / inn rankings

Default Value: all

Platform (integer)

Whether to return information for PC/smartphone or mobile phone.

Valid Values:

  • 0 PC / smartphone
  • 1 Mobile phones

Default Value: 0

Affiliate ID (string)

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

Response format (string)

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

Callback function name (string)

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

Choosing output fields (string)

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

Format version (integer)

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

applicationId

App ID
string Required

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

genre

Genre
string Optional

This field allows you to specify more than one in CSV format.

Example: genre=all,onsen

If you specify the above, the API server will return the two types of rankings of overall ranking and the hot spring inn rankings.

Valid Values:

  • all overall ranking
  • onsen hot spring inn rankings
  • premium luxury hotel / inn rankings

Default Value: all

carrier

Platform
integer Optional

Whether to return information for PC/smartphone or mobile phone.

Valid Values:

  • 0 PC / smartphone
  • 1 Mobile phones

Default Value: 0

affiliateId

Affiliate ID
string Optional

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

format

Response format
string Optional

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

callback

Callback function name
string Optional

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

elements

Choosing output fields
string Optional

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

formatVersion

Format version
integer Optional

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

Response Example

Request

https://app.rakuten.co.jp/services/api/Travel/HotelRanking/20131024?applicationId=REPLACE_WITH_YOUR_APP_ID&hits=3

Response
{
  "Rankings": [
    {
      "Ranking": {
        "genre": "all",
        "title": "【楽天トラベル】お客さま評価ランキング【総合】",
        "lastBuildDate": "20141102163314",
        "hotels": [
          {
            "hotel": {
              "rank": 1,
              "hotelNo": 19756,
              "hotelName": "八ヶ岳高原 ペンション 乙女座宮",
              "middleClassName": "山梨県",
              "userReview": "八ヶ岳登山のために、友だちと利用しました。寒い雨の日でしたが、宿に着くと奥さんがとても優しく受け入れてくれ、思わずただいまと言いたいくらい安心感がありました。夜食ではお腹いっぱいなり、暖かいお風呂と清… 2014-10-22 20:57:28投稿 つづきはこちら",
              "reviewCount": 298,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=19756",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=19756",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=19756",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=19756",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/19756/19756.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 2,
              "hotelNo": 29176,
              "hotelName": "ペンション プチポワ",
              "middleClassName": "福島県",
              "userReview": "予想以上でした。お風呂は温泉ではないと思いますが、補って余りあります。館内、室内とも奇麗です。食事は5点プラスアルファあげたいくらいです。奥さんの愛想のよい対応も好感が持てます。いつまでも、続けて… 2014-10-28 21:49:53投稿 つづきはこちら",
              "reviewCount": 224,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=29176",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=29176",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=29176",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=29176",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/29176/29176.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 3,
              "hotelNo": 20722,
              "hotelName": "コテージ・パラディーゾ",
              "middleClassName": "沖縄県",
              "userReview": "7月19日から大人3名、子ども3名で二泊させて頂きました。芝生にデッキ、景色も最高で子ども達は自由に遊び回り、親はのんびりと過ごすことができました。バーベキューも美味しく、ボリューム満点!差し入れの海… 2014-08-31 03:39:15投稿 つづきはこちら",
              "reviewCount": 212,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=20722",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=20722",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=20722",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=20722",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/20722/20722.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 4,
              "hotelNo": 68188,
              "hotelName": "那須温泉 ガーデンハウス バイブリー",
              "middleClassName": "栃木県",
              "userReview": "数十年ぶりに那須を訪れました。久しぶりに宿に満足と充実感を覚える旅となりました。外観、内装、お風呂、食事、オーナーご夫妻のお人柄、隅々まで行き届いたおもてなしを感じることができました。紅葉には少し… 2014-10-12 21:03:15投稿 つづきはこちら",
              "reviewCount": 151,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=68188",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=68188",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=68188",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=68188",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/68188/68188.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 5,
              "hotelNo": 15599,
              "hotelName": "ホテル デュシェルブルー",
              "middleClassName": "山梨県",
              "userReview": "10月24日に、山梨の実家の法事の帰りに夫と2人で一泊しました。天候に恵まれ、紅葉も始まったばかりの八ヶ岳でとてもすてきなホテルに宿泊出来ました。お部屋はもちろん庭の木1本1本にまで、オーナー夫婦の… 2014-10-26 18:11:55投稿 つづきはこちら",
              "reviewCount": 139,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=15599",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=15599",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=15599",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=15599",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/15599/15599.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 6,
              "hotelNo": 40476,
              "hotelName": "シェソワ ワカミヤ",
              "middleClassName": "岐阜県",
              "userReview": "初めて利用しました。今回は、口コミを見てたので期待大てましたが、正にその通りでした。色んな意味で、満点評価です!また、利用したいと思います♪ 2014-10-27 17:28:14投稿",
              "reviewCount": 124,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=40476",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=40476",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=40476",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=40476",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/40476/40476.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 7,
              "hotelNo": 74708,
              "hotelName": "民宿あしずり 岬光(はなみつ)",
              "middleClassName": "高知県",
              "userReview": "立地:足摺岬にも白山同門にも金剛福寺にもどこにでも近い好立地です。しかも部屋からは太平洋を一望できるオーシャンビュー!部屋:決して新しくなく、設備が整っているわけではありませんが、とても清潔に… 2014-08-27 09:45:45投稿 つづきはこちら",
              "reviewCount": 94,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=74708",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=74708",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=74708",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=74708",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/74708/74708.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 8,
              "hotelNo": 66511,
              "hotelName": "喜代美旅館",
              "middleClassName": "栃木県",
              "userReview": "8月26日27日と宿泊させていただきました。行き届いた、お声掛けをしていただき、大変嬉しい思いです。有難うございましたm(__)m 2014-08-28 21:17:06投稿",
              "reviewCount": 86,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=66511",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=66511",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=66511",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=66511",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/66511/66511.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 9,
              "hotelNo": 129997,
              "hotelName": "&Hana Stay",
              "middleClassName": "沖縄県",
              "userReview": "豊かな自然に囲まれてゆったりと過ごすことができたことはもちろんですが、1番良かったと思うのは、2日目の鉄板焼きと2日目の朝食のパンでした。鉄板焼きのおいしさは今までの方が書かれている通りの絶品でした。… 2014-10-29 17:13:01投稿 つづきはこちら",
              "reviewCount": 77,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=129997",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=129997",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=129997",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=129997",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/129997/129997.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          },
          {
            "hotel": {
              "rank": 10,
              "hotelNo": 76787,
              "hotelName": "ペンションふうらいぼー",
              "middleClassName": "宮城県",
              "userReview": "10月12日の3連休中日に利用させていただきました。妊娠中の妻と二人だったんですが、コーヒーの代わりにカフェインレスの飲み物を出していただいたり優しい配慮があり有り難かったです☆他の方々の書き… 2014-10-15 21:12:00投稿 つづきはこちら",
              "reviewCount": 49,
              "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/yS4PR/?f_no=76787",
              "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/WrBrg/?f_flg=PLAN&f_no=76787",
              "checkAvailableUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/Ss6mg/?f_no=76787",
              "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/ra/vvC6h/?f_hotel_no=76787",
              "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/76787/76787.jpg",
              "hotelThumbnailUrl": null,
              "reviewAverage": 5,
              "carrier": 0
            }
          }
        ]
      }
    }
  ]
}

Try It

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/Travel/HotelRanking/20131024?applicationId=REPLACE_WITH_YOUR_APP_ID

Response