# /home24/products/category

`POST /api/home24/products/category`

Price: 10 credits

List the products of a home24 Netherlands category with sort, price, sale, colour, material, brand, seller, width, height, depth and diameter filters plus any other store filter: product cards with price, discount and coupon price, seller, rating, delivery time and overall dimensions

## How to use it

Prices are in EUR and dimensions in cm. Filter values take the store's value names or keys, such as Grijs or gray; an unknown filter or value answers 422 listing the available ones. Full dimensions, delivery dates and specifications are on home24/products.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of products to return (min: 1; max: 9500)
- `sort` (string) — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "discount", "newest", "rating")
- `price_min` (number, nullable) — Minimum price in EUR (min: 0)
- `price_max` (number, nullable) — Maximum price in EUR (min: 0)
- `on_sale` (boolean) — Keep only discounted products (default: false)
- `colors` (array, nullable) — Colours to keep (examples: ["gray","Beige"])
- `materials` (array, nullable) — Materials to keep (examples: ["solidwood","Textiel"])
- `brands` (array, nullable) — Brands to keep (examples: ["Fredriks"])
- `sellers` (array, nullable) — Sellers to keep (examples: ["home24 SE"])
- `width_min` (number, nullable) — Minimum width in cm (min: 0)
- `width_max` (number, nullable) — Maximum width in cm (min: 0)
- `height_min` (number, nullable) — Minimum height in cm (min: 0)
- `height_max` (number, nullable) — Maximum height in cm (min: 0)
- `depth_min` (number, nullable) — Minimum depth in cm (min: 0)
- `depth_max` (number, nullable) — Maximum depth in cm (min: 0)
- `diameter_min` (number, nullable) — Minimum diameter in cm (min: 0)
- `diameter_max` (number, nullable) — Maximum diameter in cm (min: 0)
- `filters` (object, nullable) — Other store filters by filter name and values (examples: {"Levertijd":["Tot 2 weken"],"Stijl":["Scandi"]})
  - `*` (array)
- `category` (string, required) — home24 category id or category URL (examples: "156318", "https://www.home24.nl/alle-banken/")

## Response

### 200 — Successful Response

- `@type` (string) (default: "Home24ListedProduct")
- `id` (string, required)
- `parent_sku` (string, nullable)
- `name` (string, nullable)
- `variant_name` (string, nullable)
- `url` (string, nullable)
- `brand` (string, nullable)
- `image` (string, nullable)
- `is_sellable` (boolean, nullable)
- `currency` (string, nullable)
- `price` (number, nullable)
- `original_price` (number, nullable)
- `discount_amount` (number, nullable)
- `discount_percent` (number, nullable)
- `is_rrp` (boolean, nullable)
- `rrp` (number, nullable)
- `rrp_saving` (number, nullable)
- `unit_price` (number, nullable)
- `unit_price_quantity` (number, nullable)
- `unit_price_unit` (string, nullable)
- `delivery_charge` (number, nullable)
- `delivery_charge_threshold` (number, nullable)
- `is_delivery_charge_applicable` (boolean, nullable)
- `lowest_variant_price` (number, nullable)
- `coupons` (array) (default: [])
  - `@type` (string) (default: "Home24Coupon")
  - `name` (string, nullable)
  - `code` (string, nullable)
  - `kind` (string, nullable)
  - `price_after_discount` (number, nullable)
  - `discount_percent` (number, nullable)
  - `ends_at` (integer, nullable)
  - `is_home_club_only` (boolean, nullable)
- `rating` (number, nullable)
- `rating_count` (integer, nullable)
- `wishlist_count` (integer, nullable)
- `wishlist_count_all_variants` (integer, nullable)
- `stock_quantity` (integer, nullable)
- `is_fast_delivery` (boolean, nullable)
- `delivery_days` (integer, nullable)
- `is_sold_by_home24` (boolean, nullable)
- `seller_id` (string, nullable)
- `seller_name` (string, nullable)
- `is_sponsored` (boolean) (default: false)
- `sponsor_name` (string, nullable)
- `labels` (array) (default: [])
  - `@type` (string) (default: "Home24Label")
  - `kind` (string, required)
  - `text` (string, required)
- `energy_class` (object, nullable)
  - `@type` (string) (default: "Home24EnergyClass")
  - `efficiency_class` (string, required)
  - `product_group` (string, nullable)
  - `scale` (string, nullable)
  - `label_urls` (array) (default: [])
- `categories` (array) (default: [])
  - `@type` (string) (default: "Home24Category")
  - `name` (string, required)
  - `url` (string, nullable)
- `variant_count` (integer, nullable)
- `dimensions` (object, nullable)
  - `@type` (string) (default: "Home24Dimensions")
  - `primary` (array) (default: [])
    - `@type` (string) (default: "Home24Dimension")
    - `name` (string, required)
    - `value` (number, nullable)
    - `value_text` (string, nullable)
    - `unit` (string, nullable)
  - `secondary` (array) (default: [])
    - `@type` (string) (default: "Home24Dimension")
    - `name` (string, required)
    - `value` (number, nullable)
    - `value_text` (string, nullable)
    - `unit` (string, nullable)
  - `weight` (array) (default: [])
    - `@type` (string) (default: "Home24Dimension")
    - `name` (string, required)
    - `value` (number, nullable)
    - `value_text` (string, nullable)
    - `unit` (string, nullable)

## Errors

### 422 — Validation Error

Unknown filter or filter value

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

No home24 category under that id or URL

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.