Price a shopping list in every branch of a city — the 5 cheapest branches with coverage

Items are free-text Hebrew product names (optionally with a quantity: "2 חלב 3%", "במבה x3") or barcodes, up to 40. Each is matched to one product (returned in items[].matched). Branches carrying at least 85% of the matched items are ranked by effective_total; the rest follow by coverage. Each branch has effective_total (= total), shelf_total and club_total. Also limited to 30 baskets/hour per IP.

post/basket

Request

  • Base URL: https://wizbi.store/api/v1
  • URL: https://wizbi.store/api/v1/basket
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • API key in query parameter key

Request body

itemsstring[] required
citystring required

City in Hebrew or English, or its slug

Response

Cheapest branches

as_ofstring date nullable required

Date of the latest price files in the dataset.

sourcestring required
source_enstring
pagestring uri nullable

The human page that shows the same numbers — link it when quoting (also attribution.link).

price_fieldsstring

What shelf / effective / club mean.

Example response

{
  "source": "WizStore (wizbi.store) — על בסיס קובצי המחירים והמבצעים שרשתות השיווק מחויבות לפרסם לפי חוק קידום התחרות בענף המזון",
  "source_en": "WizStore (wizbi.store) — based on the price and promotion files Israeli retail chains are required to publish under the Promotion of Competition in the Food Sector Law, 2014",
  "price_fields": "Prices are in ILS. shelf — the regular price the chain publishes for the store, without any promotion. effective — the lower of the shelf price and a promotion open to every shopper, per unit (\"3 for 30\" = 10 per unit). This is the price the site compares by default. club — a promotion limited to the chain's loyalty-club members or card holders. Never folded into effective; shown separately. Field names: *_shelf = shelf, *_effective = effective, *club* = club. Prices are as published by the chains; the price at the register may differ."
}

Changes

No recorded changes to this operation across all 1 revision of this API.