Buildings v1 · Attributes

Download schema

Before calling these endpoints, use a Geoscape Hub application with access to this API product. Authenticate with your Consumer Key in the Authorization header. See Authentication, Error Handling, Rate Limiting, and Attribution for shared integration guidance.

Required response fields must be present when their containing object is returned. Supply the documented request parameters when calling the endpoint.

deprecated

Presence of solar panel

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/solarPanel

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Returns the answer to the question, does this building have solar panels? For energy providers or energy-based service providers, this information will inform you of solar panel presence without the need for a physical inspection. For insurance, you can reduce the number of questions asked on home insurance policies, and for government, you can see measure the adoption of solar across the county.

Links to further reading

Presence of solar panel › path Parameters

buildingId

string · required

Presence of solar panel › Responses

Successful response

buildingId

string · required

solarPanel

BuildingsV1_solarPanel · required

deprecated

Area

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/area

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Returns the area of the building footprint in meters.

Use the area of the building to understand how much land area the building takes up. Often used in applications where you need to know how much floor space is available in a home or how much roof space is available for solar panel installation.

Links to further reading

Area › path Parameters

buildingId

string · required

Area › Responses

Successful response

area

BuildingsV1_area · required

buildingId

string · required

deprecated

Average eave height

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/averageEaveHeight

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the average eave height of the specified building in meters.

This data is valuable for tradespeople who need to know how big of a ladder to bring to a job before they arrive or for emergency services who need to know which truck to deploy.

Links to further reading

Average eave height › path Parameters

buildingId

string · required

Average eave height › Responses

Successful

averageEaveHeight

BuildingsV1_averageEaveHeight · required

buildingId

string · required

deprecated

Centroid

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/centroid

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the centroid (the spatial point at the average of all points of an object) of a building.

It's the most straightforward geometry to describe where a building is, which is helpful in centring maps, plotting multiple buildings on a map or storing the known location of a building.

Links to further reading

Centroid › path Parameters

buildingId

string · required

Centroid › Responses

Successful

buildingId

string · required

object · required

deprecated

Elevation

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/elevation

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the elevation (or geometric height above or below a fixed reference point; in this case, it's the AHD, which was a mean of the sea level from 1966-1968) of a building.

This data is helpful for those applications where you want to be able to measure the difference in vertical position between multiple people or get more detailed information about the location of a building.

Links to further reading

Elevation › path Parameters

buildingId

string · required

Elevation › Responses

Successful

buildingId

string · required

elevation

BuildingsV1_elevation · required

deprecated

2D footprint

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/footprint2d

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

return a GeoJSON Polygon, describing the 2D outline of the building.

You can use this information to draw the building for visual inspection and give context to other data. Without this, your users will need to make the logical jumps required to visualise the structure. Using this, you've made it much easier for users to relate to the building. It's also highly used in modelling applications for analytics.

Links to further reading

2D footprint › path Parameters

buildingId

string · required

2D footprint › Responses

Successful

buildingId

string · required

BuildingsV1_footprint2d · required

GET/v1/buildings/{buildingId}/footprint2d

curl https://api.psma.com.au/v1/buildings/:buildingId/footprint2d \
  --header 'Authorization: <api-key>'

Example Responses

{
  "buildingId": "bld02443a123d77",
  "footprint2d": {
    "coordinates": [
      [
        [
          [
            149.108155821,
            -35.4107188849999
          ],
          [
            149.10819618,
            -35.4107288989999
          ],
          [
            149.108172158,
            -35.410793784
          ],
          [
            149.108131799,
            -35.41078377
          ],
          [
            149.108155821,
            -35.4107188849999
          ]
        ]
      ]
    ],
    "type": "MultiPolygon"
  }
}

json

application/json

deprecated

3D footprint

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/footprint3d

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return a GeoJSON Polygon, describing the 2D outline of the building with an additional element of elevation.

You can use this information to draw the building for visual inspection and give context to other data. Without this, your users will need to make the logical jumps necessary to visualise the structure. Using this, you've made it much easier for users to relate to the building. It's also highly used in modelling applications for analytics.

Links to further reading

3D footprint › path Parameters

buildingId

string · required

3D footprint › Responses

Success

buildingId

string · required

BuildingsV1_footprint3d · required

GET/v1/buildings/{buildingId}/footprint3d

curl https://api.psma.com.au/v1/buildings/:buildingId/footprint3d \
  --header 'Authorization: <api-key>'

Example Responses

{
  "buildingId": "bld02443a123d77",
  "footprint3d": {
    "coordinates": [
      [
        [
          [
            149.108155821,
            -35.4107188849999,
            616.695000000007
          ],
          [
            149.10819618,
            -35.4107288989999,
            616.528000000006
          ],
          [
            149.108172158,
            -35.410793784,
            616.373999999996
          ],
          [
            149.108131799,
            -35.41078377,
            616.596999999994
          ],
          [
            149.108155821,
            -35.4107188849999,
            616.695000000007
          ]
        ]
      ]
    ],
    "type": "MultiPolygon"
  }
}

json

application/json

deprecated

Maximum roof height

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/maximumRoofHeight

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the maximum height of the building’s roof.

They are used in solar potential calculation, line of sight modelling or visualization.

Links to further reading

Maximum roof height › path Parameters

buildingId

string · required

Maximum roof height › Responses

Success

buildingId

string · required

maximumRoofHeight

BuildingsV1_maximumRoofHeight · required

deprecated

Roof complexity

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/roofComplexity

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the pitch/complexity of the building’s roof.

Use it to inform quotations of services or risk and equipment needed before attending the site.

Links to further reading

Roof complexity › path Parameters

buildingId

string · required

Roof complexity › Responses

Successful

deprecated

Roof material

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/roofMaterial

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the material of the building’s roof.

Often necessary for quotations of services or risk and equipment needed before attending the site.

Links to further reading

Roof material › path Parameters

buildingId

string · required

Roof material › query Parameters

include

string

Defines a list of building attributes entered as a comma-seperated list. Defined attributues will be returned in the response if possible. New all parameter can be used to return all possible attributes more easily.

Roof material › Responses

Success

buildingId

string · required

roofMaterial

BuildingsV1_roofMaterial · required

The roofMaterial attribute is the name of the primary roof material found across the building surface.

Roof material is classified from image pixels that intersect the building. The image signature of the intersecting pixels is matched to a spectral library of known material compositions to determine the best matching material for each pixel.

Flat Concrete
Fiberglass/Plastic
Metal
Tile

This object will not be returned if we cannot decide on the roof material.

deprecated

Presence of swimming pool

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/swimmingPool

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the answer to the question does this building sit next to a swimming pool.

Applications built around the pool service industry can reduce the amount of time it takes to find customers or manage marketing campaigns. For local and state government, it helps detect homes that have pools for water sources in the event of fires.

Links to further reading

Presence of swimming pool › path Parameters

buildingId

string · required

Presence of swimming pool › Responses

Success

buildingId

string · required

swimmingPool

BuildingsV1_swimmingPool · required

deprecated

Zoning simplified

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/zonings

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return the simplified zonings relevant to the building based on state, territory or local government planning schemes.

The planning zone of a building is helpful for property developers, government planning services and insurance companies. It can flag opportunities or risks in those applications.

Links to further reading

Zoning simplified › path Parameters

buildingId

string · required

Zoning simplified › Responses

Success

buildingId

string · required

zonings

string[] · required

deprecated

Overhanging Tree

GET

https://api.psma.com.au

/v1/buildings/{buildingId}/overhangingTree

Authorization (header)

Deprecated

The prefered method is to use the include parameter. Find out how here

Intended use

Return an object with a boolean and the height of the overhanging tree in meters.

"Overhanging tree" helps identify risk to property or complexities with solar activity.

Links to further reading

Overhanging Tree › path Parameters

buildingId

string · required

Overhanging Tree › Responses

Success

buildingId

string · required

BuildingsV1_overhangingTree · required

Provides an attribute that describes whether an identified tree overhangs the building geometry.

The value true means a tree overhangs the building.
The value false means no tree overhanging the building.
An absent response means we have not determined if a tree overhangs the building.

Buildings v2.1 · Search Buildings v1 · Buildings