---
title: "Supermarket chains with their price index (cheapest first)"
method: GET
path: "/chains"
---

# Supermarket chains with their price index (cheapest first)

`GET /chains`

## Request

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

## Response `200`

Chains

- 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
    - `index_note` string
    - `methodology` string, uri
    - `chains` Chain[]
      - `chain_key` string
      - `chain_name` string
      - `stores` integer
      - `cities` integer
      - `price_index` number, nullable: 100 = national median; below 100 is cheaper
      - `effective_index` number, nullable: Same, after promotions open to everyone
      - `in_rankings` boolean: false when the chain's data is not comparable today (a partial price file, too narrow a range): do not rank it or call it the cheapest / dearest
      - `data_warning` string: Why in_rankings is false (Hebrew), present only then
      - `as_of` string, date, nullable
      - `url` string, uri

## Other responses

- `401`: API key missing, invalid or revoked. Free sign-up: https://wizbi.store/developers#register
- `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)