# Rentals.ca Neighbourhoods API Documentation

<p><strong>Rentals.ca Neighbourhoods API</strong> lists the neighbourhoods of a city with their paths. Neighbourhood search is not supported by the search route, so use this list for navigation and mapping only. Failed requests are not billed.</p>

- **Documentation:** [https://scrappa.co/docs/rentals-ca-api/rentals_ca_neighbourhoods](https://scrappa.co/docs/rentals-ca-api/rentals_ca_neighbourhoods)
- **API group:** Rentals.ca API
- **Endpoint:** `GET https://scrappa.co/api/rentals-ca/neighbourhoods`

## 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 |
| --- | --- | --- | --- |
| `city` | string | Yes | City name. Example: Toronto. |
| `region` | string | Yes | Province or territory code. Example: ON. |
| `page` | integer | No | One-based page number (default 1). |
| `per_page` | integer | No | Neighbourhoods per page, 1 to 100 (default 20). |

## Example response

```json
{
    "data": {
        "page": 1,
        "region": "ON",
        "per_page": 3,
        "next_page": 2,
        "has_next_page": true,
        "neighbourhoods": [
            {
                "url": "https://rentals.ca/toronto/alexandra-park",
                "name": "Alexandra Park",
                "path": "toronto/alexandra-park",
                "region": "ON"
            },
            {
                "url": "https://rentals.ca/toronto/allenby",
                "name": "Allenby",
                "path": "toronto/allenby",
                "region": "ON"
            },
            {
                "url": "https://rentals.ca/toronto/annex",
                "name": "Annex",
                "path": "toronto/annex",
                "region": "ON"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "neighbourhoods"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter, a range or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | Rentals.ca could not be reached or returned data that does not match the request. 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)