Buildings v2.1 · Building
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.
Building Feature
Authentication: Use your Consumer Key in the
Authorizationheader.
Retrieve a building footprint and base attributes by its buildingPid. The response is a GeoJSON FeatureCollection served as application/json.
- Use
additionalPropertiesfor height, roof, solar, or legacy attributes. - Handle an unknown identifier as
404. - Use a Geoscape Hub application with Buildings API access and a plan that permits premium data. Returned buildings consume credits. See Additional Properties.
path Parameters
buildingPidPersistent building identifier from a Buildings API result (properties.buildingPid).
query Parameters
additionalPropertiesOptional related attributes. Send one comma-separated query value, for example additionalProperties=height,roof. Omit to return base building attributes only. Values are case-sensitive.
Requested data may be omitted when unavailable. Additional data can add credit costs. See Additional Properties for values, returned fields, availability, and costs.
Headers
Accept-CrsResponse coordinate reference system. Send an angle-bracketed CRS URI. Defaults to GDA94 (EPSG:4283).
Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). Optional ;q= values set preference when sending multiple URIs. See CRS & GDA2020, the OGC specification, and quality values.
Building Feature › Responses
GeoJSON building FeatureCollection served as application/json. Get-by-ID and searches with no matching buildings return 404.
typetotalAreaSum of building areas in this response page, in square metres. This is not the area of every matched building across all pages.
Buildings returned in this page. A page can be empty when the offset is beyond existing matches.
messagesSupplementary request information, including pagination warnings. May accompany a successful response.
requestTimeStampRequest time in seconds since the Unix epoch, including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionPagination counts and relative URLs for search endpoints. Absent from get-by-ID responses. Follow next against https://api.psma.com.au while present.
Building Addresses
Authentication: Use your Consumer Key in the
Authorizationheader.
Retrieve records linking a building to addresses. Use each record's identifier to retrieve full details from the corresponding API.
- Use
limitandoffsetto page throughrecords. - No relationships returns
200with an emptyrecordsarray. This response does not establish whether the building exists. - These records describe relationships, not building footprints or full related features.
- Use a Geoscape Hub application with Buildings API access and premium-data permission.
path Parameters
buildingPidPersistent building identifier from a Buildings API result (properties.buildingPid).
query Parameters
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
Building Addresses › Responses
JSON relationship records with pagination. No relationships returns 200 with records: [].
Relationship records for this page, or an empty array when none are found.
requestTimeStampRequest time in seconds since the Unix epoch, including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionPagination counts and relative page URLs. Resolve URLs against https://api.psma.com.au.
Building Cadastre
Authentication: Use your Consumer Key in the
Authorizationheader.
Retrieve records linking a building to cadastral parcels. Use each record's identifier to retrieve full details from the corresponding API.
- Use
limitandoffsetto page throughrecords. - No relationships returns
200with an emptyrecordsarray. This response does not establish whether the building exists. - These records describe relationships, not building footprints or full related features.
- Use a Geoscape Hub application with Buildings API access and premium-data permission.
path Parameters
buildingPidPersistent building identifier from a Buildings API result (properties.buildingPid).
query Parameters
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
Building Cadastre › Responses
JSON relationship records with pagination. No relationships returns 200 with records: [].
Relationship records for this page, or an empty array when none are found.
requestTimeStampRequest time in seconds since the Unix epoch, including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionPagination counts and relative page URLs. Resolve URLs against https://api.psma.com.au.
Building Properties
Authentication: Use your Consumer Key in the
Authorizationheader.
Retrieve records linking a building to properties. Use each record's identifier to retrieve full details from the corresponding API.
- Use
limitandoffsetto page throughrecords. - No relationships returns
200with an emptyrecordsarray. This response does not establish whether the building exists. - These records describe relationships, not building footprints or full related features.
- Use a Geoscape Hub application with Buildings API access and premium-data permission.
path Parameters
buildingPidPersistent building identifier from a Buildings API result (properties.buildingPid).
query Parameters
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
Building Properties › Responses
JSON relationship records with pagination. No relationships returns 200 with records: [].
Relationship records for this page, or an empty array when none are found.
requestTimeStampRequest time in seconds since the Unix epoch, including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionPagination counts and relative page URLs. Resolve URLs against https://api.psma.com.au.