Administrative Boundaries v1 · Admin Bounds

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.

Find by point

GET

https://api.psma.com.au

/v1/administrativeBoundaries/findByPoint

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Return boundaries that intersect the supplied point.

Supply at least one layer
A layer with no result contributes no feature and adds Layer '{layer}' not found. to messages. The response remains 200, including when all layers have no result
Set excludeGeometry=true for attributes only. Geometry then contains coordinates: [null, null]

See Boundary Layers for values and identifier fields.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByPoint" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "latitude=-35.32556759" \
  --data-urlencode "longitude=149.149937769" \
  --data-urlencode "layers=localities,electoralBoundariesCommonwealth" \
  --data-urlencode "excludeGeometry=true"

Find by point › query Parameters

latitude

number · required

Latitude of the search point. Use decimal degrees for the default GDA94 input CRS.

longitude

number · required

Longitude of the search point. Use decimal degrees for the default GDA94 input CRS.

layers

string[] · minItems: 1 · required · style: form

One or more case-sensitive layer names in a single comma-separated query value, for example layers=localities,localGovernmentAreas. See Boundary Layers for meanings and primary identifiers.

Enum values:

localities

absBoundariesMeshBlock2016

absBoundariesMeshBlock2021

absBoundariesRemoteness2021

absBoundariesRemoteness2016

absBoundariesSeifa2021

electoralBoundariesState

localGovernmentAreas

excludeGeometry

boolean

Defaults to true: return attributes with sentinel geometry coordinates: [null, null]. Set false to request polygon coordinates. SEIFA has no polygon geometry.

Default: true

Find by point › Headers

accept-crs

string

Response CRS, expressed as an angle-bracketed CRS URI. Defaults to GDA94 (EPSG:4283). For multiple URIs, optional ;q= values set preference. See CRS & GDA2020, the OGC specification, and quality values.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Content-Crs

string

Input coordinate reference system as an angle-bracketed CRS URI. Defaults to GDA94 (EPSG:4283). See CRS & GDA2020.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find by point › Responses

Boundary FeatureCollection. Missing layers are reported in messages and can leave features empty.

type

string · required

array · required

messages

string[] · required

Information about requested layers with no returned features.

requestTimeStamp

number · required

Response time as Unix seconds.

requestDateTime

string · date-time · required

UTC response time.

required

Point lookup: [longitude, latitude] in the input CRS. Identifier lookup: the supplied identifier string.

attribution

string · required

Attribution text to retain when using the data.

GET/v1/administrativeBoundaries/findByPoint

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByPoint" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "latitude=-35.32556759" \
  --data-urlencode "longitude=149.149937769" \
  --data-urlencode "layers=localities,electoralBoundariesCommonwealth" \
  --data-urlencode "excludeGeometry=true"

Example Responses

{
  "features": [
    {
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                149.14993776900002,
                -35.325567590000006
              ],
              [
                149.14996591000002,
                -35.325562593
              ],
              [
                149.14999399500002,
                -35.325557388
              ],
              [
                149.15002202000002,
                -35.325551975
              ],
              [
                149.150049985,
                -35.325546355
              ],
              [
                149.150077887,
                -35.325540527
              ],
              [
                149.150105723,
                -35.325534493
              ],
              [
                149.150133492,
                -35.325528253
              ],
              [
                149.150161191,
                -35.325521808000005
              ],
              [
                149.15018881700001,
                -35.325515157000005
              ],
              [
                149.15021636900002,
                -35.325508303
              ],
              [
                149.15024384400002,
                -35.325501244
              ],
              [
                149.15027124000002,
                -35.325493981
              ],
              [
                149.150298555,
                -35.325486517
              ],
              [
                149.150325786,
                -35.32547885
              ],
              [
                149.150352932,
                -35.325470981
              ],
              [
                149.15037999,
                -35.325462912
              ],
              [
                149.150406957,
                -35.325454642000004
              ],
              [
                149.15043383300002,
                -35.325446173
              ],
              [
                149.150460613,
                -35.325437505000004
              ],
              [
                149.14993776900002,
                -35.325567590000006
              ]
            ]
          ]
        ]
      },
      "type": "Feature",
      "properties": {
        "layer": "locality",
        "dateCreated": "2022-03-11",
        "state": "ACT",
        "localityPolygonPid": "LOC4D979CF6E3C5",
        "localityPid": "LOC4D979CF6E3C5",
        "localityName": "GRIFFITH",
        "localityClass": "GAZETTED LOCALITY"
      }
    },
    {
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                149.104979988,
                -35.326768817
              ],
              [
                149.102170567,
                -35.328106254
              ],
              [
                149.101836614,
                -35.329991917
              ],
              [
                149.103844144,
                -35.330369419
              ],
              [
                149.104750826,
                -35.332274925
              ],
              [
                149.104353766,
                -35.333688912
              ],
              [
                149.104669177,
                -35.3384257119999
              ],
              [
                149.108960781,
                -35.3380599299999
              ],
              [
                149.109836107,
                -35.337264513
              ],
              [
                149.109102013,
                -35.3338499229999
              ],
              [
                149.111938841,
                -35.3318776479999
              ],
              [
                149.113171144,
                -35.331467812
              ],
              [
                149.116555017,
                -35.331286873
              ],
              [
                149.116096469,
                -35.3368904019999
              ],
              [
                149.127364122,
                -35.35181829
              ],
              [
                149.118950122,
                -35.359503447
              ],
              [
                149.125200281,
                -35.380480813
              ],
              [
                149.118535362,
                -35.382107854
              ],
              [
                149.104979988,
                -35.326768817
              ]
            ]
          ]
        ]
      },
      "type": "Feature",
      "properties": {
        "layer": "electoralBoundariesState",
        "dateCreated": "05/08/2019",
        "stateElectoralPolygonPid": "19",
        "stateElectoralPid": "ACT16",
        "stateElectoralName": "KURRAJONG",
        "dateGazetted": "08/07/2019",
        "effectiveStart": "11/09/2020",
        "statePid": "8",
        "stateElectoralClassCode": "2",
        "stateElectoralClassName": "Legislative Assembly",
        "stateElectoralClassDescription": "Jurisdiction Electoral Boundaries for the Legislative Assembly",
        "status": "effective"
      }
    },
    {
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                149.098612,
                -35.343853
              ],
              [
                149.100322,
                -35.348668
              ],
              [
                149.100405,
                -35.349258
              ],
              [
                149.102245,
                -35.350423
              ],
              [
                149.102652,
                -35.350284
              ],
              [
                149.10309,
                -35.350096
              ],
              [
                149.103488,
                -35.349886
              ],
              [
                149.103842,
                -35.34968
              ],
              [
                149.104002,
                -35.349587
              ],
              [
                149.105314,
                -35.348791
              ],
              [
                149.105439,
                -35.348716
              ],
              [
                149.10742,
                -35.347517
              ],
              [
                149.109315,
                -35.346368
              ],
              [
                149.098612,
                -35.343853
              ]
            ]
          ]
        ]
      },
      "type": "Feature",
      "properties": {
        "layer": "electoralBoundariesCommonwealth",
        "dateCreated": "2018-08-01",
        "dateRetired": "None",
        "commElectoralPolygonPid": "54",
        "commElectoralPid": "ACT3",
        "commElectoralName": "CANBERRA",
        "dateGazetted": "2018-07-13",
        "statePid": "8",
        "redistributionYear": 2018
      }
    }
  ],
  "query": [
    149.149937769,
    -35.32556759
  ],
  "type": "FeatureCollection",
  "requestTimeStamp": 1667975321.232327,
  "requestDateTime": "2022-11-09T06:28:41.232327",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)",
  "messages": [
    "Layer 'localGovernmentAreas' not found."
  ]
}

json

This is an example of Multiple Feature Types

application/json

Find by identifier

GET

https://api.psma.com.au

/v1/administrativeBoundaries/findByIdentifier

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Return boundaries matching a case-sensitive primary feature PID. Use the primary PID, not a polygon PID. A feature can return several polygons.

Supply at least one layer
A layer with no result contributes no feature and adds Layer '{layer}' not found. to messages. The response remains 200, including when all layers have no result
Set excludeGeometry=true for attributes only. Geometry then contains coordinates: [null, null]

See Boundary Layers for values and identifier fields.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByIdentifier" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "identifier=LOC4D979CF6E3C5" \
  --data-urlencode "layers=localities" \
  --data-urlencode "excludeGeometry=false"

Find by identifier › query Parameters

layers

string[] · minItems: 1 · required · style: form

One or more case-sensitive layer names in a single comma-separated query value, for example layers=localities,localGovernmentAreas. See Boundary Layers for meanings and primary identifiers.

Enum values:

localities

absBoundariesMeshBlock2016

absBoundariesMeshBlock2021

absBoundariesRemoteness2021

absBoundariesRemoteness2016

absBoundariesSeifa2021

electoralBoundariesState

localGovernmentAreas

identifier

string · required

Case-sensitive primary feature PID from a returned boundary. See Boundary Layers for the field for each layer.

excludeGeometry

boolean

Defaults to true: return attributes with sentinel geometry coordinates: [null, null]. Set false to request polygon coordinates. SEIFA has no polygon geometry.

Default: true

Find by identifier › Headers

accept-crs

string

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find by identifier › Responses

Boundary FeatureCollection for the supplied primary feature PID. Missing layers are reported in messages.

type

string · required

array · required

messages

string[] · required

Information about requested layers with no returned features.

requestTimeStamp

number · required

Response time as Unix seconds.

requestDateTime

string · date-time · required

UTC response time.

string · required

Point lookup: [longitude, latitude] in the input CRS. Identifier lookup: the supplied identifier string.

attribution

string · required

Attribution text to retain when using the data.

GET/v1/administrativeBoundaries/findByIdentifier

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByIdentifier" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "identifier=LOC4D979CF6E3C5" \
  --data-urlencode "layers=localities" \
  --data-urlencode "excludeGeometry=false"

Example Responses

{
  "features": [
    {
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                149.14993776900002,
                -35.325567590000006
              ],
              [
                149.14996591000002,
                -35.325562593
              ],
              [
                149.14999399500002,
                -35.325557388
              ],
              [
                149.15002202000002,
                -35.325551975
              ],
              [
                149.150049985,
                -35.325546355
              ],
              [
                149.150077887,
                -35.325540527
              ],
              [
                149.150105723,
                -35.325534493
              ],
              [
                149.150133492,
                -35.325528253
              ],
              [
                149.150161191,
                -35.325521808000005
              ],
              [
                149.15018881700001,
                -35.325515157000005
              ],
              [
                149.15021636900002,
                -35.325508303
              ],
              [
                149.15024384400002,
                -35.325501244
              ],
              [
                149.15027124000002,
                -35.325493981
              ],
              [
                149.150298555,
                -35.325486517
              ],
              [
                149.150325786,
                -35.32547885
              ],
              [
                149.150352932,
                -35.325470981
              ],
              [
                149.15037999,
                -35.325462912
              ],
              [
                149.150406957,
                -35.325454642000004
              ],
              [
                149.15043383300002,
                -35.325446173
              ],
              [
                149.150460613,
                -35.325437505000004
              ],
              [
                149.14993776900002,
                -35.325567590000006
              ]
            ]
          ]
        ]
      },
      "type": "Feature",
      "properties": {
        "layer": "locality",
        "dateCreated": "2022-03-11",
        "state": "ACT",
        "localityPolygonPid": "LOC4D979CF6E3C5",
        "localityPid": "LOC4D979CF6E3C5",
        "localityName": "GRIFFITH",
        "localityClass": "GAZETTED LOCALITY"
      }
    }
  ],
  "query": "LOC4D979CF6E3C5",
  "type": "FeatureCollection",
  "requestTimeStamp": 1667975321.232327,
  "requestDateTime": "2022-11-09T06:28:41.232327",
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)",
  "messages": []
}

json

application/json

Addresses v1 · Search Batches v1 · Batches

Find by point

GET

https://api.psma.com.au

/v1/administrativeBoundaries/findByPoint

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Return boundaries that intersect the supplied point.

Supply at least one layer
A layer with no result contributes no feature and adds Layer '{layer}' not found. to messages. The response remains 200, including when all layers have no result
Set excludeGeometry=true for attributes only. Geometry then contains coordinates: [null, null]

See Boundary Layers for values and identifier fields.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByPoint" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "latitude=-35.32556759" \
  --data-urlencode "longitude=149.149937769" \
  --data-urlencode "layers=localities,electoralBoundariesCommonwealth" \
  --data-urlencode "excludeGeometry=true"

Find by point › query Parameters

latitude

number · required

Latitude of the search point. Use decimal degrees for the default GDA94 input CRS.

longitude

number · required

Longitude of the search point. Use decimal degrees for the default GDA94 input CRS.

layers

string[] · minItems: 1 · required · style: form

One or more case-sensitive layer names in a single comma-separated query value, for example layers=localities,localGovernmentAreas. See Boundary Layers for meanings and primary identifiers.

Enum values:

localities

absBoundariesMeshBlock2016

absBoundariesMeshBlock2021

absBoundariesRemoteness2021

absBoundariesRemoteness2016

absBoundariesSeifa2021

electoralBoundariesState

localGovernmentAreas

excludeGeometry

boolean

Defaults to true: return attributes with sentinel geometry coordinates: [null, null]. Set false to request polygon coordinates. SEIFA has no polygon geometry.

Default: true

Find by point › Headers

accept-crs

string

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Content-Crs

string

Input coordinate reference system as an angle-bracketed CRS URI. Defaults to GDA94 (EPSG:4283). See CRS & GDA2020.

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find by point › Responses

Boundary FeatureCollection. Missing layers are reported in messages and can leave features empty.

type

string · required

array · required

messages

string[] · required

Information about requested layers with no returned features.

requestTimeStamp

number · required

Response time as Unix seconds.

requestDateTime

string · date-time · required

UTC response time.

required

Point lookup: [longitude, latitude] in the input CRS. Identifier lookup: the supplied identifier string.

attribution

string · required

Attribution text to retain when using the data.

Find by identifier

GET

https://api.psma.com.au

/v1/administrativeBoundaries/findByIdentifier

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Return boundaries matching a case-sensitive primary feature PID. Use the primary PID, not a polygon PID. A feature can return several polygons.

Supply at least one layer
A layer with no result contributes no feature and adds Layer '{layer}' not found. to messages. The response remains 200, including when all layers have no result
Set excludeGeometry=true for attributes only. Geometry then contains coordinates: [null, null]

See Boundary Layers for values and identifier fields.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/administrativeBoundaries/findByIdentifier" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "identifier=LOC4D979CF6E3C5" \
  --data-urlencode "layers=localities" \
  --data-urlencode "excludeGeometry=false"

Find by identifier › query Parameters

layers

string[] · minItems: 1 · required · style: form

One or more case-sensitive layer names in a single comma-separated query value, for example layers=localities,localGovernmentAreas. See Boundary Layers for meanings and primary identifiers.

Enum values:

localities

absBoundariesMeshBlock2016

absBoundariesMeshBlock2021

absBoundariesRemoteness2021

absBoundariesRemoteness2016

absBoundariesSeifa2021

electoralBoundariesState

localGovernmentAreas

identifier

string · required

Case-sensitive primary feature PID from a returned boundary. See Boundary Layers for the field for each layer.

excludeGeometry

boolean

Defaults to true: return attributes with sentinel geometry coordinates: [null, null]. Set false to request polygon coordinates. SEIFA has no polygon geometry.

Default: true

Find by identifier › Headers

accept-crs

string

Default: <https://www.opengis.net/def/crs/EPSG/0/4283>

Find by identifier › Responses

Boundary FeatureCollection for the supplied primary feature PID. Missing layers are reported in messages.

type

string · required

array · required

messages

string[] · required

Information about requested layers with no returned features.

requestTimeStamp

number · required

Response time as Unix seconds.

requestDateTime

string · date-time · required

UTC response time.

string · required

Point lookup: [longitude, latitude] in the input CRS. Identifier lookup: the supplied identifier string.

attribution

string · required

Attribution text to retain when using the data.