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

PitchBook Sitemap API Documentation

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

PitchBook Sitemap API lists profile ids from the public PitchBook sitemaps. Each file holds up to 20,000 profiles. Use family=index to see how many files each family has. Page inside a file with offset and limit. The response echoes file and offset and gives next_offset. The sitemaps list ids, URLs and last-modified dates only. PitchBook profile pages are not served by this API. An offset past the end of a file returns 422. A file that does not exist returns 404. Neither is charged.

PitchBook Sitemap API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/pitchbook/sitemap
Auth header
x-api-key
Cost
1 credit/request
family = example
Response preview
200 OK
{
    "data": {
        "file": 1,
        "items": [
            {
                "id": "101608-57",
                "url": "https://pitchbook.com/profiles/company/101608-57",
                "lastmod": "2018-04-17T02:20:29.160+00:00"
            },
            {
                "id": "101610-10",
                "url": "https://pitchbook.com/profiles/company/101610-10",
                "lastmod": "2018-04-17T02:20:29.160+00:00"
            }
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

3 optional filters available.

family string Required

index, company, investor, fund, limited-partner or advisor.

Example value example
file integer Optional

Sitemap file number, 1-based. Default 1.

Example value 10
offset integer Optional

Start position inside the file. Default 0.

Example value 10
limit integer Optional

Entries per page, 1 to 1000. Default 100.

Example value 10

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": {
        "file": 1,
        "items": [
            {
                "id": "101608-57",
                "url": "https://pitchbook.com/profiles/company/101608-57",
                "lastmod": "2018-04-17T02:20:29.160+00:00"
            },
            {
                "id": "101610-10",
                "url": "https://pitchbook.com/profiles/company/101610-10",
                "lastmod": "2018-04-17T02:20:29.160+00:00"
            }
        ],
        "limit": 2,
        "family": "company",
        "offset": 0,
        "next_offset": 2,
        "total_in_file": 20000
    },
    "meta": {
        "billable": true,
        "endpoint_family": "sitemap"
    },
    "success": true
}

Errors

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

404

Not Found

The sitemap file does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "sitemap"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
422

Invalid Page

The offset is past the end of the file. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "sitemap"
    },
    "error": {
        "code": "INVALID_PAGE",
        "message": "This result page does not exist. Use a lower offset."
    },
    "success": false
}
503

Upstream Unavailable

PitchBook could not be reached or returned a file that does not match the expected layout. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "sitemap"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "PitchBook could not be reached. Please retry shortly."
    },
    "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.