# Rentals.ca Cities API Documentation

<p><strong>Rentals.ca Cities API</strong> lists the cities Rentals.ca covers, in alphabetical order, for one province or for all of Canada. Each city has a ready <code>location</code> value for the search route. Page with <code>page</code> and <code>per_page</code>. Failed requests are not billed.</p>

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

## 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 |
| --- | --- | --- | --- |
| `region` | string | No | Optional province or territory code such as ON. Without it, all of Canada is listed. |
| `page` | integer | No | One-based page number (default 1). |
| `per_page` | integer | No | Cities per page, 1 to 100 (default 20). |

## Example response

```json
{
    "data": {
        "page": 1,
        "cities": [
            {
                "url": "https://rentals.ca/acton",
                "name": "Acton",
                "path": "acton",
                "region": "ON",
                "location": "acton, on, ca"
            },
            {
                "url": "https://rentals.ca/adjala-tosorontio",
                "name": "Adjala-Tosorontio",
                "path": "adjala-tosorontio",
                "region": "ON",
                "location": "adjala-tosorontio, on, ca"
            },
            {
                "url": "https://rentals.ca/ajax",
                "name": "Ajax",
                "path": "ajax",
                "region": "ON",
                "location": "ajax, on, ca"
            }
        ],
        "region": "ON",
        "per_page": 3,
        "next_page": 2,
        "has_next_page": true
    },
    "meta": {
        "billable": true,
        "endpoint_family": "cities"
    },
    "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)