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

PriceRunner Sitemap API Documentation

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

GET /api/pricerunner/sitemap returns public sitemap URLs and the product ids found in them.

PriceRunner Sitemap API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/pricerunner/sitemap
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "ids": [],
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "urls": [],
    "success": true
}

Response Schema

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

Example response fields

Scan these fields before integrating.

ids meta urls success
JSON Response
200 OK
{
    "ids": [],
    "meta": {
        "attempts": 1,
        "billable": true
    },
    "urls": [],
    "success": true
}

Errors

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

422

Validation Error

One or more query parameters failed validation.

{
    "errors": {
        "q": [
            "The q field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

The public source is temporarily unavailable through every approved route.

{
    "meta": {
        "billable": false,
        "retryable": true
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "PriceRunner data is temporarily unavailable. Please retry."
    },
    "success": false
}

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.