# Hagebau Sitemap API Documentation

`GET /api/hagebau/sitemap` returns the family index. Add `index` to read one product shard with `anP` ids, URLs and full-size image URLs. Use the ids unchanged with the product and reviews endpoints.

## Credits

A successful request costs **1 credit**. Errors and missing products cost nothing. The response shows the charge in `meta.credits_charged`.

- **Documentation:** [https://scrappa.co/docs/hagebau-api/hagebau_sitemap](https://scrappa.co/docs/hagebau-api/hagebau_sitemap)
- **API group:** Hagebau API
- **Endpoint:** `GET https://scrappa.co/api/hagebau/sitemap`

## 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 |
| --- | --- | --- | --- |
| `index` | integer | No | Product sitemap shard number. Omit for the family index. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/hagebau/sitemap?index=1"
```

## Example response

```json
{
    "success": true,
    "site": "de",
    "index": null,
    "families": [
        {
            "url": "https://www.hagebau.de/sitemap/product/"
        }
    ],
    "products": [],
    "meta": {
        "endpoint_family": "hagebau-sitemap",
        "billable": true,
        "credits_charged": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing, unknown or malformed. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | The upstream could not be reached or changed its embedded page shape. 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)
