Buildings v2.1 · Search
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.
Find by identifier
Authentication: Use your Consumer Key in the
Authorizationheader.
Find buildings linked to an address, property, or cadastral parcel.
- Supply exactly one of
addressId,propertyPid, orcadastrePid. - Use
limitandoffsetto page through results. - A search with no matching buildings returns
404. - Use a Geoscape Hub application with Buildings API access and premium-data permission. Returned buildings consume credits.
query Parameters
addressIdAddress identifier from the Addresses API or a building-address relationship. Supply exactly one of addressId, propertyPid, or cadastrePid.
propertyPidGeoscape property identifier. Supply exactly one of addressId, propertyPid, or cadastrePid.
cadastrePidGeoscape cadastral parcel identifier. Supply exactly one of addressId, propertyPid, or cadastrePid.
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.
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
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.
Find by identifier › 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.
Find by point
Authentication: Use your Consumer Key in the
Authorizationheader.
Find building footprints that intersect a point or a search circle. Supply both latitude and longitude in GDA94 (EPSG:4283).
- Omit
radiusto search the point itself. Supply 1 to 500 metres to search a circle. - Results are intersections, not a nearest-building ranking.
- Use
limitandoffsetto page through results. No matching buildings returns404. - Use
Accept-Crsto choose the response CRS. It does not change the input coordinates. - Use a Geoscape Hub application with Buildings API access and premium-data permission. Returned buildings consume credits.
query Parameters
latitudeLatitude of the search point in GDA94 (EPSG:4283). Valid values are -45 to -8 (inclusive).
longitudeLongitude of the search point in GDA94 (EPSG:4283). Valid values are 96 to 168 (inclusive).
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.
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
radiusSearch radius in metres. Supply an integer from 1 to 500. Omit to search building footprints intersecting the point. Results intersect the search circle and are not ranked by distance.
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.
Find by point › 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.
Find by bounding box
Authentication: Use your Consumer Key in the
Authorizationheader.
Find building footprints that intersect a rectangular extent.
- Supply
bboxas bottom-left longitude, bottom-left latitude, top-right longitude, top-right latitude. - Use
limitandoffsetto page through results. No matching buildings returns404. - Use
Accept-Crsto choose the response CRS. See spatial search guidance for coordinate order and an example. - Use a Geoscape Hub application with Buildings API access and premium-data permission. Returned buildings consume credits.
query Parameters
bboxSearch extent as minLongitude,minLatitude,maxLongitude,maxLatitude, for example 149.12047,-35.28707,149.13689,-35.27529. Use distinct bottom-left and top-right corners in longitude, latitude order within Australian bounds (longitude 96 to 168, latitude -45 to -8). URL-encode the query value.
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.
limitMaximum records per page. Follow links.next for the next page. Defaults to 100.
offsetNumber of matching records to skip. Defaults to 0.
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.
Find by bounding box › 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.