# basketwatchireland-com API

**Canonical:** https://apis.io/apis/basketwatchireland-com/basketwatchireland-com-api/  
**Provider:** basketwatchireland-com — https://apis.io/providers/basketwatchireland-com/  
**Documentation:** https://basketwatchireland.com/api-reference

basketwatchireland-com API is one of 2 APIs that [basketwatchireland-com](https://apis.io/providers/basketwatchireland-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

basketwatchireland-com API as documented publicly: 24 operations. Contract generated from the documentation by API Evangelist (2026-10-30); not the provider's own document.

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/aldi/specialbuys` | GET /api/aldi/specialbuys |
| GET | `/api/barcodes` | GET /api/barcodes |
| GET | `/api/changes` | daily price movements, with shelf moves, promotions and loyalty prices kept as separate signals |
| GET | `/api/compare` | GET /api/compare |
| GET | `/api/credits` | GET /api/credits shows the balance and ledger at no charge |
| GET | `/api/credits/mpp` | GET /api/credits/mpp |
| GET | `/api/credits/mpp/buy` | Answers 402 Payment Required with a WWW-Authenticate: Payment challenge naming the stripe method and charge intent. |
| POST | `/api/credits/mpp/buy` | POST /api/credits/mpp/buy |
| GET | `/api/product/{productId}` | A single product: current price, unit price, pack, plus its full price history |
| GET | `/api/products` | catalogue with current shelf price, unit price, pack size, promotion and barcode, and the retailer's own shelf every level down |
| GET | `/api/status` | coverage and freshness per retailer, free and unauthenticated |
| GET | `/api/tesco/out-of-stock` | GET /api/tesco/out-of-stock |
| GET | `/api/{store}/category-index` | Per-category average price over time, with the SKU count behind each point. |
| GET | `/api/{store}/category-summary` | Per-department roll-up: SKU count, average price and price churn, with the retailer browse URL. |
| GET | `/api/{store}/changes` | Day‑over‑day movements in price, promotions and loyalty changes |
| GET | `/api/{store}/kpis` | Headline numbers for the latest snapshot: catalogue size, active SKUs today vs yesterday, promotion share, out-of-stock count, average price, price moves and... |
| GET | `/api/{store}/new-products` | Newly listed SKUs first seen in the latest snapshot |
| GET | `/api/{store}/price-history` | Every price observation per SKU across a date range |
| GET | `/api/{store}/products` | Full catalogue with the current shelf price per SKU |
| GET | `/api/{store}/products/count` | Fast catalogue size for a store, without returning rows |
| GET | `/api/{store}/promotions` | Live deals: products on offer, with was-price, offer text and loyalty pricing (Clubcard / Real Rewards). |
| GET | `/api/{store}/removed` | Delisted SKUs absent from the latest snapshot (two-snapshot confirmed). |
| GET | `/api/{store}/shrinkflation` | Pack-size reductions: same product, smaller pack, with the old and new size and the change in price per kg, litre or item. |
| GET | `/api/{store}/volatile` | Most volatile SKUs: products whose price has changed most often over the tracked window. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/basketwatchireland-com/openapi/_ae-authored/basketwatchireland-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-compare-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-aldi-specialbuys-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-store-shrinkflation-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-store-products-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-store-promotions-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/basketwatchireland-com/json-schema/basketwatchireland-com-get-api-store-kpis-response-schema.json

## Other basketwatchireland-com APIs (1)

- [BasketWatch Irish Grocery Price API](https://apis.io/apis/basketwatchireland-com/basketwatch-irish-grocery-price-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/basketwatchireland-com/basketwatchireland-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/basketwatchireland-com/.