Kobo/EbookSearch

Description

Gets up to 30 Kobo items by keyword, title, author, publisher, item number or genre.

Resource URL

https://app.rakuten.co.jp/services/api/Kobo/EbookSearch/20140811

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

Keyword (string)

Search for keyword.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

Book title (string)

Search for book title.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

Author's name (string)

Search for author's name.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

Publisher (string)

Search for publisher's name.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

Item Number (string)

Search for item number.

Kobo Genre ID (string)

ID for identifying the genre in Rakuten Kobo

(Please note that this ID is different from the Rakuten Ichiba genre ID)

Parent is KoboGenreId = 101 (e-book).

If you want to browse the Genre structure, please use the "Rakuten Kobo genre search API (Kobo/GenreSearch)".

Default Value: 101

Language (string)

It is possible to specify the language of the e-book

How many results per page (integer)

Integer 1 to 30.

Default Value: 30

Result page (integer)

Integer 1 to 100.

Default Value: 1

Sort (string)

※ Please use UTF-8 encoded parameters.

Valid Values:

  • standard standard
  • +releaseDate Release Date (old)
  • -releaseDate Release Date (new)
  • +itemPrice Cheap price
  • -itemPrice high price
  • reviewCount Number of reviews
  • reviewAverage High rating average

Default Value: standard

Negative Keywords (string)

Keywords that you want to exclude from search query.

Search field (integer)

Valid Values:

  • 0 Broad search match
  • 1 Exact search match

Default Value: 1

OR search flag (integer)

When multiple keywords are set it defaults for AND operator search, but you can switch to OR operator mode.

Valid Values:

  • 0 AND search
  • 1 OR search

Default Value: 0

Genre information flag (integer)

Valid Values:

  • 0 do not get the items of information for each genre
  • 1 get the items of information for each genre

Default Value: 0

Sales Type (integer)

Valid Values:

  • 0 Normal items
  • 1 Pre-Orders

Default Value: ALL

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

keyword

Keyword
string At least one is required

Search for keyword.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

title

Book title
string At least one is required

Search for book title.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

author

Author's name
string At least one is required

Search for author's name.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

publisherName

Publisher
string At least one is required

Search for publisher's name.

UTF-8 encoded string.

If you want to search from multiple keyword they must be separated by a space.

itemNumber

Item Number
string At least one is required

Search for item number.

koboGenreId

Kobo Genre ID
string At least one is required

ID for identifying the genre in Rakuten Kobo

(Please note that this ID is different from the Rakuten Ichiba genre ID)

Parent is KoboGenreId = 101 (e-book).

If you want to browse the Genre structure, please use the "Rakuten Kobo genre search API (Kobo/GenreSearch)".

Default Value: 101

language

Language
string Optional

It is possible to specify the language of the e-book

hits

How many results per page
integer Optional

Integer 1 to 30.

Default Value: 30

page

Result page
integer Optional

Integer 1 to 100.

Default Value: 1

sort

Sort
string Optional

※ Please use UTF-8 encoded parameters.

Valid Values:

  • standard standard
  • +releaseDate Release Date (old)
  • -releaseDate Release Date (new)
  • +itemPrice Cheap price
  • -itemPrice high price
  • reviewCount Number of reviews
  • reviewAverage High rating average

Default Value: standard

NGKeyword

Negative Keywords
string Optional

Keywords that you want to exclude from search query.

field

Search field
integer Optional

Valid Values:

  • 0 Broad search match
  • 1 Exact search match

Default Value: 1

orFlag

OR search flag
integer Optional

When multiple keywords are set it defaults for AND operator search, but you can switch to OR operator mode.

Valid Values:

  • 0 AND search
  • 1 OR search

Default Value: 0

genreInformationFlag

Genre information flag
integer Optional

Valid Values:

  • 0 do not get the items of information for each genre
  • 1 get the items of information for each genre

Default Value: 0

salesType

Sales Type
integer Optional

Valid Values:

  • 0 Normal items
  • 1 Pre-Orders

Default Value: ALL

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/Kobo/EbookSearch/20140811?applicationId=REPLACE_WITH_YOUR_APP_ID&author=村上春樹&hits=3

Response
{
  "count": 12,
  "page": 1,
  "first": 1,
  "last": 3,
  "hits": 3,
  "pageCount": 4,
  "Items": [
    {
      "Item": {
        "title": "遠い太鼓",
        "titleKana": "トオイタイコ",
        "subTitle": "",
        "seriesName": "",
        "author": "村上春樹",
        "authorKana": "ムラカミハルキ",
        "publisherName": "講談社",
        "language": "JA",
        "salesDate": "2015年11月27日",
        "itemNumber": "4310000025842",
        "koboGenreId": "101901",
        "itemCaption": "ある朝目が覚めて、ふと耳を澄ませると、何処か遠くから太鼓の音が聞こえてきた。その音を聞いているうちに、僕はどうしても長い旅に出たくなったのだーー。40歳になろうとしていた著者は、ある思いに駆られて日本を後にし、ギリシャ・イタリアへ長い旅に出る。『ノルウェイの森』と『ダンス・ダンス・ダンス』を書き上げ、作家としての転換期となった、三年間の異国生活のスケッチブック。",
        "itemPrice": 864,
        "itemUrl": "http://books.rakuten.co.jp/rk/2f6c629361643a4d99584d1bcb2c9689",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/9a/6a/2f6c629361643a4d99584d1bcb2c9689.png?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/9a/6a/2f6c629361643a4d99584d1bcb2c9689.png?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/9a/6a/2f6c629361643a4d99584d1bcb2c9689.png?_ex=200x200",
        "reviewCount": 0,
        "reviewAverage": "0.0",
        "salesType": 0
      }
    },
    {
      "Item": {
        "title": "やがて哀しき外国語",
        "titleKana": "ヤガテカナシキガイコクゴ",
        "subTitle": "",
        "seriesName": "",
        "author": "村上春樹",
        "authorKana": "ムラカミハルキ",
        "publisherName": "講談社",
        "language": "JA",
        "salesDate": "2015年11月27日",
        "itemNumber": "4310000025848",
        "koboGenreId": "101901",
        "itemCaption": "F・スコット・フィッツジェラルドの母校プリンストン大学に招かれ、アメリカでの暮らしが始まった。独自の大学村スノビズム、スティーブン・キング的アメリカ郊外事情、本場でジャズについて思うこと、フェミニズムをめぐる考察、海外で深く悩まされる床屋問題ーー。『国境の南、太陽の西』と『ねじまき鳥クロニクル』を執筆した二年あまりをつづった、十六通のプリンストン便り。",
        "itemPrice": 572,
        "itemUrl": "http://books.rakuten.co.jp/rk/ef6384b198243da89e93f75e2e7fc922",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/69/c0/ef6384b198243da89e93f75e2e7fc922.png?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/69/c0/ef6384b198243da89e93f75e2e7fc922.png?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/69/c0/ef6384b198243da89e93f75e2e7fc922.png?_ex=200x200",
        "reviewCount": 0,
        "reviewAverage": "0.0",
        "salesType": 0
      }
    },
    {
      "Item": {
        "title": "色彩を持たない多崎つくると、彼の巡礼の年",
        "titleKana": "シキサイヲモタナイタザキツクルトカレノジュンレイノトシ",
        "subTitle": "",
        "seriesName": "",
        "author": "村上春樹",
        "authorKana": "ムラカミハルキ",
        "publisherName": "文藝春秋",
        "language": "JA",
        "salesDate": "2015年12月04日",
        "itemNumber": "4390000002827",
        "koboGenreId": "101901",
        "itemCaption": "多崎つくる、鉄道の駅をつくるのが仕事。名古屋での高校時代、四人の男女の親友と完璧な調和を成す関係を結んでいたが、大学時代のある日突然、四人から絶縁を申し渡された。何の理由も告げられずにーー。死の淵を一時さ迷い、漂うように生きてきたつくるは、新しい年上の恋人・沙羅に促され、あの時なにが起きたのか探り始めるのだった。全米第一位にも輝いたベストセラー!",
        "itemPrice": 780,
        "itemUrl": "http://books.rakuten.co.jp/rk/2b18ee45fa603300a20fe00f50c37110",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/0b/d3/2b18ee45fa603300a20fe00f50c37110.png?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/0b/d3/2b18ee45fa603300a20fe00f50c37110.png?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_gold/rakutenkobo-ebooks/imghb/0b/d3/2b18ee45fa603300a20fe00f50c37110.png?_ex=200x200",
        "reviewCount": 2,
        "reviewAverage": "3.5",
        "salesType": 0
      }
    }
  ],
  "GenreInformation": []
}

Try It

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/Kobo/EbookSearch/20140811?applicationId=REPLACE_WITH_YOUR_APP_ID

Response