# RESO-compliant API

The RESO-compliant API is publicly accessible and does not require authentication. It only exposes publicly available data for a given iGUIDE View. Any features or data that are disabled in that iGUIDE View will not be accessible through the API either. The format used in the API is designed to be compliant with RESO Data Dictionary v1.7.

# Lightweight Autofill Endpoint

TIP

The response of this endpoint is compliant with the approved RCP-025 Lightweight Autofill Schema (data shape).

Return information about an iGUIDE View as a RESO Property object that includes the following details:

  • property address
  • main building measurement details:
    • dimensions
    • areas
    • wall perimeter lengths
    • etc.
  • media links:
    • branded and unbranded iGUIDE URLs
    • PDF floor plan URLs (metric and imperial)
    • gallery images URLs
    • video URL
    • etc.

# HTTP Request

GET https://youriguide.com/{viewId}/reso/autofill

# Response Payload

Property Type Description
value array of Autofill Object An array with exactly one Autofill Object inside containing the details of the requested iGUIDE View

# Example

Request:

curl https://youriguide.com/vYGFV5GG6V8DD1/reso/autofill

Response:

{
  "value": [
    {
      "Country": "CA",
      "StateOrProvince": "YT",
      "City": "Dawson City",
      "PostalCode": "Y0B 1G0",
      "StreetName": "Bayshore Rd",
      "StreetNumber": "1803",

      "BelowGradeInteriorArea": 102.25751915892393,
      "BelowGradeInteriorAreaUnits": "Square Meters",
      "BelowGradeInteriorAreaSource": "iGUIDE",
      "AboveGradeInteriorArea": 289.3187033106537,
      "AboveGradeInteriorAreaUnits": "Square Meters",
      "AboveGradeInteriorAreaSource": "iGUIDE",
      "BelowGradeExteriorArea": 114.74315083554966,
      "BelowGradeExteriorAreaUnits": "Square Meters",
      "BelowGradeExteriorAreaSource": "iGUIDE",
      "AboveGradeExteriorArea": 316.69609925957513,
      "AboveGradeExteriorAreaUnits": "Square Meters",
      "AboveGradeExteriorAreaSource": "iGUIDE",
      "AboveGradeFinishedArea": 316.69609925957513,
      "AboveGradeFinishedAreaUnits": "Square Meters",
      "AboveGradeFinishedAreaSource": "iGUIDE",
      "BelowGradeFinishedArea": 65.68237369124323,
      "BelowGradeFinishedAreaUnits": "Square Meters",
      "BelowGradeFinishedAreaSource": "iGUIDE",
      "PerimeterWallThickness": 0.25,
      "PerimeterWallThicknessUnits": "Meters",
      "PerimeterWallThicknessSource": "iGUIDE",

      "Media": [
        {
          "ResourceName": "Property",
          "MediaCategory": "Branded Virtual Tour",
          "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Unbranded Virtual Tour",
          "MediaURL": "https://unbranded.youriguide.com/vJVDL415WZ7GE1/"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "pdf",
          "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/doc/floorplan_imperial.pdf",
          "ShortDescription": "imperial"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "pdf",
          "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/doc/floorplan_metric.pdf",
          "ShortDescription": "metric"
        },
        {
          "MediaObjectID": "vJVDL415WZ7GE1:YS31DZPJP6Q.jpg",
          "PreferredPhotoYN": true,
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/f/YS31DZPJP6Q.jpg",
          "ImageHeight": 1678,
          "ImageWidth": 1120
        },
        {
          "MediaObjectID": "vJVDL415WZ7GE1:YS31DZPJP6Q.jpg",
          "PreferredPhotoYN": true,
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/f/YS31DZPJP6Q_m.jpg",
          "ImageHeight": 1024,
          "ImageWidth": 683
        },
        ...
        {
          "ResourceName": "Property",
          "MediaCategory": "Video",
          "MediaURL": "https://youtu.be/DobXEWPLpKI"
        }
      ],

      "PropertyRooms": [
        {
          "RoomKeyNumeric": 13,
          "StructureKeyNumeric": 1,
          "FloorKeyNumeric": 1,
          "RoomType": "Dining",
          "RoomName": "Breakfast",
          "RoomWidth": 4.409,
          "RoomLength": 2.977,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE"
        },
        ...
        {
          "RoomKeyNumeric": 17,
          "StructureKeyNumeric": 2,
          "FloorKeyNumeric": 1,
          "RoomType": "Living",
          "RoomName": "Family",
          "RoomWidth": 5.959,
          "RoomLength": 4.753,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE"
        },
        {
          "RoomKeyNumeric": 31,
          "StructureKeyNumeric": 3,
          "FloorKeyNumeric": 4,
          "RoomType": "Utility",
          "RoomName": "Utility",
          "RoomWidth": 4.395,
          "RoomLength": 4.899,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE"
        }
      ]
    }
  ]
}

# Types

# Autofill Object

TIP

This object is compliant with the approved RCP-025 Lightweight Autofill Schema (data shape).

Property Type Description
The following are RESO-DD Address Group fields
Country string Country abbreviation in a postal address.
StateOrProvince string Text field containing the accepted postal abbreviation for a state or province.
City string City in a postal address.
PostalCode string Postal code portion of a street or mailing address.
StreetName string Street name portion of a property's street address.
StreetNumber string Street number portion of a property's street address.
UnitNumber string Text field containing the number or portion of a larger building or complex.
The following are RESO-DD Media Group fields
Media Array of Media Object List of media objects with their URLs
PropertyRooms Array of PropertyRoom Object List of media objects with their URLs
The following are RESO-DD Structure Group fields
AboveGradeFinishedArea float The finished area of the structure that is above grade.
AboveGradeFinishedAreaUnits string The unit of measurement used for the value in the AboveGradeFinishedArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
AboveGradeFinishedAreaSource string The source of the measurement of the AboveGradeFinishedArea property. Always set to iGUIDE if AboveGradeFinishedArea is present.
BelowGradeFinishedArea float The finished area of the structure that is below grade.
BelowGradeFinishedAreaUnits string The unit of measurement used for the value in the BelowGradeFinishedArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
BelowGradeFinishedAreaSource string The source of the measurement of the BelowGradeFinishedArea property. Always set to iGUIDE if BelowGradeFinishedArea is present.
The following fields have not yet been added to the RESO Data Dictionary
BelowGradeInteriorArea float The interior area of the structure that is below grade (surface of the ground adjacent to foundation).
BelowGradeInteriorAreaUnits string The unit of measurement used for the value in the BelowGradeInteriorArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
BelowGradeInteriorAreaSource string The source of the measurement of the BelowGradeInteriorArea property. Always set to iGUIDE if BelowGradeInteriorArea is present.
AboveGradeInteriorArea float The interior area of the structure that is above grade.
AboveGradeInteriorAreaUnits string The unit of measurement used for the value in the AboveGradeInteriorArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
AboveGradeInteriorAreaSource string The source of the measurement of the AboveGradeInteriorArea property. Always set to iGUIDE if AboveGradeInteriorArea is present.
BelowGradeExteriorArea float The exterior area of the structure that is below grade.
BelowGradeExteriorAreaUnits string The unit of measurement used for the value in the BelowGradeExteriorArea property. Possible values: Square Feet or Square Meters, see AreaUnits Lookups.
BelowGradeExteriorAreaSource string The source of the measurement of the BelowGradeExteriorArea property. Always set to iGUIDE if BelowGradeExteriorArea is present.
AboveGradeExteriorArea float The exterior area of the structure that is above grade.
AboveGradeExteriorAreaUnits string The unit of measurement used for the value in the AboveGradeExteriorArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
AboveGradeExteriorAreaSource string The source of the measurement of the AboveGradeExteriorArea property. Always set to iGUIDE if AboveGradeExteriorArea is present.
PerimeterWallThickness float The thickness of the exterior wall of the structure.
PerimeterWallThicknessUnits string The unit of measurement used for the value in the PerimeterWallThickness property. Possible values: Feet or Meters, see RESO-DD LinearUnits Lookups.
PerimeterWallThicknessSource string The source of the measurement of the PerimeterWallThickness property. Always set to iGUIDE if PerimeterWallThickness is present.

# PropertyRoom Object

This type describes a single room.

TIP

This type corresponds to RESO-DD PropertyRooms Resource.

Property Type Description
RoomKeyNumeric int The unique identifier for the room.
FloorKeyNumeric int The unique identifier of the floor this room belongs to.
StructureKeyNumeric int The unique identifier of the structure this room belongs to.
RoomType string The room's type. Common values: Outdoor, Bedroom, Living, Bathroom, Kitchen, Storage, Garage, Unfinished, Stairs, Office, Dining, Laundry, Utility, ColdRoom, Other.
RoomName string The user-defined name for the room.
RoomArea float The interior area of the room.
RoomAreaUnits string The unit of measurement used for the value in the RoomArea property. Possible values: Square Feet or Square Meters, see RESO-DD AreaUnits Lookups.
RoomAreaSource string The source of the measurement of the RoomArea property. Always set to iGUIDE if RoomArea is present.
RoomWidth float The width of the room.
RoomLength float The length of the room.
RoomWidthLengthUnits string The unit of measurement used for the value in the RoomWidthLength property. Possible values: Feet or Meters, see RESO-DD LinearUnits Lookups.
RoomWidthLengthSource string The source of the measurement of the RoomWidth and RoomLength properties. Always set to iGUIDE if the dimensions are present.

Example:

{
  "RoomKeyNumeric": 28,
  "FloorKeyNumeric": 2,
  "StructureKeyNumeric": 3,
  "RoomType": "Bedroom",
  "RoomName": "Master Bedroom",
  "RoomArea": 13.0012,
  "RoomAreaUnits": "Square Meters",
  "RoomAreaSource": "iGUIDE",
  "RoomWidth": 3.075,
  "RoomLength": 4.266,
  "RoomLengthWidthUnits": "Meters",
  "RoomLengthWidthSource": "iGUIDE"
}

# Media Object

TIP

This type corresponds to RESO-DD Media Resource.

Property Type Description
MediaCategory string Category describing record. Possible values: Branded Virtual Tour, Unbranded Virtual Tour, Floor Plan, Photo and Video; see MediaCategory Lookups.
MediaType string Media Types as defined by IANA. Possible values: pdf, jpeg, png or gif.
MediaURL string The URL to the media referenced by the record.
MediaHTML string HTML code to embed the media referenced by the record, e.g. virtual tour, image, video.
ShortDescription string The short text used to describe the media. This field is used to distinguish PDF floor plans in imperial units from those in metric units. The value will be set to imperial for PDF floor plans in imperial units and metric for PDF floor plans in metric units.
ImageHeight int The height of the image expressed in pixels.
ImageWidth int The width of the image expressed in pixels.
PreferredPhotoYN boolean A flag indicating that the media record is the preferred photo. This will typically mean the photo to be shown when only one of the photos is to be displayed.
MediaObjectID string The unique identifier of the underlying resource specified by the given media record.
Set for images only. Media records specifying different resolutions of the same image will have same the MediaObjectID value.
ResourceName string The resource or table of the listing or other record the media relates to. Possible values: Property, Member, Office or Contacts; see ResourceName Lookups.

TIP

The ShortDescription field is used to distinguish PDF floor plans in imperial units from those in metric units. Possible values for PDF floor plans are:

  • imperial for PDF floor plans in imperial units
  • metric for PDF floor plans in metric units

# Examples

Virtual Tour records:

[
  {
    "ResourceName": "Property",
    "MediaCategory": "Branded Virtual Tour",
    "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Unbranded Virtual Tour",
    "MediaURL": "https://unbranded.youriguide.com/vJVDL415WZ7GE1/"
  }
]

PDF floor plan records:

[
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "pdf",
    "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/doc/floorplan_imperial.pdf",
    "ShortDescription": "imperial"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "pdf",
    "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/doc/floorplan_metric.pdf",
    "ShortDescription": "metric"
  }
]

Records for different resolutions of the same image:

[
  {
    "MediaObjectID": "vJVDL415WZ7GE1:YS31DZPJP6Q.jpg",
    "PreferredPhotoYN": true,
    "ResourceName": "Property",
    "MediaCategory": "Photo",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/f/YS31DZPJP6Q.jpg",
    "ImageHeight": 1678,
    "ImageWidth": 1120
  },
  {
    "MediaObjectID": "vJVDL415WZ7GE1:YS31DZPJP6Q.jpg",
    "PreferredPhotoYN": true,
    "ResourceName": "Property",
    "MediaCategory": "Photo",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/vJVDL415WZ7GE1/f/YS31DZPJP6Q_m.jpg",
    "ImageHeight": 1024,
    "ImageWidth": 683
  }
]

Video record:

{
  "ResourceName": "Property",
  "MediaCategory": "Video",
  "MediaURL": "https://youtu.be/DobXEWPLpKI"
}
Last Updated: 4/24/2020, 4:08:29 PM