---
title: "Today's strongest deals (≥10% below the national median shelf price), nationally or for one chain"
method: GET
path: "/deals"
---

# Today's strongest deals (≥10% below the national median shelf price), nationally or for one chain

`GET /deals`

## Request

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

## Query parameters

- `chain` string
- `limit` integer

## Response `200`

Deals

- object
  - `as_of` string, date, nullable, required: Date of the latest price files in the dataset.
  - `source` string, required
  - `source_en` string
  - `page` string, uri, nullable: The human page that shows the same numbers — link it when quoting (also attribution.link).
  - `price_fields` string: What shelf / effective / club mean.
  - `coverage` object, nullable: What the dataset covers on as_of: chains, stores and barcoded products (the same counts as the site).
    - `chains` integer
    - `stores` integer
    - `products` integer
  - `attribution` Attribution, required
    - `required` boolean
    - `text` string
    - `text_en` string
    - `link` string, uri
    - `rule` string
    - `terms` string, uri
  - `data` object, required
    - `url` string, uri
    - `rule` string
    - `count` integer
    - `deals` Deal[]
      - `code` string
      - `name` string
      - `chain_key` string
      - `chain_name` string
      - `deal_price` number: ILS per unit
      - `chain_shelf` number, nullable: ILS. shelf — the regular price the chain publishes for the store, without any promotion.
      - `national_median_shelf` number, nullable
      - `pct_below_median` number, nullable
      - `club_only` boolean: ILS. club — a promotion limited to the chain's loyalty-club members or card holders. Never folded into effective; shown separately.
      - `description` string, nullable
      - `ends_on` string, date, nullable
      - `url` string, uri

## Other responses

- `401`: API key missing, invalid or revoked. Free sign-up: https://wizbi.store/developers#register
- `404`: Error
- `429`: Limit reached (1000/day or 60/minute per key). See Retry-After.

---

[API](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in.md) · [All operations](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in/llms.txt) · [OpenAPI document](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in/revisions/f59f5e5e44a4?raw)
