# PitchBook Sitemap API Documentation

<p><strong>PitchBook Sitemap API</strong> lists profile ids from the public PitchBook sitemaps. Each file holds up to 20,000 profiles. Use <code>family=index</code> to see how many files each family has. Page inside a file with <code>offset</code> and <code>limit</code>. The response echoes <code>file</code> and <code>offset</code> and gives <code>next_offset</code>. 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.</p>

- **Documentation:** [https://scrappa.co/docs/pitchbook-api/pitchbook_sitemap](https://scrappa.co/docs/pitchbook-api/pitchbook_sitemap)
- **API group:** PitchBook API
- **Endpoint:** `GET https://scrappa.co/api/pitchbook/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 |
| --- | --- | --- | --- |
| `family` | string | Yes | index, company, investor, fund, limited-partner or advisor. |
| `file` | integer | No | Sitemap file number, 1-based. Default 1. |
| `offset` | integer | No | Start position inside the file. Default 0. |
| `limit` | integer | No | Entries per page, 1 to 1000. Default 100. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The sitemap file does not exist. This response is not billable. |
| 422 | Invalid Page | The offset is past the end of the file. This response is not billable. |
| 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. |

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