Where is a product cheapest
compare_pricesRead-onlyIdempotent
Find where a product is cheapest right now. Matches the same product at Aldi, Tesco, SuperValu and Dunnes Stores and returns each store's current price side by side, with unit prices, offers and Tesco Clubcard prices. Free: no BasketWatch account needed.
Args:
query: the product, e.g. "heinz ketchup" or "kerrygold butter 454g".
limit: how many matched products to return (default 5, max 20).
Returns {"as_of", "query", "matches": [{"product", "pack", "prices":
{store: {name, price, unit_price, unit_basis, offer_text, was_price,
clubcard_price, url}}, "cheapest_store"}]}. A store missing from "prices"
does not stock that product. One product per call.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | Price date, YYYY-MM-DD | |
| query | No | ||
| matches | No |