> ## Documentation Index
> Fetch the complete documentation index at: https://realtycrawl.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Advertised rental layouts

> Read source-advertised bedroom, bathroom, area and price ranges. These are aggregate advertisement attributes, not identified floor plans, individual units or verified availability. Price periods remain source-specific.

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.


## OpenAPI

````yaml GET /v1/listings/{listing_id}/layout-options
openapi: 3.1.0
info:
  title: RealtyCrawl API
  version: 0.1.0
  description: >-
    Unified real estate API with source-specific operations, markets and access
    requirements. Check current capabilities before source requests.
    Documentation-backed beta contracts require explicit configuration and do
    not establish fresh live source acceptance.
servers:
  - url: https://realtycrawl.dev
security:
  - ApiKeyAuth: []
externalDocs:
  url: https://realtycrawl.dev/docs
paths:
  /v1/listings/{listing_id}/layout-options:
    get:
      tags:
        - listings
      summary: Advertised rental layouts
      description: >-
        Read source-advertised bedroom, bathroom, area and price ranges. These
        are aggregate advertisement attributes, not identified floor plans,
        individual units or verified availability. Price periods remain
        source-specific.
      operationId: getListingLayoutOptions
      parameters:
        - name: listing_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: fields
          in: query
          description: >-
            Response-only comma-separated field paths relative to data items; up
            to 32 paths. Source requests and billing are unchanged.
          schema:
            type: string
            maxLength: 4127
        - name: format
          in: query
          description: >-
            Response-only export format. JSON retains the envelope; CSV/NDJSON
            contain data records, with request/credit metadata in headers.
            Errors stay JSON.
          schema:
            type: string
            enum:
              - json
              - csv
              - ndjson
            default: json
      responses:
        '200':
          description: Source observation; inspect meta for evidence and completeness.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getListingLayoutOptionsResponse'
            text/csv:
              schema:
                type: string
                description: Data rows only; request, row count and credits are in headers.
            application/x-ndjson:
              schema:
                type: string
                description: One JSON data item per line; metadata is in headers.
        default:
          description: Typed error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    getListingLayoutOptionsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ListingLayoutOptions'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - meta
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                $ref: '#/components/schemas/SourceOutcome'
          required:
            - code
            - message
            - retryable
          additionalProperties: false
        request_id:
          type: string
      required:
        - error
        - request_id
      additionalProperties: false
    ListingLayoutOptions:
      type: object
      properties:
        listing_id:
          type: string
        individual_units_verified:
          const: false
        availability_verified:
          const: false
        origin:
          const: source_reported
        completeness:
          const: unknown
        source:
          $ref: '#/components/schemas/Source'
        bedroom_range:
          type: object
          properties:
            min:
              type: number
              minimum: 0
              maximum: 10000000000
            max:
              type: number
              minimum: 0
              maximum: 10000000000
            source_label:
              anyOf:
                - type: string
                  maxLength: 300
                - type: 'null'
          required:
            - min
            - max
            - source_label
          additionalProperties: false
        bathroom_range:
          type: object
          properties:
            min:
              type: number
              minimum: 0
              maximum: 10000000000
            max:
              type: number
              minimum: 0
              maximum: 10000000000
            source_label:
              anyOf:
                - type: string
                  maxLength: 300
                - type: 'null'
          required:
            - min
            - max
            - source_label
          additionalProperties: false
        area_range:
          anyOf:
            - type: object
              properties:
                min:
                  type: number
                  minimum: 0
                  maximum: 10000000000
                max:
                  type: number
                  minimum: 0
                  maximum: 10000000000
                source_label:
                  anyOf:
                    - type: string
                      maxLength: 300
                    - type: 'null'
                unit:
                  const: sqft
                basis:
                  const: advertised_layout_range
              required:
                - min
                - max
                - source_label
                - unit
                - basis
              additionalProperties: false
            - type: 'null'
        advertised_price_range:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
      required:
        - listing_id
        - individual_units_verified
        - availability_verified
        - origin
        - completeness
        - source
        - bedroom_range
        - bathroom_range
        - area_range
        - advertised_price_range
      additionalProperties: false
    Meta:
      type: object
      properties:
        request_id:
          type: string
        schema_version:
          type: string
        generated_at:
          type: string
          format: date-time
        completeness:
          type: string
          enum:
            - complete
            - partial
            - unknown
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceOutcome'
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              field:
                type: string
            required:
              - code
              - message
            additionalProperties: false
        pagination:
          type: object
          properties:
            next_cursor:
              anyOf:
                - type: string
                - type: 'null'
            has_more:
              type: boolean
            returned:
              type: integer
            total:
              anyOf:
                - type: integer
                - type: 'null'
            total_relation:
              type: string
              enum:
                - exact
                - lower_bound
                - unknown
          required:
            - next_cursor
            - has_more
            - returned
            - total
            - total_relation
          additionalProperties: false
        property_groups:
          type: array
          items:
            $ref: '#/components/schemas/PropertyGroup'
      required:
        - request_id
        - schema_version
        - generated_at
        - completeness
        - sources
      additionalProperties: false
    SourceOutcome:
      type: object
      properties:
        platform:
          type: string
        provider:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - success
            - partial
            - failed
            - unsupported
        error_code:
          anyOf:
            - type: string
            - type: 'null'
        truncated:
          type: boolean
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - platform
        - status
      additionalProperties: false
    Source:
      type: object
      properties:
        platform:
          type: string
        country:
          type: string
        native_id:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
              format: uri
            - type: 'null'
        provider:
          type: string
        observed_at:
          type: string
          format: date-time
        source_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        access_class:
          type: string
          enum:
            - public_portal
            - licensed_feed
            - public_record
            - modeled
        retrieved_at:
          type: string
          format: date-time
      required:
        - platform
        - provider
        - observed_at
        - access_class
      additionalProperties: false
    Money:
      type: object
      properties:
        amount:
          anyOf:
            - type: string
              pattern: ^-?\d+(\.\d+)?$
            - type: 'null'
        min:
          anyOf:
            - type: string
            - type: 'null'
        max:
          anyOf:
            - type: string
            - type: 'null'
        currency:
          anyOf:
            - type: string
              pattern: ^[A-Z]{3}$
            - type: 'null'
        unit_code:
          anyOf:
            - type: string
            - type: 'null'
        kind:
          type: string
          enum:
            - asking
            - sold
            - rent
            - lease_rate
            - starting_bid
            - deposit
            - fee
            - estimate
            - unknown
        period:
          anyOf:
            - type: string
              enum:
                - night
                - week
                - month
                - year
                - one_time
            - type: 'null'
        per_area_unit:
          anyOf:
            - type: string
            - type: 'null'
        display_text:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - amount
        - currency
        - kind
      additionalProperties: false
    PropertyGroup:
      type: object
      properties:
        property_id:
          anyOf:
            - type: string
            - type: 'null'
        listing_ids:
          type: array
          items:
            type: string
        match_method:
          type: string
        confidence:
          anyOf:
            - type: number
            - type: 'null'
        status:
          type: string
          enum:
            - matched
            - ambiguous
      required:
        - property_id
        - listing_ids
        - match_method
        - status
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.