# Yodobashi Keyword Suggestions API Documentation

Returns the keyword suggestions Yodobashi shows while a buyer types, with the number of available matches. Suggestions are text prefixes, not ids; use the search or categories endpoints to resolve ids. Failed requests (404, 422, 503 and transport errors) are never billed. A valid answer with zero rows is a successful, billable 200. Each request makes one upstream lookup.

- **Documentation:** [https://scrappa.co/docs/yodobashi-api/yodobashi_suggest](https://scrappa.co/docs/yodobashi-api/yodobashi_suggest)
- **API group:** Yodobashi API
- **Endpoint:** `GET https://scrappa.co/api/yodobashi/suggest`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `q` | string | Yes | Text typed so far, Japanese or Latin. |
| `rows` | integer | No | Suggestions to return, 1 to 50. Defaults to 24. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/yodobashi/suggest?q=sony&rows=3"
```

## Example response

```json
{
    "success": true,
    "data": {
        "query": "sony",
        "available": 1351,
        "returned": 3,
        "suggestions": [
            "sony \u30d8\u30c3\u30c9\u30db\u30f3",
            "sony \u30ab\u30e1\u30e9",
            "sony \u30d0\u30c3\u30c6\u30ea\u30fc"
        ]
    },
    "meta": {
        "endpoint_family": "suggest",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The product, page or id does not exist on the site. This response is not billable. |
| 422 | Validation Error | A parameter is invalid: a SKU that is not 18 digits, a maker id that is not 10 digits, a price range or page out of range, or a sort parameter (price sort is not supported). This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. Failed requests are never billed. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
