# Breuninger Ids API Documentation

`GET /api/breuninger/ids` returns public product ids from a sitemap child map. Pass `map` with a path or URL from `maps` for one lookup. Without `map`, the index and one child map are read to discover it, about 0.9 KB plus 3.76 MB; this is the one two-lookup discovery exception. Both bill one credit. `map` must stay under `/de/such/seo/sitemap/`. `source=brands` gives brand slugs for the `brand` search input.

## What you get

Each product item has `id` and `url`; the id is accepted unchanged by the product endpoint. The `maps` list gives the child maps of the index. A discovery request reads the index and one child map. An empty result costs nothing.

## Credits

A successful request costs **1 credit**. Errors, challenges and `404` answers cost nothing. The response shows the charge in `meta.credits_charged`.

- **Documentation:** [https://scrappa.co/docs/breuninger-api/breuninger_ids](https://scrappa.co/docs/breuninger-api/breuninger_ids)
- **API group:** Breuninger API
- **Endpoint:** `GET https://scrappa.co/api/breuninger/ids`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `source` | string | No | sitemap (default) or brands. |
| `map` | string | No | Optional child map URL from the maps field. |
| `limit` | integer | No | Maximum number of returned ids or brands, 1-200. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/breuninger/ids?source=sitemap&limit=20"
```

## Example response

```json
{
    "success": true,
    "source": "sitemap",
    "map": "https://www.breuninger.com/de/such/seo/sitemap/pdp_sitemap_de_de0.xml",
    "maps": [
        "https://www.breuninger.com/de/such/seo/sitemap/pdp_sitemap_de_de0.xml"
    ],
    "items": [
        {
            "id": "1003244478",
            "url": "https://www.breuninger.com/de/marken/riani/cocktailkleid/1003244478/p/"
        }
    ],
    "meta": {
        "endpoint_family": "breuninger-ids",
        "billable": true,
        "attempts": 2,
        "credits_charged": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter is missing, unknown, conflicting or unusable. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Breuninger could not be reached, answered with a challenge, or changed its page shape (`upstream_blocked`, `upstream_unavailable`, `parser_drift`). Retryable and never billed. Clients are never rate limited. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
