BasketWatch

Args:
    query: product-name substring (e.g. "heinz baked beans 415g").
    limit_per_store: how many matches per store (default 5).

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.

Ingredient words. exclude_ingredients are ingredients a product is free
of; include_ingredients ones it contains. These words are expanded to the
label terms they cover: palm oil, nuts (includes peanuts), peanuts, gluten,
milk (dairy), eggs, soya, sesame, mustard, celery, fish, crustaceans,
molluscs, shellfish, sulphites, lupin, gelatine, alcohol, added sugar,
sweeteners, pork, meat, vegetarian (meat, fish, gelatine and other
animal-derived ingredients) and vegan (vegetarian plus milk, eggs, honey and
other animal products). Any other word is matched as written, e.g.
"coconut" or "oats".

With no store, results alternate across the stores (each store's best
match, then each store's next), and matched_by_store gives each store's
full count.

A product whose ingredient list or nutrition is not on record, or whose
ingredient list on record is incomplete, is left out, never assumed to
pass: left_out_unknown counts them, left_out_by_reason gives the reasons,
and caveats lists known gaps (Aldi's ingredient lists are often cut short,
so Aldi products are not offered as free from anything). Claims printed in
a product's NAME, such as "gluten free", "lactose free", "alcohol free" or
"vegan", are matched through query; exclude_ingredients also checks the
ingredients. Alcohol strength is recorded for most SuperValu and Dunnes
drinks but few at Tesco and Aldi; "alcohol free" and "0.0" in query match
drinks named that way.

Answers come from the ingredient lists and nutrition the retailers publish.
"Free from" means none of the listed ingredients names it; not every
"may contain" warning is covered. Results carry a note that this is information
only. Each product returned costs one credit.

Args:
    query: product words, e.g. "biscuits", "crisps", "dark chocolate".
        Needed unless category is given.
    store: aldi, tesco, supervalu or dunnes. Leave out to search all four.
    category: an aisle name to narrow by, e.g. "Breakfast Cereals".
    exclude_ingredients: ingredients a product has to be free of, e.g.
        ["palm oil"], ["nuts", "sesame"], ["vegan"].
    include_ingredients: e.g. ["oats"].
    max_sugar_g, max_salt_g, max_fat_g, max_carbs_g, min_protein_g:
        grams per 100g or 100ml, e.g. max_sugar_g=5.
    max_kcal: kilocalories per 100g or 100ml.
    max_abv, min_abv: alcohol by volume, percent.
    max_ingredients: at most this many listed ingredients, e.g. 5. A
        compound ingredient's own bracketed list counts as one.
    on_offer: only products on promotion or with a Clubcard price.
    sort_by: price, unit_price (per kg or litre), sugar, salt, fat, carbs,
        protein, kcal, abv or ingredients (fewest first). Products that
        are the kind of thing searched for rank ahead of name-only matches
        (name_match_only), so "chocolate" sorted by price does not lead
        with chocolate-flavour popcorn.
    descending: true for highest first, e.g. most protein.
    limit: most products to return (default 10, max 50).

Takes product ids (store-prefixed, as returned in product results) or a
query; with a query, the closest matching products are looked up first. A
range returns one row per product per day, and each row costs one credit;
with from_date equal to to_date, one day's price is returned.

Args:
    product_ids: e.g. ["tesco:300793546", "dunnes:100873410"]; each id's
        store is taken from the id.
    query: product name words, used when no product_ids are given.
    store: aldi, tesco, supervalu or dunnes, to narrow a query. Leave it
        out to look in all four.
    from_date: first day, YYYY-MM-DD. Defaults to 30 days before to_date.
    to_date: last day, YYYY-MM-DD. Defaults to today.
    limit: most rows to return in total (default 60).

Returns one row per product per day: id, name, store, scrape_date, price,
unit_price, unit_basis, clubcard_price, offer_text, was_price.

Products are looked up by product id (store-prefixed, as returned in
product results), by the retailer's own item numbers (skus with store, as
printed on its receipts), or by name (query). ingredients_incomplete marks
an ingredient list on record that is cut short, which cannot show that an
ingredient is absent. Results carry a note that nutrition and ingredients
are for information only. Each product returned costs one credit.

Args:
    query: product name words, e.g. "kellogg's corn flakes".
    product_ids: e.g. ["tesco:300793546", "dunnes:100873410"], up to 50.
    skus: the store's own item numbers, e.g. ["100873410"], up to 50;
        needs store. An Aldi article number can return several variants.
    store: aldi, tesco, supervalu or dunnes: required with skus, narrows a
        query; leave out for all four.
    limit: most products to return for a query (default 5, max 50).

Returns offer label (e.g. "3 for €5", "SAVE €0.75"), was-price,
validity window, and where applicable Tesco Clubcard prices,
SuperValu Real Rewards prices or Dunnes member offers.

Args:
    store: one of "tesco", "supervalu", "dunnes". (Aldi doesn't
        publish multibuy promos so isn't supported here.)
    limit: how many promotional rows to return (default 25).

Args:
    store: "aldi" | "tesco" | "supervalu" | "dunnes".
    limit: page size (default 100, max 200).
    offset: pagination offset.

Codes are accepted exactly as printed: leading zeros, spaces and hyphens
are ignored. Needs a signed-in BasketWatch account.

Args:
    codes: one barcode, or up to 100 separated by commas
        (e.g. "5000127014084" or "5000127014084,5000157024671").
    store: optionally restrict to one of "aldi", "tesco", "supervalu",
        "dunnes".
    include_copy: also return ingredients and per-100g nutrition where
        the retailer publishes them.

Returns {"products": [...], "not_found": [...], "invalid": [...]}. Each
product row carries store, matched_barcodes, name, brand, pack_size,
price and its full barcodes list. One credit per barcode found, however
many retailers stock it; codes with no match cost nothing.

Args:
    store: "aldi" | "tesco" | "supervalu" | "dunnes".
    days_back: how many days back to look (default 7 = since last scrape).
    limit: how many new products to return.

Each line takes name (plain words with brand and size, e.g. "avonmore fresh
milk 2l"; receipt abbreviations such as "AVNMR FRSH MLK 2L" match poorly)
and optionally sku (the retailer's item number as printed on its receipts;
the name is used when the number is not found), barcode, store, quantity,
and paid (the line total, which gives the saving against what was paid).
Irish product names say "low fat milk" for what the UK calls "semi
skimmed". Bags, deposits, discounts and totals are not products.

Returns, per line, the match and matched_by (sku, barcode or name), the
cheapest store and price, a cheaper alternative with its pack size and, for
a receipt, price_at_store_bought; then each store's total with its
items_missing, cheapest_complete_store, mix_and_match_total and not_found.
Prices are each retailer's online shelf price from the overnight
collection; in-store prices can differ. Tesco Clubcard prices are reported
separately. Each matched item costs one credit; items not found are free.

Args:
    items: e.g. [{"sku": "100685955", "name": "dunnes baked beans",
        "quantity": 2, "paid": 1.30}, {"name": "brennans wholemeal bread"}].
    store: the receipt's supermarket (aldi, tesco, supervalu or dunnes),
        used for any line that does not name its own.

change_pct is the change in what the basket cost (promotions included);
shelf_change_pct is regular prices only, so the gap between the two is
promotions starting or ending, not price rises. biggest_rises and
biggest_falls list the lines that moved most; pack_changed marks a product
whose pack size changed, confirmed over three days of records (a smaller
pack at the same price is a hidden rise). Lines in not_compared were not
found, or not sold on one of the dates.

Each product compared costs one credit.

Args:
    items: e.g. [{"sku": "100858349", "quantity": 2}, {"name": "brennans wholemeal bread"}].
    from_date: the earlier date, YYYY-MM-DD, e.g. "2026-08-06".
    to_date: the later date, YYYY-MM-DD; defaults to today.
    store: the receipt's supermarket (aldi, tesco, supervalu or dunnes).

shelf_rise and shelf_fall are changes to the regular price;
promotion_started and promotion_ended are changes in what was paid while
the regular price stayed the same (a product at 18 euro on promotion and 23
euro after is a promotion ending, not a 27.8% price rise); loyalty_change
is a Clubcard price moving; pack_change is the same product in a different
pack size, confirmed over three days of records (a smaller pack at the same
price is a hidden rise). on_promotion_both_dates marks a shelf change in
the label's "was" price while the offer price paid did not move.

Each mover returned costs one credit; the summaries are free.

Args:
    from_date: the earlier date, YYYY-MM-DD (prices recorded since May 2026).
    to_date: the later date, YYYY-MM-DD; defaults to today.
    group: a kind of product: beer, cider, wine, spirits, alcohol, or any
        product type such as breakfast cereal, butter, coffee, crisps,
        nappies. Narrower words work too ("vodka", "red wine").
    query: product or brand words, with or without group
        (e.g. "guinness").
    category: an aisle name to narrow by.
    store: aldi, tesco, supervalu or dunnes; leave out for all four.
    kinds: which lists to return (default all six).
    rank_by: "pct" (default) or "eur".
    limit: most products per list (default 10, max 50).

Args:
    store: "aldi" | "tesco" | "supervalu" | "dunnes".
    limit: how many movers to return (default 25).

Args:
    store: "aldi" | "tesco" | "supervalu" | "dunnes".
    days_back: how many days back to consider (default 7).
    limit: how many removed products to return.

Args:
    query: words to match in product names, case-insensitive
        (e.g. "heinz baked beans", "kerrygold butter", "pringles").
    store: optionally filter to one of "aldi", "tesco", "supervalu",
        "dunnes". Leave it out to search all four.
    limit: how many results to return in total (default 10).

Returns the matching product rows: store, SKU id, name, brand, price,
unit_price (€/kg or €/L), pack_size, category_path, url. Matches on the
name only: no ingredient, nutrition or offer filters, and no price sorting.