# Comparably Sitemap API Documentation

<p>List the public sitemap shard urls of Comparably. Use them as a slug source for the other endpoints. 1 credit per successful request. Failed tries are never billed. Company, salaries and reviews routes show their credit cost. No client rate limit.</p>

- **Documentation:** [https://scrappa.co/docs/comparably-api/comparably_sitemap](https://scrappa.co/docs/comparably-api/comparably_sitemap)
- **API group:** Comparably API
- **Endpoint:** `GET https://scrappa.co/api/comparably/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.

## Example response

```json
{
    "data": {
        "count": 1,
        "shards": [
            "https://www.comparably.com/_sitemaps/sm-1.xml"
        ]
    },
    "meta": {
        "billable": true
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing or invalid. No upstream call is made. Not billable. |
| 404 | Not Found | The requested company does not exist. Not billable. |
| 503 | Service Unavailable | The upstream source could not be read. Not billable. |

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