Shelf-price index over several weeks
get_index_seriesReturns the UK or Australian online shelf-price index over time, oldest week first, up to 26 weeks: level, week-on-week and four-week change, matched counts. Headline rows unless recordType says otherwise: retailer and class narrow other kinds, e.g. recordType class. Posted online shelf prices, not prices paid; not a CPI. Levels are not price levels and do not show which retailer is cheaper. list_index_vintages gives the weeks held. Product-level rows are not served: see about_the_data.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"market": "<market>"
},
"name": "get_index_series"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| class | No | Only rows for this product class id, e.g. "dairy-eggs"; needs a recordType that has class rows, e.g. "class". | |
| market | Yes | uk or au. Example: "uk". | |
| retailer | No | Only rows for this retailer id, e.g. "tesco" (UK) or "aldi_au" (AU); needs a recordType that has retailer rows, e.g. "retailer". | |
| toVintage | No | Last ISO week, e.g. "2026-W45". Omit for the latest published week. | |
| recordType | No | Kind of row, e.g. "class". Omit for "headline". | |
| fromVintage | No | First ISO week, e.g. "2026-W42". Omit for up to 26 weeks ending at toVintage. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asOf | Yes | ||
| base | Yes | ||
| notes | Yes | ||
| title | No | ||
| credit | Yes | ||
| market | Yes | ||
| notCpi | Yes | ||
| series | Yes | ||
| toVintage | No | ||
| weeksHeld | Yes | ||
| recordType | Yes | ||
| fromVintage | No |