Home      Tool Box     SDK     Ruby SDK

Ruby SDK

Source Code: https://github.com/rakuten-ws/rws-ruby-sdk


CI Build Status Gem Version Test Coverage Code Climate Gitter

This gem provides a client for easily accessing Rakuten Web Service APIs.


Table of Contents


  • Ruby 2.5 or later


Add this line to your application's Gemfile:

gem 'rakuten_web_service'

And then execute:

sh bundle

Or install it yourself as:

sh gem install rakuten_web_service


Prerequisite: Getting Application ID

You need to get Application ID for your application to access to Rakuten Web Service APIs. If you have not got it, register your application here.


At first, you have to specify your application's key. And you can tell the client your afiiliate id with RakutenWebService.configure.

In Your Code

  RakutenWebService.configure do |c|
    # (Required) Appliction ID for your application.
    c.application_id = 'YOUR_APPLICATION_ID'

# (Optional) Affiliate ID for your Rakuten account.
c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil

# (Optional) # of retries to send requests when the client receives
# When the number of requests in some period overcomes the limit, the endpoints will return
# too many requests error. Then the client tries to retry to send the same request after a
# while.
c.max_retries = 3 # default: 5

# (Optional) Enable debug mode. When set true, the client streams out all HTTP requests and
# responses to the standard error.
c.debug = true # default: false

Please note that you need to replace 'YOUR_APPLICATION_ID' and 'YOUR_AFFILIATE_ID' with actual ones you have.

Environment Variables

You can configure application_id and affiliate_id by defining environment variables RWS_APPLICATION_ID and RWS_AFFILIATION_ID.

Search Ichiba Items

  items = RakutenWebService::Ichiba::Item.search(keyword: 'Ruby') # This returns Enumerable object
  items.first(10).each do |item|
    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.


Responses of resources' search such as RakutenWebService::Ichiba::Item.search have methods for paginating fetched resources.

  items = RakutenWebService::Ichiba::Item.search(keyword: 'Ruby')
  items.count #=> 30. In default, the API returns up to 30 items matched with given keywords.

  last_items = items.page(3) # Skips first 2 pages.

  # Go to the last page
  while last_items.next_page?
    last_items = last_items.next_page

  # Shows the title of the last 30 items
  last_items.each do |item|
    puts item.name

  # Easier way to fetch all resources page 3 and latter
  items.page(3).all do |item|
    puts item.name


Genre class provides an interface to traverse sub genres.

  root = RakutenWebService::Ichiba::Genre.root # root genre
  # children returns sub genres
  root.children.each do |child|
    puts "[#{child.id}] #{child.name}"

  # Use genre id to fetch genre object
  RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"

Ichiba Item Ranking

  ranking_by_age = RakutenWebService::Ichiba::Item.ranking(age: 30, sex: 1) # returns the TOP 30 items for Male in 30s
  # For attributes other than 'itemName', see: http://webservice.rakuten.co.jp/api/ichibaitemsearch/#outputParameter
  ranking_by_age.each do |ranking|
    puts item.name

  ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # the TOP 30 items in "水・ソフトドリンク" genre
  ranking_by_genre.each do |ranking|
    puts item.name


  categories = RakutenWebService::Recipe.small_categories

  # Search all small recipe categories.
  categories.each do |category|

  recipes = categories.first.ranking

  # Search category recipes.
  recipes.each do |recipe|

Supported APIs

Now rakuten_web_service is supporting the following APIs:

Rakuten Ichiba APIs

Rakuten Books APIs

Rakuten Kobo APIs

Rakuten Recipe APIs

Rakuten GORA APIs

Rakuten Travel APIs


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request