Rakuten Suggest API Documentation Get search suggestions from Rakuten Ichiba for the start of a keyword. Use it to find the Japanese spelling of products and brands before you call the search endpoint. Cost: 1 credit per request. An empty suggestion list and failed requests are not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
The start of a search, 1 to 80 characters, e.g. マス.
coffee shops
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "\u30de\u30b9",
"suggestions": [
{
"text": "\u30de\u30b9\u30af",
"type": "keyword"
},
{
"text": "\u30de\u30b9\u30ab\u30c3\u30c8",
"type": "keyword"
},
{
"text": "\u30de\u30b9\u30af \u4e0d\u7e54\u5e03",
"type": "keyword"
}
]
},
"meta": {
"credits": 1,
"billable": true,
"endpoint_family": "suggest"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query parameter is missing or invalid. This response is not billable.
{
"errors": {
"query": [
"Send the start of a search, e.g. query=\u30de\u30b9."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Rakuten did not answer after the internal retries. This response is not billable. Retry after a few seconds.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Rakuten is temporarily unavailable. Please retry. This request was not charged."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.