Skip to main content
GET
Advertised rental layouts
Read bedroom, bathroom, area and price ranges collected with your account’s supported Rentals.ca or Point2Homes rental advertisement. The source can advertise several layouts together; it does not identify individual floor-plan or unit records. Missing area and price-period values remain null. individual_units_verified and availability_verified remain false. Preserve the source, observation time and advertised range basis. This retained read costs one credit and makes no source request or retention renewal. Older observations without the section return SOURCE_DATA_UNAVAILABLE.

Authorizations

x-api-key
string
header
required

Path Parameters

listing_id
string
required
Minimum string length: 1

Query Parameters

fields
string

Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.

Maximum string length: 4127
format
enum<string>
default:json

Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Available options:
json,
csv,
ndjson

Response

Source observation; inspect meta for evidence and completeness.

data
object
required
meta
object
required