# momox Sitemap API Documentation

<p>Return product ids and urls from a public momox sitemap file. The default reads the sitemap index. Pass a file name from that index to read its product urls. This is a public id source for the product route. 1 credit per successful request. Failed requests are not billed.</p>

- **Documentation:** [https://scrappa.co/docs/momox-api/momox_sitemap](https://scrappa.co/docs/momox-api/momox_sitemap)
- **API group:** momox API
- **Endpoint:** `GET https://scrappa.co/api/momox/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 |
| --- | --- | --- | --- |
| `file` | string | No | Optional sitemap file name from the index |

## Example response

```json
{
    "data": {
        "file": "sitemap_index_deu.xml",
        "count": 0,
        "files": [
            "sitemap_product_deu1.xml"
        ],
        "products": []
    },
    "meta": {
        "billable": true,
        "endpoint_family": "sitemap"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | No sitemap exists for this file. Failed requests are not billed. |
| 503 | Upstream Unavailable | The source is temporarily unreachable. Failed requests are not billed. |

## 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)
