Skip to content
Scrappa Get API key
Rentals.ca API 1 credit/request

Rentals.ca Listing API Documentation

GET https://scrappa.co/api/rentals-ca/listing

Rentals.ca Listing API returns one listing: the description, floor plans with beds, baths, rent, size, availability, photos and tours, amenities, building facts, open houses, promotions, all photos in three sizes, coordinates, the management company and the contact name. Send one of path, url or id from a search item. Agent email and phone are never returned. Placeholder rents are null. A path that is not a rental listing returns 404. Failed requests are not billed.

Rentals.ca Listing API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/rentals-ca/listing
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "id": "cmVudGFsbGlzdGluZzozNzIyMzU=",
        "url": "https://rentals.ca/toronto/730-st-clarens-avenue-1",
        "beds": {
            "max": 2,
            "min": 0
        },
        "name": "730 St. Clarens",
        "path": "toronto/730-st-clarens-avenue-1",
        "pets": [
            "all"
        ],
        "rent": {
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

3 optional filters available.

path string Optional

Listing path from a search item, for example toronto/225-adelaide-st-west.

Example value example
url string Optional
Open example

Full rentals.ca listing URL. Use it instead of path.

Example value https://example.com/product
id string Optional

Listing id from a search item. Use it instead of path.

Example value 1234567890

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": {
        "id": "cmVudGFsbGlzdGluZzozNzIyMzU=",
        "url": "https://rentals.ca/toronto/730-st-clarens-avenue-1",
        "beds": {
            "max": 2,
            "min": 0
        },
        "name": "730 St. Clarens",
        "path": "toronto/730-st-clarens-avenue-1",
        "pets": [
            "all"
        ],
        "rent": {
            "max": 2375,
            "min": 1350
        },
        "size": {
            "max": 640,
            "min": 230
        },
        "tags": [
            {
                "key": "air_conditioner",
                "group": "appliance"
            },
            {
                "key": "clothes_dryer",
                "group": "appliance"
            },
            {
                "key": "clothes_washer",
                "group": "appliance"
            }
        ],
        "type": "apartment",
        "baths": {
            "max": 1,
            "min": 1
        },
        "tours": [],
        "images": [
            {
                "large": "https://images.rentals.ca/property-pictures/large/toronto-on/372235/apartment-2240761769.jpg",
                "small": "https://images.rentals.ca/property-pictures/small/toronto-on/372235/apartment-2240761769.jpg",
                "medium": "https://images.rentals.ca/property-pictures/medium/toronto-on/372235/apartment-2240761769.jpg",
                "caption": "kitchen"
            }
        ],
        "address": {
            "city": "Toronto",
            "region": "ON",
            "street": "730 St Clarens Avenue",
            "city_path": "toronto",
            "postal_code": "M6H 4E8",
            "neighbourhood": null,
            "address_hidden": false,
            "neighbourhood_path": null
        },
        "created": "2020-09-09T20:51:41+00:00",
        "summary": "730 St Clarens Avenue is an apartment for rent in Toronto, ON.  It has 6 units.  Units have 0 to 2 bedrooms.  Units have 1 bathroom.  Heating and water are utilities included in the rent price.",
        "tagline": null,
        "building": {
            "size": null,
            "class": null,
            "stories": null,
            "certified": null,
            "year_built": null,
            "total_units": null,
            "year_renovated": null
        },
        "latitude": 43.667254,
        "modified": "2026-10-23T17:47:39+00:00",
        "verified": true,
        "amenities": [
            {
                "key": "cable-ready",
                "group": "unit-features"
            },
            {
                "key": "parks",
                "group": "nearby"
            },
            {
                "key": "secured-access",
                "group": "building-features"
            }
        ],
        "furnished": "no",
        "longitude": -79.445707,
        "categories": [],
        "lease_term": "one_year",
        "promotions": [
            {
                "title": "Move-in specials",
                "details": "- one month free rent",
                "category": "other",
                "end_date": null,
                "start_date": "2020-10-15",
                "months_free": null,
                "discount_type": null,
                "discount_value": null,
                "lease_length_months": null
            }
        ],
        "term_types": [],
        "description": "renovated studio- 1 bathroom- located on floor 10- approximately 230 square feet- available now for $1375- water, heating included in rentrenovated one bedroom ...",
        "floor_plans": [
            {
                "id": "Zmxvb3JwbGFuOjM3MjIzNTozNTA4MDE1MDg=",
                "beds": 0,
                "dens": null,
                "rent": 1450,
                "size": 230,
                "baths": 1,
                "tours": [],
                "images": [
                    {
                        "large": "https://images.rentals.ca/property-pictures/large/toronto-on/372235/apartment-2239925904.jpg",
                        "small": "https://images.rentals.ca/property-pictures/small/toronto-on/372235/apartment-2239925904.jpg",
                        "medium": "https://images.rentals.ca/property-pictures/medium/toronto-on/372235/apartment-2239925904.jpg",
                        "caption": "kitchen"
                    }
                ],
                "furnished": "no",
                "description": null,
                "external_id": "682930",
                "unit_number": null,
                "available_now": true,
                "parking_spots": 0,
                "available_from": null
            }
        ],
        "open_houses": [],
        "contact_name": "Test Agent",
        "images_count": 45,
        "listing_type": "residential:apartment:apartment",
        "parking_spots": null,
        "management_company": {
            "id": "bWFuYWdlbWVudGNvbXBhbnk6MQ==",
            "url": "https://example.com",
            "logo": "https://images.rentals.ca/logos/example.png",
            "name": "Example Property Management"
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "listing"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter, a range or a value is invalid. This response is not billable.

{
    "errors": {
        "path": [
            "The path field is required when url / id is not present."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The path or id is not a rental listing. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Rentals.ca 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.