Public View API

The Public View 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.

Get iGUIDE View Status

Return the status of the iGUIDE View.

HTTP Request

GET https://youriguide.com/{viewId}/data/status

Response Payload

PropertyTypeDescription
statusstringStatus of the iGUIDE View:
  • locked - the View is locked/expired, its data is inaccessible
  • not-ready - the underlying iGUIDE is not drafted yet
  • ready - if the iGUIDE is drafted and the View is not locked

Example

Request:

curl https://youriguide.com/vYGFV5GG6V8DD1/data/status

Response:

{
  "status": "ready"
}

Response for iGUIDE View that is not yet drafted:

{
  "status": "not-ready"
}

Response for iGUIDE View that is locked:

{
  "status": "locked"
}

Get iGUIDE View Summary

Return the summary of the iGUIDE View.

HTTP Request

GET https://youriguide.com/{viewId}/data/summary

Response Payload

PropertyTypeDescription
statusstringStatus of the iGUIDE View:
  • locked - the View is locked/expired, its data is inaccessible
  • not-ready - the underlying iGUIDE is not drafted yet
  • ready - if the iGUIDE is drafted and the View is not locked
summarySummary ObjectSummary of the iGUIDE View

Example

Request:

curl https://youriguide.com/vYGFV5GG6V8DD1/data/summary

Response:

{
  "status": "ready",
  "summary": {
    "buildings": [
      {
        "id": 1,
        "name": "Main Building",
        "intAreaAboveGrade": 289318703.3106537,
        "extAreaAboveGrade": 316696099.2595751,
        "intAreaTotal": 391576222.4695776,
        "extAreaTotal": 431439250.0951248,
        "finishedAreaTotal": 425479657.992722847,
        "unfinishedAreaTotal": 5959592.102401953,
        "finishedAreaAboveGrade": 283359111.208251747,
        "unfinishedAreaAboveGrade": 33336988.051323353,
        "wallThickness": 250,
        "isMainBuilding": true,
        "floors": [
          {
            "id": 1,
            "name": "MAIN FLOOR",
            "interiorArea": 146179299.1783684,
            "exteriorArea": 160057159.2075057,
            "finishedArea": 160057159.2075057,
            "perimeter": 55511.44011654928,
            "rooms": [
              {
                "id": 13,
                "type": "Dining",
                "name": "Breakfast",
                "dims": [ 4409, 2977 ]
              },
              {
                "id": 12,
                "type": "Dining",
                "name": "Dining",
                "dims": [ 4300, 5998 ]
              },
              {
                "id": 15,
                "type": "Other",
                "name": "Foyer",
                "dims": [ 2713, 4043 ]
              },
              {
                "id": 14,
                "type": "Kitchen",
                "name": "Kitchen",
                "dims": [ 4469, 4680 ]
              },
              {
                "id": 7,
                "type": "Laundry",
                "name": "Laundry",
                "dims": [ 3327, 2966 ]
              },
              {
                "id": 4,
                "type": "Living",
                "name": "Living",
                "dims": [ 4300, 4273 ]
              },
              {
                "id": 9,
                "type": "Living",
                "name": "Showroom",
                "dims": [ 5936, 7625 ]
              }
            ]
          },
          {
            "id": 2,
            "name": "2ND FLOOR",
            "interiorArea": 143139404.13228527,
            "exteriorArea": 156638940.05206946,
            "finishedArea": 156638940.05206946,
            "perimeter": 53998.143679136796,
            "rooms": [
              {
                "id": 28,
                "type": "Bedroom",
                "name": "Bedroom",
                "dims": [ 3075, 4266 ]
              },
              {
                "id": 16,
                "type": "Bedroom",
                "name": "Bedroom",
                "dims": [ 4317, 3361 ]
              },
              {
                "id": 17,
                "type": "Living",
                "name": "Family",
                "dims": [ 5959, 4753 ]
              },
              {
                "id": 29,
                "type": "Bedroom",
                "name": "Master",
                "dims": [ 4488, 7818 ]
              }
            ]
          },
          {
            "id": 3,
            "name": "BASEMENT",
            "interiorArea": 102257519.15892394,
            "exteriorArea": 114743150.83554964,
            "finishedArea": 108783558.733147687,
            "unfinishedArea": 5959592.102401953,
            "perimeter": 49942.52670650281,
            "wallThickness": 280,
            "isBelowGrade": true,
            "rooms": [
              {
                "id": 33,
                "type": "Living",
                "name": "Rec Room",
                "dims": [ 8631, 11537 ]
              },
              {
                "id": 35,
                "type": "Storage",
                "name": "Storage",
                "dims": [ 2338, 4183 ]
              },
              {
                "id": 31,
                "type": "Utility",
                "name": "Utility",
                "dims": [ 4395, 4899 ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Types

Summary Object

The root level of summary object contains just an array of property buildings.

PropertyTypeDescription
buildingsArray of BuildingsCollection of buildings

WARNING

  • All area values (2D) are reported in mm2 (square millimeters)
  • All length/width/thickness (1D) values are reported in mm (millimeters)

Summary object example:

{
  "buildings": [ ... ],
  "measurementStandard": string,
}

Measurement Standard

Indicates which measurement standard is being used to calculate the building's area. There are two standards supported at this time:

  • ANSI Z765, reported as "ansi"
  • RECA RMS, reported as "rms"

We will continue to support more standards in future.

Interior, Exterior and Excluded areas are exclusive to RMS.

Finished and Unfinished areas are exclusive to ANSI.

Building Object

The summary for a building in the property.

PropertyTypeStandardDescription
idintUnique ID of the building
namestringUser-defined name of the building
intAreaAboveGradefloatRECA RMSAbove grade interior area of the building in square millimeters
extAreaAboveGradefloatRECA RMSAbove grade exterior area of the building in square millimeters
intAreaTotalfloatRECA RMSTotal interior area of the building in square millimeters
extAreaTotalfloatRECA RMSTotal exterior area of the building in square millimeters
excludedAreaAboveGradefloatRECA RMSArea excluded from intAreaAboveGrade and extAreaAboveGrade
excludedAreaTotalfloatRECA RMSArea excluded from intAreaTotal and extAreaTotal
finishedAreaTotalfloatANSI Z765Total finished area of the building in square millimeters
unfinishedAreaTotalfloatANSI Z765Total unfinished area of the building in square millimeters
finishedAreaAboveGradefloatANSI Z765Total above grade finished area of the building in square millimeters
unfinishedAreaAboveGradefloatANSI Z765Total above grade unfinished area of the building in square millimeters
finishedAreaBelowGradefloatANSI Z765Total below grade finished area of the building in square millimeters
unfinishedAreaBelowGradefloatANSI Z765Total below grade unfinished area of the building in square millimeters
wallThicknessfloatThickness of the exterior wall of the building in millimeters
isMainBuildingbooleanA flag indicating whether it is the main building of the property
floorsArray of FloorsCollection of building floors

WARNING

  • All area values (2D) are reported in mm2 (square millimeters)
  • All length/width/thickness (1D) values are reported in mm (millimeters)

Building object example:

{
  "id": 1,
  "name": "Main Building",
  "intAreaAboveGrade": 289318703.3106537,
  "extAreaAboveGrade": 316696099.2595751,
  "intAreaTotal": 391576222.4695776,
  "extAreaTotal": 431439250.0951248,
  "finishedAreaTotal": 425479657.992722847,
  "unfinishedAreaTotal": 5959592.102401953,
  "finishedAreaAboveGrade": 283359111.208251747,
  "unfinishedAreaAboveGrade": 33336988.051323353,
  "wallThickness": 250,
  "isMainBuilding": true,
  "floors": [ ... ]
}

Floor Object

The summary for a specific floor in a building.

PropertyTypeDescription
idintUnique ID of the floor
namestringUser-defined name of the floor
interiorAreafloatInterior area of the floor in square millimeters
exteriorAreafloatExterior area of the floor in square millimeters
finishedAreafloatFinished area of the floor in square millimeters
unfinishedAreafloatUnfinished area of the floor in square millimeters
excludedAreafloatArea excluded from interiorArea and exteriorArea
perimeterfloatPerimeter length of the exterior wall of the floor in millimeters
wallThicknessfloatThickness of the exterior wall of the floor in millimeters
isBelowGradebooleanA flag indicating whether the floor is below grade.
roomsArray of RoomsCollection of floor rooms

WARNING

  • All area values (2D) are reported in mm2 (square millimeters)
  • All length/width/thickness (1D) values are reported in mm (millimeters)

Floor object example:

{
  "id": 1,
  "name": "Basement",
  "interiorArea": 146179299.1783684,
  "exteriorArea": 160057159.2075057,
  "finishedArea": 154097567.105103747,
  "unfinishedArea": 5959592.102401953,
  "perimeter": 55511.44011654928,
  "wallThickness": 200,
  "isBelowGrade": true,
  "rooms": [ ... ]
}

Room Object

The summary for a specific room in a floor.

PropertyTypeDescription
idintUnique ID of the room
typestringType of room. Common values: Outdoor, Bedroom, Living, Bathroom, Kitchen, Storage, Garage, Unfinished, Stairs, Office, Dining, Laundry, Utility, ColdRoom, Other.
namestringUser-defined name of the room
dimsarray of floatArray containing the room dimensions in the form: [width, length]. If the array is not empty it will contain exactly 2 elements. dims[0] is the width value in millimeters and dims[1] is the length value in millimeters
areafloatInterior area of the room in square millimeters
perimeterfloatIf available, perimeter of the room in millimeters (sum of all wall lengths including openings such as doors, invisible dividers and thin half-walls; can be larger than sum of all wall segment lengths)
perimeterWithoutOpeningsfloatIf available, perimeter of the room in millimeters excluding openings such as doors, invisible dividers and thin half-walls. Can be thought of as the baseboard length
wallAreafloatIf available, surface area of all walls (excluding thin half-walls) in the room in square millimeters
wallAreaWithoutOpeningsfloatIf available, surface area of all walls (excluding thin half-walls) in the room in square millimeters excluding openings such as doors and windows
volumefloatIf available, volume of the room in square millimeters
wallSegmentsIf available, array of Wall SegmentsCollection of room wall segments

WARNING

  • All area values (2D) are reported in mm2 (square millimeters)
  • All length/width/thickness (1D) values are reported in mm (millimeters)

WARNING

The response object may contain other fields not mentioned in this document. These fields are deprecated and are kept for backward compatibility only. Ignore any fields not present in this document, as they may be removed at any time without notice.

Room object example:

{
  "id": 17,
  "type": "Living",
  "name": "Family",
  "dims": [ 5959, 4753 ],
  "area": 28323124.11,
  "perimeter": 11891.451,
  "perimeterWithoutOpenings": 10011.872,
  "wallArea": 28996114.1184,
  "wallAreaWithoutOpenings": 24412948.6848,
  "volume": 28323124110.839,
  "wallSegments": [ ... ]
}

Wall Segment Object

The summary for a specific wall segment in a room.

PropertyTypeDescription
lengthfloatLength of the wall segment in millimeters
heightfloatHeight of the wall segment in millimeters
areafloatSurface area of the wall segment in square millimeters
areaWithoutOpeningsfloatSurface area of the wall segment in square millimeters excluding openings such as doors and windows

WARNING

  • All area values (2D) are reported in mm2 (square millimeters)
  • All length/width/thickness (1D) values are reported in mm (millimeters)

Wall Segment object example:

{
  "length": 5460.168,
  "height": 2438.398,
  "area": 28996114.1184,
  "areaWithoutOpenings": 24412948.6848
}
Last Updated: