/idealo/products/search

POST /api/idealo/products/search

Price: 20 credits

Search Idealo for products on a chosen national Idealo site and get back product cards with the Idealo product id, name, the specification summary shown in the listing, product page URL and image, the lowest offer price with its currency, the price per reference unit where the product is sold by weight or volume, how many shops offer it, the average user star rating with its review count, the aggregated expert test grade where Idealo has one, and any listing badge such as bestseller.

How to use it

This is the only way into Idealo without already holding a product id: every row carries `id`, which `idealo/products`, `/offers`, `/reviews` and `/price-history` all take. Write the query in the language of the `country` site. A query in another language still matches, but on some sites it returns a fraction of the rows and does not resolve onto a category, so it will not paginate deep. How deep a query goes is decided upstream, not by `count`: a query that names one product category (`kaffeevollautomat`) lands on that category and pages through it, so several hundred results are reachable, while a query that spans categories (`espresso`) returns one page of about 60 and stops there whatever `count` says. Narrow to a category-shaped query when you need depth. `price` is the cheapest single offer, not the total with shipping — use `idealo/products/offers` for per-shop totals. Do not read `test_score` as a rating: it is a German school grade where 1 is best and 6 is worst, and it moves the opposite way to `rating`. A short list normally means the query ran out of results; it means the opposite when the response carries the `X-Results-Truncated` header, which says the source stopped answering part-way and the missing rows exist — repeat the call to get them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Free-text product search, in the language of the chosen national Idealo site (examples: "kaffeevollautomat", "nike air max 90", "iphone 17 pro 256gb"; minLength: 1)
• country string — National Idealo site to search. Each site has its own catalogue, prices, currency and language, so the query has to be written in that site's language (default: "de"; one of: "de", "at", "gb", "fr", "it", "es")
• count integer required — Max number of products to return (examples: 36, 100; min: 1; max: 720)

Response

• @type string (default: "IdealoSearchProduct")
• id string required
• country string required
• currency string required
• name string nullable
• url string nullable
• description string nullable
• image string nullable
• price number nullable
• base_price number nullable
• base_price_unit string nullable
• offer_count integer nullable
• rating number nullable — Average user rating on a 1-5 star scale, rounded to the nearest half star
• review_count integer nullable
• test_score number nullable — Average expert test grade on the German school scale, where 1.0 is best and 6.0 is worst. Present only where idealo has aggregated published product tests, which is mostly on category pages
• badges array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The query matched no products on this national Idealo site Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.