Skip to content
Scrappa Get API key
Yodobashi API 1 credit / request

Yodobashi Product Search API Documentation

GET https://scrappa.co/api/yodobashi/search?q=sony&page=1

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.

Yodobashi Product Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/yodobashi/search?q=sony&page=1
Auth header
x-api-key
Cost
1 credit / request
q = sony
Response preview
200 OK
{
    "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",
...

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.

6 optional filters available.

q string Required

Search words; word is accepted as an alias.

Example value sony
category string Optional

Full category id path from the categories endpoint, for example 141001/141651. A leaf id alone is rejected by the site.

Example value example
lower integer Optional

Lowest JPY price.

Example value 10
upper integer Optional

Highest JPY price.

Example value 10
brand string Optional

10-digit maker id; mkrbrnds is accepted as an alias.

Example value example
discontinued boolean Optional

Include discontinued items when true.

Example value true
page integer Optional

1-based page number. Page 1 is the site root.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yodobashi/search?q=sony&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/yodobashi/search?q=sony&page=1');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/yodobashi/search?q=sony&page=1', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/yodobashi/search?q=sony&page=1',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/yodobashi/search?q=sony&page=1")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/yodobashi/search?q=sony&page=1", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/yodobashi/search?q=sony&page=1', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/yodobashi/search?q=sony&page=1")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/yodobashi/search?q=sony&page=1", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/yodobashi/search?q=sony&page=1"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/yodobashi/search?q=sony&page=1"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/yodobashi/search?q=sony&page=1',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/yodobashi/search?q=sony&page=1")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

Not Found

The product, page or id does not exist on the site. This response is not billable.

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.

Service Unavailable

The service could not obtain a complete result. Failed requests are never billed.

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.