# Yodobashi Product Search API Documentation

Returns the public Yodobashi result page for a keyword or category: up to 48 unique cards per page with 18-digit SKU, product url, brand, name, JPY price and price text, points, image, release date, availability and the breadcrumb of that product. Points are the gold-point number from each card text, not the reward rate. Filter by price range, 10-digit maker id and discontinued items, and page with the page parameter. Search cards do not carry ratings, review counts or a discount; read those from the variants endpoint. Send the full category id path from the categories endpoint: a leaf id alone returns 404 on the site. Use suggest or categories to find 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_search](https://scrappa.co/docs/yodobashi-api/yodobashi_search)
- **API group:** Yodobashi API
- **Endpoint:** `GET https://scrappa.co/api/yodobashi/search`

## 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 | Search words; word is accepted as an alias. |
| `category` | string | No | Full category id path from the categories endpoint, for example 141001/141651. A leaf id alone is rejected by the site. |
| `lower` | integer | No | Lowest JPY price. |
| `upper` | integer | No | Highest JPY price. |
| `brand` | string | No | 10-digit maker id; mkrbrnds is accepted as an alias. |
| `discontinued` | boolean | No | Include discontinued items when true. |
| `page` | integer | No | 1-based page number. Page 1 is the site root. |

## Example request

```bash
#!/bin/bash

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

## Example response

```json
{
    "success": true,
    "data": {
        "query": "sony",
        "page": 1,
        "products": [
            {
                "sku": "100000001009096616",
                "url": "https://www.yodobashi.com/product/100000001009096616/",
                "name": "WH-1000XM5 Wireless Headphones",
                "brand": "SONY",
                "price": 59400,
                "points": 5940,
                "image": "https://image.yodobashi.com/product/100/000001/009096616.jpg",
                "breadcrumb": [
                    "\u30db\u30fc\u30e0",
                    "\u30aa\u30fc\u30c7\u30a3\u30aa"
                ]
            }
        ],
        "count": 48
    },
    "meta": {
        "endpoint_family": "search",
        "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)
