Skip to content
Scrappa Get API key
Comparably API 1 credit / request

Comparably Sitemap API Documentation

GET https://scrappa.co/api/comparably/sitemap

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.

Comparably Sitemap API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/comparably/sitemap
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "data": {
        "count": 1,
        "shards": [
            "https://www.comparably.com/_sitemaps/sm-1.xml"
        ]
    },
    "meta": {
        "billable": true
    },
    "success": true
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

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

Errors

Handle these documented responses before retrying or showing customer-facing failures.

Validation Error

A parameter is missing or invalid. No upstream call is made. Not billable.

Not Found

The requested company does not exist. Not billable.

Service Unavailable

The upstream source could not be read. Not billable.

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.