Recipe/CategoryRanking

Description

Gets the ranking of top recipes by category.

Resource URL

https://app.rakuten.co.jp/services/api/Recipe/CategoryRanking/20170426

Resource Information

Auth Type App Key
Affiliation Support No

Parameters

App ID (string)

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

Category Id (string)

Overall ranking if omitted

If you specify

Example:

categoryId = 10 (major category)

categoryId = 10-276 (medium category)

categoryId = 10-276-824 (small category)

* Only the middle and small categories should be connected with hyphens.

Response format (string)

Format for the response output.

You can set this parameter to json or xml.

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/.

categoryId

Category Id
string Optional

Overall ranking if omitted

If you specify

Example:

categoryId = 10 (major category)

categoryId = 10-276 (medium category)

categoryId = 10-276-824 (small category)

* Only the middle and small categories should be connected with hyphens.

format

Response format
string Optional

Format for the response output.

You can set this parameter to json or xml.

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/Recipe/CategoryRanking/2017042?applicationId=REPLACE_WITH_YOUR_APP_ID&categoryId=10

Response
{
  "result": [
    {
      "foodImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/fbd7dd260d736654532e6c0b1ec185a0cede8675.49.2.3.2.jpg",
      "recipeDescription": "そのままでも、ご飯にのせて丼にしても♪",
      "recipePublishday": "2017/10/10 22:37:34",
      "shop": 0,
      "pickup": 0,
      "recipeId": 1760028309,
      "nickname": "はぁぽじ",
      "smallImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/fbd7dd260d736654532e6c0b1ec185a0cede8675.49.2.3.2.jpg?thum=55",
      "recipeMaterial": [
        "鶏むね肉",
        "塩",
        "酒",
        "片栗粉",
        "○水",
        "○塩",
        "○鶏がらスープの素",
        "○黒胡椒",
        "長ネギ",
        "いりごま",
        "ごま油"
      ],
      "recipeIndication": "約10分",
      "recipeCost": "300円前後",
      "rank": "1",
      "recipeUrl": "https://recipe.rakuten.co.jp/recipe/1760028309/",
      "mediumImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/fbd7dd260d736654532e6c0b1ec185a0cede8675.49.2.3.2.jpg?thum=54",
      "recipeTitle": "ご飯がすすむ!鶏むね肉のねぎ塩焼き"
    },
    {
      "foodImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/aedd5fa798b463b0371dceb8e3d0f529e4dc1b48.79.2.3.2.jpg",
      "recipeDescription": "好評の為レシピを分かりやすくしました。
分量を多少変更しました。(2013年3月)
以前載せていたポテサラパケットは
レシピID: 1590004701です。",
      "recipePublishday": "2012/01/27 21:13:53",
      "shop": 0,
      "pickup": 0,
      "recipeId": 1590002716,
      "nickname": "く〜-Qoo-",
      "smallImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/aedd5fa798b463b0371dceb8e3d0f529e4dc1b48.79.2.3.2.jpg?thum=55",
      "recipeMaterial": [
        "【ハンバーグ材料】",
        "牛豚合びき肉",
        "豚ひき肉",
        "玉ねぎ",
        "パン粉",
        "卵",
        "塩",
        "胡椒",
        "マヨネーズ",
        "合わせ味噌",
        "ナツメグ",
        "コーヒーフレッシュ",
        "【ハンバーグソース材料】",
        "玉ねぎ",
        "みかんやオレンジの果汁",
        "水",
        "醤油",
        "料理酒",
        "みりん",
        "【サラダ】",
        "大根",
        "人参",
        "レタスか白菜",
        "サウザンドレッシング(ダイムドレ代用)",
        "醤油マヨ",
        "炒りごま",
        "ミニトマト"
      ],
      "recipeIndication": "約1時間",
      "recipeCost": "500円前後",
      "rank": "2",
      "recipeUrl": "https://recipe.rakuten.co.jp/recipe/1590002716/",
      "mediumImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/aedd5fa798b463b0371dceb8e3d0f529e4dc1b48.79.2.3.2.jpg?thum=54",
      "recipeTitle": "元店長がこっそり教えるびっくり◯ンキーのハンバーグ"
    },
    {
      "foodImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/60a06d1b3f8929c4803550066cf33ae601f68b6c.66.2.3.2.jpg",
      "recipeDescription": "節約主婦には欠かせない
鶏のムネ肉!!
 
でもレパートリーがないし…
お腹が膨れないのは嫌だし…
時間がかかるのは面倒だし…
 
って事で簡単に美味しく!!",
      "recipePublishday": "2013/02/25 17:07:59",
      "shop": 0,
      "pickup": 1,
      "recipeId": 1100006344,
      "nickname": "かえMAMA",
      "smallImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/60a06d1b3f8929c4803550066cf33ae601f68b6c.66.2.3.2.jpg?thum=55",
      "recipeMaterial": [
        "鶏胸肉",
        "小麦粉",
        "卵",
        "▼甘酢▼",
        "砂糖",
        "酢",
        "醤油",
        "▼タルタルソース▼",
        "卵",
        "玉ねぎ",
        "マヨネーズ",
        "牛乳",
        "パセリ"
      ],
      "recipeIndication": "指定なし",
      "recipeCost": "300円前後",
      "rank": "3",
      "recipeUrl": "https://recipe.rakuten.co.jp/recipe/1100006344/",
      "mediumImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/60a06d1b3f8929c4803550066cf33ae601f68b6c.66.2.3.2.jpg?thum=54",
      "recipeTitle": "ムネ肉で‼簡単チキン南蛮♡"
    },
    {
      "foodImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/1a2766488ee9cee89e4a74365e80dc06f3581539.40.2.3.2.jpg",
      "recipeDescription": "豚バラと大根で色々とお好みの食感が楽しめます♡簡単ですがご飯のすすむ甘辛味でボリュームもありますので節約にも是非どうぞ♬",
      "recipePublishday": "2016/02/23 01:38:30",
      "shop": 0,
      "pickup": 1,
      "recipeId": 1400015997,
      "nickname": "*ももら*",
      "smallImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/1a2766488ee9cee89e4a74365e80dc06f3581539.40.2.3.2.jpg?thum=55",
      "recipeMaterial": [
        "大根",
        "豚バラ肉",
        "ゴマ油",
        "A醤油・みりん・砂糖",
        "Aみそ",
        "Aショウガ",
        "A顆粒だし"
      ],
      "recipeIndication": "約15分",
      "recipeCost": "300円前後",
      "rank": "4",
      "recipeUrl": "https://recipe.rakuten.co.jp/recipe/1400015997/",
      "mediumImageUrl": "https://image.space.rakuten.co.jp/d/strg/ctrl/3/1a2766488ee9cee89e4a74365e80dc06f3581539.40.2.3.2.jpg?thum=54",
      "recipeTitle": "簡単・節約♡テリテリ甘辛みその豚バラ大根"
    }
  ]
}

Try It

Set the Parameters

Show More Parameters (2)

Request

https://app.rakuten.co.jp/services/api/Recipe/CategoryRanking/2017042?applicationId=REPLACE_WITH_YOUR_APP_ID

Response