# /eprel/products/stats

`POST /api/eprel/products/stats`

Price: 1 credit

Count the registered models of one EPREL product group by energy class, without pulling the models themselves. Returns one breakdown per energy-class scale the group's regulation defines — a few groups carry several, because separate scales apply to different appliance families within them — with the label, its official colour and the number of models in it, plus the matching total. Accepts the same energy class, supplier and group-specific filters as the product search, so the breakdown can be taken over any slice of the register.

## How to use it

Use this to size a slice of the register before pulling it, or to compare how one supplier's range sits against a whole product group. The counts are served from the registry's CDN cache and lag the live search total slightly, so treat a small discrepancy against eprel/products/search as normal rather than as a missing model. A group with more than one entry in `scales` is not a duplicate: each entry covers a different appliance family under the same regulation, so sum `model_count` across scales only when that is what you mean.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `product_group` (string, required) — Product group to summarise (one of: "airconditioners", "dishwashers", "dishwashers2019", "electronicdisplays", "hotwaterstoragetanks", "lamps", "lightsources", "localspaceheaters", "ovens", "professionalrefrigeratedstoragecabinets", "rangehoods", "refrigeratingappliances", "refrigeratingappliances2019", "refrigeratingappliancesdirectsalesfunction", "residentialventilationunits", "smartphonestablets20231669", "solidfuelboilerpackages", "solidfuelboilers", "spaceheaterpackages", "spaceheaters", "spaceheatersolardevice", "spaceheatertemperaturecontrol", "televisions", "tumbledriers", "tumbledryers20232534", "tyres", "washerdriers", "washerdriers2019", "washingmachines", "washingmachines2019", "waterheaterpackages", "waterheaters", "waterheatersolardevices"; examples: "refrigeratingappliances2019", "lightsources")
- `energy_class` (array, nullable) — Restrict the summary to these energy classes (examples: ["A","B"])
- `supplier` (string, nullable) — Restrict the summary to one supplier or trademark (examples: "Liebherr"; minLength: 1)
- `include_old_products` (boolean) — Include withdrawn and superseded registrations in the counts (default: false)
- `filters` (object, nullable) — Group-specific filters, keyed by the registry's own field name, exactly as eprel/products/search takes them. eprel/product_groups lists the keys each group publishes (examples: {"applianceType":"WINE_STORAGE"})
  - `*` (string)

## Response

### 200 — Successful Response

- `@type` (string) (default: "EprelEnergyClassStats")
- `product_group` (string, required)
- `model_count` (integer) (default: 0)
- `total_model_count` (integer) (default: 0)
- `model_count_with_old_products` (integer) (default: 0)
- `scales` (array) (default: [])
  - `@type` (string) (default: "EprelEnergyClassScale")
  - `scale` (string, nullable)
  - `metric` (string, nullable)
  - `model_count` (integer) (default: 0)
  - `classes` (array) (default: [])
    - `@type` (string) (default: "EprelEnergyClassCount")
    - `energy_class` (string, required)
    - `color` (string, nullable)
    - `model_count` (integer) (default: 0)

## Errors

### 422 — Validation Error

A filter key or energy-class letter the chosen product_group does not publish.

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.

