RESO-compliant API

The RESO-compliant API 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. 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-022: RESO Autofill Service.

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
`@reso.context`	string	Context specifying Data Dictionay model and version as defined in RCP-025: RESO Common Format
`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/api-docs-sample/reso/autofill

Response:

{
  "@reso.context": "urn:reso:metadata:1.7:resource:property",
  "value": [
    {
      "Country": "CA",
      "StateOrProvince": "ON",
      "City": "Kitchener",
      "PostalCode": "N2G 2L3",
      "StreetName": "King St E",
      "StreetNumber": "301",
      "Media": [
        {
          "ResourceName": "Property",
          "MediaCategory": "Branded Virtual Tour",
          "MediaURL": "https://youriguide.com/api-docs-sample/"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Unbranded Virtual Tour",
          "MediaURL": "https://unbranded.youriguide.com/api-docs-sample/"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "pdf",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floorplan_imperial.pdf",
          "ShortDescription": "imperial"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "pdf",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floorplan_metric.pdf",
          "ShortDescription": "metric"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_metric_1.jpg",
          "ShortDescription": "metric floor page"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_imperial_1.jpg",
          "ShortDescription": "imperial floor page"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_metric_2.jpg",
          "ShortDescription": "metric floor page"
        },
        {
          "ResourceName": "Property",
          "MediaCategory": "Floor Plan",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_imperial_2.jpg",
          "ShortDescription": "imperial floor page"
        },
        ...
        {
          "MediaObjectID": "api-docs-sample:2MPC9G66HF1G.jpg",
          "PreferredPhotoYN": true,
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPC9G66HF1G.jpg",
          "ImageHeight": 4265,
          "ImageWidth": 6400
        },
        {
          "MediaObjectID": "api-docs-sample:2MPC9G66HF1G.jpg",
          "PreferredPhotoYN": true,
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPC9G66HF1G_m.jpg",
          "ImageHeight": 682,
          "ImageWidth": 1024
        },
        ...
        {
          "MediaObjectID": "api-docs-sample:2MPCAI3U37ZH.jpg",
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPCAI3U37ZH.jpg",
          "ImageHeight": 4266,
          "ImageWidth": 6400
        },
        {
          "MediaObjectID": "api-docs-sample:2MPCAI3U37ZH.jpg",
          "ResourceName": "Property",
          "MediaCategory": "Photo",
          "MediaType": "jpeg",
          "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPCAI3U37ZH_m.jpg",
          "ImageHeight": 682,
          "ImageWidth": 1024
        }
      ],
      "BelowGradeInteriorArea": 142.933077,
      "BelowGradeInteriorAreaUnits": "Square Meters",
      "BelowGradeInteriorAreaSource": "iGUIDE",
      "AboveGradeInteriorArea": 337.36767,
      "AboveGradeInteriorAreaUnits": "Square Meters",
      "AboveGradeInteriorAreaSource": "iGUIDE",
      "BelowGradeExteriorArea": 154.964481,
      "BelowGradeExteriorAreaUnits": "Square Meters",
      "BelowGradeExteriorAreaSource": "iGUIDE",
      "AboveGradeExteriorArea": 361.127776,
      "AboveGradeExteriorAreaUnits": "Square Meters",
      "AboveGradeExteriorAreaSource": "iGUIDE",
      "BelowGradeExcludedArea": 17.993266,
      "BelowGradeExcludedAreaUnits": "Square Meters",
      "BelowGradeExcludedAreaSource": "iGUIDE",
      "AboveGradeExcludedArea": 35.444345,
      "AboveGradeExcludedAreaUnits": "Square Meters",
      "AboveGradeExcludedAreaSource": "iGUIDE",
      "BelowGradeFinishedArea": 133.932156,
      "BelowGradeFinishedAreaUnits": "Square Meters",
      "BelowGradeFinishedAreaSource": "iGUIDE",
      "PerimeterWallThickness": 0.203,
      "PerimeterWallThicknessUnits": "Meters",
      "PerimeterWallThicknessSource": "iGUIDE",
      "Rooms": [
        {
          "RoomKey": "65",
          "StructureKey": "1",
          "FloorKey": "1",
          "FloorName": "Main Floor",
          "RoomType": "Dining",
          "RoomName": "Dining",
          "RoomLevel": "Main",
          "RoomWidth": 5.81,
          "RoomLength": 3.204,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 18.613239,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
        {
          "RoomKey": "126",
          "StructureKey": "1",
          "FloorKey": "1",
          "FloorName": "Main Floor",
          "RoomType": "Living",
          "RoomName": "Family",
          "RoomLevel": "Main",
          "RoomWidth": 5.657,
          "RoomLength": 4.514,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 25.506103,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
        {
          "RoomKey": "73",
          "StructureKey": "1",
          "FloorKey": "1",
          "FloorName": "Main Floor",
          "RoomType": "Garage",
          "RoomName": "Garage",
          "RoomLevel": "Main",
          "RoomWidth": 5.726,
          "RoomLength": 6.065,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 32.248413,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
        {
          "RoomKey": "72",
          "StructureKey": "1",
          "FloorKey": "1",
          "FloorName": "Main Floor",
          "RoomType": "Bathroom",
          "RoomName": "2pc Bath",
          "RoomLevel": "Main",
          "RoomWidth": 1.516,
          "RoomLength": 2.033,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 3.082274,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
        ...
        {
          "RoomKey": "127",
          "StructureKey": "1",
          "FloorKey": "3",
          "FloorName": "Basement",
          "RoomType": "Living",
          "RoomName": "Den",
          "RoomLevel": "Basement",
          "RoomWidth": 5.526,
          "RoomLength": 3.081,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 16.959129,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
        {
          "RoomKey": "117",
          "StructureKey": "1",
          "FloorKey": "3",
          "FloorName": "Basement",
          "RoomType": "Living",
          "RoomName": "Gym",
          "RoomLevel": "Basement",
          "RoomWidth": 3.784,
          "RoomLength": 3.641,
          "RoomLengthWidthUnits": "Meters",
          "RoomLengthWidthSource": "iGUIDE",
          "RoomArea": 13.778301,
          "RoomAreaUnits": "Square Meters",
          "RoomAreaSource": "iGUIDE"
        },
      ],
      "xPlntrStructures": [
        {
          "StructureKey": "1",
          "StructureName": "Main Building",
          "MainStructureYN": true,
          "BelowGradeInteriorArea": 142.933077,
          "BelowGradeInteriorAreaUnits": "Square Meters",
          "BelowGradeInteriorAreaSource": "iGUIDE",
          "AboveGradeInteriorArea": 337.36767,
          "AboveGradeInteriorAreaUnits": "Square Meters",
          "AboveGradeInteriorAreaSource": "iGUIDE",
          "BelowGradeExteriorArea": 154.964481,
          "BelowGradeExteriorAreaUnits": "Square Meters",
          "BelowGradeExteriorAreaSource": "iGUIDE",
          "AboveGradeExteriorArea": 361.127776,
          "AboveGradeExteriorAreaUnits": "Square Meters",
          "AboveGradeExteriorAreaSource": "iGUIDE",
          "BelowGradeExcludedArea": 17.993266,
          "BelowGradeExcludedAreaUnits": "Square Meters",
          "BelowGradeExcludedAreaSource": "iGUIDE",
          "AboveGradeExcludedArea": 35.444345,
          "AboveGradeExcludedAreaUnits": "Square Meters",
          "AboveGradeExcludedAreaSource": "iGUIDE",
          "BelowGradeFinishedArea": 133.932156,
          "BelowGradeFinishedAreaUnits": "Square Meters",
          "BelowGradeFinishedAreaSource": "iGUIDE",
          "PerimeterWallThickness": 0.203,
          "PerimeterWallThicknessUnits": "Meters",
          "PerimeterWallThicknessSource": "iGUIDE",
          "FloorsTotal": 3,
          "Floors": [
            {
              "FloorKey": "1",
              "StructureKey": "1",
              "FloorName": "Main Floor",
              "InteriorArea": 160.593319,
              "InteriorAreaUnits": "Square Meters",
              "InteriorAreaSource": "iGUIDE",
              "ExteriorArea": 171.862023,
              "ExteriorAreaUnits": "Square Meters",
              "ExteriorAreaSource": "iGUIDE",
              "ExcludedArea": 34.803838,
              "ExcludedAreaUnits": "Square Meters",
              "ExcludedAreaSource": "iGUIDE",
              "PerimeterWallLength": 60.025,
              "PerimeterWallLengthUnits": "Meters",
              "PerimeterWallLengthSource": "iGUIDE",
              "PerimeterWallThickness": 0.203,
              "PerimeterWallThicknessUnits": "Meters",
              "PerimeterWallThicknessSource": "iGUIDE",
              "RoomsTotal": 8,
              "Rooms": [
                {
                  "RoomKey": "72",
                  "StructureKey": "1",
                  "FloorKey": "1",
                  "FloorName": "Main Floor",
                  "RoomType": "Bathroom",
                  "RoomName": "2pc Bath",
                  "RoomLevel": "Main",
                  "RoomWidth": 1.516,
                  "RoomLength": 2.033,
                  "RoomLengthWidthUnits": "Meters",
                  "RoomLengthWidthSource": "iGUIDE",
                  "RoomArea": 3.082274,
                  "RoomAreaUnits": "Square Meters",
                  "RoomAreaSource": "iGUIDE"
                },
                ...
              ]
            },
            {
              "FloorKey": "2",
              "StructureKey": "1",
              "FloorName": "2nd Floor",
              ...
              "Rooms": [ ... ]
            },
            {
              "FloorKey": "3",
              "StructureKey": "1",
              "FloorName": "Basement",
              "BelowGradeYN": true,
              ...
              "Rooms": [ ... ]
            }
          ]
        },
        {
          "StructureKey": "2",
          "StructureName": "New Building",
          "AboveGradeExcludedArea": 8.698463,
          "AboveGradeExcludedAreaUnits": "Square Meters",
          "AboveGradeExcludedAreaSource": "iGUIDE",
          "FloorsTotal": 1,
          "Floors": [ ... ]
        }
      ]
    }
  ]
}

Types

Autofill Object

TIP

This object is compliant with the approved RCP-022: RESO Autofill Service.

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
`Rooms`	Array of PropertyRoom Object	List of room objects
		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.

`BelowGradeExcludedArea`	float	The excluded area of the structure that is below grade.
`BelowGradeExcludedAreaUnits`	string	The unit of measurement used for the value in the `BelowGradeExcludedArea` property. Possible values: `Square Feet` or `Square Meters`, see AreaUnits Lookups.
`BelowGradeExcludedAreaSource`	string	The source of the measurement of the `BelowGradeExcludedArea` property. Always set to `iGUIDE` if `BelowGradeExcludedArea` is present.

`AboveGradeExcludedArea`	float	The excluded area of the structure that is above grade.
`AboveGradeExcludedAreaUnits`	string	The unit of measurement used for the value in the `AboveGradeExcludedArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`AboveGradeExcludedAreaSource`	string	The source of the measurement of the `AboveGradeExcludedArea` property. Always set to `iGUIDE` if `AboveGradeExcludedArea` is present.

`BelowGradeUnfinishedArea`	float	The unfinished area of the structure that is below grade.
`BelowGradeUnfinishedAreaUnits`	string	The unit of measurement used for the value in the `BelowGradeUnfinishedArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`BelowGradeUnfinishedAreaSource`	string	The source of the measurement of the `BelowGradeUnfinishedArea` property. Always set to `iGUIDE` if `BelowGradeUnfinishedArea` is present.

`AboveGradeUnfinishedArea`	float	The unfinished area of the structure that is above grade.
`AboveGradeUnfinishedAreaUnits`	string	The unit of measurement used for the value in the `AboveGradeUnfinishedArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`AboveGradeUnfinishedAreaSource`	string	The source of the measurement of the `AboveGradeUnfinishedArea` property. Always set to `iGUIDE` if `AboveGradeUnfinishedArea` 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.
		The following are Planitar-specific fields, not part of RESO DataDictionaryL
`xPlntrStructures` non-RESO	Array of PropertyStructure Object	List of structures including nested objects such as floors and rooms

PropertyRoom Object

This type describes a single room.

TIP

This type corresponds to RESO-DD PropertyRooms Resource.

Property	Type	Description
`RoomKey`	string	The unique identifier for the room.
`FloorKey`	string	The unique identifier of the floor this room belongs to.
`FloorName` non-RESO	string	The name of the floor this room belongs to.
`StructureKey`	string	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.
`RoomLevel` DD 2.0	string	The room's level. See RESO-DD RoomLevel Lookups Note: The support of this field is experimental. The value may be missing. Consider using Autofill Object's `xPlntrStructures` instead. Its implementation is complete and stable.

`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:

{
  "RoomKey": "28",
  "FloorKey": "2",
  "FloorName": "Downstairs",
  "StructureKey": "3",
  "RoomType": "Bedroom",
  "RoomName": "Master Bedroom",
  "RoomLevel": "Basement",
  "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/api-docs-sample/"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Unbranded Virtual Tour",
    "MediaURL": "https://unbranded.youriguide.com/api-docs-sample/"
  }
]

PDF floor plan records:

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

JPEG floor plan records (one image per floor):

[
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_metric_1.jpg",
    "ShortDescription": "metric floor page"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_imperial_1.jpg",
    "ShortDescription": "imperial floor page"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_metric_2.jpg",
    "ShortDescription": "metric floor page"
  },
  {
    "ResourceName": "Property",
    "MediaCategory": "Floor Plan",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/doc/floor-page_imperial_2.jpg",
    "ShortDescription": "imperial floor page"
  }
]

Records for different resolutions of the same image:

[
  {
    "MediaObjectID": "api-docs-sample:2MPC9G66HF1G.jpg",
    "PreferredPhotoYN": true,
    "ResourceName": "Property",
    "MediaCategory": "Photo",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPC9G66HF1G.jpg",
    "ImageHeight": 4265,
    "ImageWidth": 6400
  },
  {
    "MediaObjectID": "api-docs-sample:2MPC9G66HF1G.jpg",
    "PreferredPhotoYN": true,
    "ResourceName": "Property",
    "MediaCategory": "Photo",
    "MediaType": "jpeg",
    "MediaURL": "https://youriguide.com/api-docs-sample/f/2MPC9G66HF1G_m.jpg",
    "ImageHeight": 682,
    "ImageWidth": 1024
  }
]

Video record:

{
  "ResourceName": "Property",
  "MediaCategory": "Video",
  "MediaURL": "https://youtu.be/DobXEWPLpKI"
}

PropertyStructure Object

This type describes a standalone structure (building) of the property. Every property has at least one structure that is the main building.

EXPERIMENTAL

This type is compliant with RCP-022: RESO Autofill Service that is not approved yet.

Property	Type	Description
`StructureKey`	string	The unique identifier for the structure.
`StructureName`	string	The user-defined name for the structure.
`MainStructureYN`	boolean	A flag indicating whether it is the main structure of the property.

`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.

`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.

`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.

`FloorsTotal`	int	The total number of floors in the structure.
`Floors`	Array of PropertyFloor Object

Example:

{
  "StructureKey": "1",
  "StructureName": "Main Building",
  "MainStructureYN": true,
  "BelowGradeInteriorArea": 142.933077,
  "BelowGradeInteriorAreaUnits": "Square Meters",
  "BelowGradeInteriorAreaSource": "iGUIDE",
  "AboveGradeInteriorArea": 337.36767,
  "AboveGradeInteriorAreaUnits": "Square Meters",
  "AboveGradeInteriorAreaSource": "iGUIDE",
  "BelowGradeExteriorArea": 154.964481,
  "BelowGradeExteriorAreaUnits": "Square Meters",
  "BelowGradeExteriorAreaSource": "iGUIDE",
  "AboveGradeExteriorArea": 361.127776,
  "AboveGradeExteriorAreaUnits": "Square Meters",
  "AboveGradeExteriorAreaSource": "iGUIDE",
  "BelowGradeExcludedArea": 17.993266,
  "BelowGradeExcludedAreaUnits": "Square Meters",
  "BelowGradeExcludedAreaSource": "iGUIDE",
  "AboveGradeExcludedArea": 35.444345,
  "AboveGradeExcludedAreaUnits": "Square Meters",
  "AboveGradeExcludedAreaSource": "iGUIDE",
  "BelowGradeFinishedArea": 133.932156,
  "BelowGradeFinishedAreaUnits": "Square Meters",
  "BelowGradeFinishedAreaSource": "iGUIDE",
  "PerimeterWallThickness": 0.203,
  "PerimeterWallThicknessUnits": "Meters",
  "PerimeterWallThicknessSource": "iGUIDE",
  "FloorsTotal": 3,
  "Floors": [ ... ]
}

PropertyFloor Object

This type describes a single floor. Every property has at least one floor.

EXPERIMENTAL

This type is compliant with RCP-022: RESO Autofill Service that is not approved yet.

Property	Type	Description
`FloorKey`	string	The unique identifier for the floor.
`StructureKey`	string	The unique identifier for the structure the floor belongs to.
`FloorName`	string	The user-defined name for the floor.
`BelowGradeYN`	boolean	A flag indicating whether the floor is below grade.

`InteriorArea`	float	The interior area of the floor.
`InteriorAreaUnits`	string	The unit of measurement used for the value in the `InteriorArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`InteriorAreaSource`	string	The source of the measurement of the `InteriorArea` property. Always set to `iGUIDE` if `InteriorArea` is present.

`ExteriorArea`	float	The exterior area of the floor.
`ExteriorAreaUnits`	string	The unit of measurement used for the value in the `ExteriorArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`ExteriorAreaSource`	string	The source of the measurement of the `ExteriorArea` property. Always set to `iGUIDE` if `ExteriorArea` is present.

`FinishedArea`	float	The finished area of the floor.
`FinishedAreaUnits`	string	The unit of measurement used for the value in the `FinishedArea` property. Possible values: `Square Feet` or `Square Meters`, see RESO-DD AreaUnits Lookups.
`FinishedAreaSource`	string	The source of the measurement of the `FinishedArea` property. Always set to `iGUIDE` if `FinishedArea` is present.

`PerimeterWallLength`	float	The perimeter length of the exterior wall of the floor.
`PerimeterWallLengthUnits`	string	The unit of measurement used for the value in the `PerimeterWallLength` property. Possible values: `Feet` or `Meters`, see RESO-DD LinearUnits Lookups.
`PerimeterWallLengthSource`	string	The source of the measurement of the `PerimeterWallLength` property. Always set to `iGUIDE` if `PerimeterWallLength` is present.

`PerimeterWallThickness`	float	The thickness of exterior wall of the floor.
`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.

`RoomsTotal`	int	The total number of rooms in the floor.
`Rooms`	Array of PropertyRoom Object

Example:

{
  "FloorKey": "1",
  "StructureKey": "1",
  "FloorName": "MAIN FLOOR",
  "InteriorArea": 146.17929917836838,
  "InteriorAreaUnits": "Square Meters",
  "InteriorAreaSource": "iGUIDE",
  "ExteriorArea": 160.0571592075057,
  "ExteriorAreaUnits": "Square Meters",
  "ExteriorAreaSource": "iGUIDE",
  "FinishedArea": 160.0571592075057,
  "FinishedAreaUnits": "Square Meters",
  "FinishedAreaSource": "iGUIDE",
  "PerimeterWallLength": 55.51144011654928,
  "PerimeterWallLengthUnits": "Meters",
  "PerimeterWallLengthSource": "iGUIDE",
  "PerimeterWallThickness": 0.2,
  "PerimeterWallThicknessUnits": "Meters",
  "PerimeterWallThicknessSource": "iGUIDE",
  "RoomsTotal": 7,
  "Rooms": [ ... ]
}