Datasets v1.1 · Datasets

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.

List datasets

GET

https://api.psma.com.au

/v1/datasets

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

List published datasets and optionally filter or search them. Listing a dataset does not grant download access.

Combine filters to narrow the search
No matches returns 200 with datasets: [] and a No datasets found message
Follow links.next for subsequent pages

See Finding Datasets for values, release selection, and pagination. See Products and Versions for includeChildProducts.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "product=G-NAF" \
  --data-urlencode "release=latest" \
  --data-urlencode "limit=100"

List datasets › query Parameters

product

string[] · style: form

Product codes as one comma-separated value, for example product=G-NAF,G-NAF CORE. Case-insensitive. See Finding Datasets for values.

Enum values:

ABS BOUNDARIES

ABS-ASGS-2026-MAIN-STRUCTURE

ADMINISTRATIVE BOUNDARIES

ELECTORAL BOUNDARIES

G-NAF CORE

G-NAF

GEOSCAPE AIRPORTS

GEOSCAPE BUILDINGS

region

string[] · style: form

No region filter is applied when omitted. Dataset region values as one comma-separated value. Case-insensitive. See Finding Datasets for values.

Enum values:

AUSTRALIA

ALL STATES

ACTNSW

ACT

NSW

QLD

datum

string[] · style: form

Dataset datums as one comma-separated value, for example datum=GDA94,GDA2020. Case-insensitive. Selects existing files rather than transforming their coordinates. See Finding Datasets.

Enum values:

GDA94

GDA2020

NO DATUM

release

string

No release filter is applied when omitted. Release month as YYYY-MM, an inclusive range YYYY-MM,YYYY-MM, or lowercase latest. See Finding Datasets for grouping.

format

string[] · style: form

No format filter is applied when omitted. Dataset format values as one comma-separated value. Case-insensitive. See Finding Datasets for values.

Enum values:

GDB

GEOJSON

SHP

TAB

LYNX

PUMP

GEOTIFF

PSV

limit

integer · min: 1 · max: 1000

Maximum datasets per page. Defaults to 100 and accepts 1 to 1,000.

Default: 100

offset

integer · min: 0

Number of matching datasets to skip. Defaults to 0. Follow the returned links for pagination.

Default: 0

licenced

boolean

Set true to return only datasets covered by your agreement. Defaults to false, which applies no licence filter. Download permission is checked separately.

Default: false

query

string

Free-text search combined with the other filters.

includeChildProducts

boolean

Include datasets whose parentProduct matches the product filter when true (default). False selects directly matching products. Without a product filter, false excludes all child products. See Products and Versions.

Default: true

List datasets › Responses

Matching datasets and pagination links.

DatasetsV11_dataset.yaml[] · required

DatasetsV11_links.yaml · required

Pagination counts and links for a dataset listing. Follow next while present, using the same Authorization header.

Example: {"numberMatched":18,"numberReturned":2,"self":"/v1/datasets?product=G-NAF&datum=GDA2020&limit=2&offset=5","next":"/v1/datasets?product=G-NAF&datum=GDA2020&limit=2&offset=7","prev":"/v1/datasets?product=G-NAF&datum=GDA2020&limit=2&offset=3"}

messages

string[] · required

Result information. No matches uses No datasets found.

attribution

DatasetsV11_attribution.yaml · required

Mandatory legal text asserting copyright and directing the user to the specific Terms and Conditions governing the use of the data.

GET/v1/datasets

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "product=G-NAF" \
  --data-urlencode "release=latest" \
  --data-urlencode "limit=100"

Example Responses

{
  "datasets": [
    {
      "name": "G-NAF",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-001",
      "size": 1024,
      "status": "published",
      "licenced": true
    },
    {
      "name": "G-NAF Core",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF CORE",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-002",
      "size": 1024,
      "status": "published",
      "licenced": true
    }
  ],
  "links": {
    "numberMatched": 2,
    "numberReturned": 2,
    "self": "/v1/datasets?product=G-NAF,G-NAF%20CORE&limit=100&offset=0"
  },
  "messages": [],
  "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/)"
}

json

application/json

Get dataset download

GET

https://api.psma.com.au

/v1/datasets/{datasetId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve metadata and a signed download link for one licensed dataset. Your agreement must cover its product, region, and release.

Copy datasetId from a listing. It is an opaque identifier, not necessarily a UUID
The JSON response contains a one-item datasets array. Download the file from datasets[0].downloadLink
Links expire after 15 minutes. Request a fresh link when needed

See Finding Datasets for file retrieval and error handling.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/example-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Get dataset download › path Parameters

datasetId

string · required

One dataset ID from the matching standard or custom listing. Keep its casing.

Get dataset download › Responses

Metadata and a download link for one dataset.

DatasetsV11_datasetWithDownload.yaml[] · required

messages

string[] · required

Result information. No matches uses No datasets found.

attribution

DatasetsV11_attribution.yaml · required

Mandatory legal text asserting copyright and directing the user to the specific Terms and Conditions governing the use of the data.

GET/v1/datasets/{datasetId}

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/example-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "datasets": [
    {
      "name": "G-NAF",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-001",
      "size": 1024,
      "status": "published",
      "licenced": true,
      "downloadLink": "https://example.com/datasets/example.zip"
    }
  ],
  "messages": [],
  "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/)"
}

json

application/json

Datasets v1.1 · Custom Datasets Land Parcels v1 · cadastre

Geoscape API

Datasets v1.1 · Datasets

Download schema

List datasets

GET

https://api.psma.com.au

/v1/datasets

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

List published datasets and optionally filter or search them. Listing a dataset does not grant download access.

Combine filters to narrow the search
No matches returns 200 with datasets: [] and a No datasets found message
Follow links.next for subsequent pages

See Finding Datasets for values, release selection, and pagination. See Products and Versions for includeChildProducts.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "product=G-NAF" \
  --data-urlencode "release=latest" \
  --data-urlencode "limit=100"

List datasets › query Parameters

product

string[] · style: form

Product codes as one comma-separated value, for example product=G-NAF,G-NAF CORE. Case-insensitive. See Finding Datasets for values.

Enum values:

ABS BOUNDARIES

ABS-ASGS-2026-MAIN-STRUCTURE

ADMINISTRATIVE BOUNDARIES

ELECTORAL BOUNDARIES

G-NAF CORE

G-NAF

GEOSCAPE AIRPORTS

GEOSCAPE BUILDINGS

region

string[] · style: form

No region filter is applied when omitted. Dataset region values as one comma-separated value. Case-insensitive. See Finding Datasets for values.

Enum values:

AUSTRALIA

ALL STATES

ACTNSW

ACT

NSW

QLD

datum

string[] · style: form

Dataset datums as one comma-separated value, for example datum=GDA94,GDA2020. Case-insensitive. Selects existing files rather than transforming their coordinates. See Finding Datasets.

Enum values:

GDA94

GDA2020

NO DATUM

release

string

No release filter is applied when omitted. Release month as YYYY-MM, an inclusive range YYYY-MM,YYYY-MM, or lowercase latest. See Finding Datasets for grouping.

format

string[] · style: form

No format filter is applied when omitted. Dataset format values as one comma-separated value. Case-insensitive. See Finding Datasets for values.

Enum values:

GDB

GEOJSON

SHP

TAB

LYNX

PUMP

GEOTIFF

PSV

limit

integer · min: 1 · max: 1000

Maximum datasets per page. Defaults to 100 and accepts 1 to 1,000.

Default: 100

offset

integer · min: 0

Number of matching datasets to skip. Defaults to 0. Follow the returned links for pagination.

Default: 0

licenced

boolean

Set true to return only datasets covered by your agreement. Defaults to false, which applies no licence filter. Download permission is checked separately.

Default: false

query

string

Free-text search combined with the other filters.

includeChildProducts

boolean

Default: true

List datasets › Responses

Matching datasets and pagination links.

DatasetsV11_dataset.yaml[] · required

DatasetsV11_links.yaml · required

Pagination counts and links for a dataset listing. Follow next while present, using the same Authorization header.

messages

string[] · required

Result information. No matches uses No datasets found.

attribution

DatasetsV11_attribution.yaml · required

Mandatory legal text asserting copyright and directing the user to the specific Terms and Conditions governing the use of the data.

GET/v1/datasets

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "product=G-NAF" \
  --data-urlencode "release=latest" \
  --data-urlencode "limit=100"

Example Responses

{
  "datasets": [
    {
      "name": "G-NAF",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-001",
      "size": 1024,
      "status": "published",
      "licenced": true
    },
    {
      "name": "G-NAF Core",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF CORE",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-002",
      "size": 1024,
      "status": "published",
      "licenced": true
    }
  ],
  "links": {
    "numberMatched": 2,
    "numberReturned": 2,
    "self": "/v1/datasets?product=G-NAF,G-NAF%20CORE&limit=100&offset=0"
  },
  "messages": [],
  "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/)"
}

json

application/json

Get dataset download

GET

https://api.psma.com.au

/v1/datasets/{datasetId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve metadata and a signed download link for one licensed dataset. Your agreement must cover its product, region, and release.

Copy datasetId from a listing. It is an opaque identifier, not necessarily a UUID
The JSON response contains a one-item datasets array. Download the file from datasets[0].downloadLink
Links expire after 15 minutes. Request a fresh link when needed

See Finding Datasets for file retrieval and error handling.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/example-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Get dataset download › path Parameters

datasetId

string · required

One dataset ID from the matching standard or custom listing. Keep its casing.

Get dataset download › Responses

Metadata and a download link for one dataset.

DatasetsV11_datasetWithDownload.yaml[] · required

messages

string[] · required

Result information. No matches uses No datasets found.

attribution

DatasetsV11_attribution.yaml · required

Mandatory legal text asserting copyright and directing the user to the specific Terms and Conditions governing the use of the data.

GET/v1/datasets/{datasetId}

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/example-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Example Responses

{
  "datasets": [
    {
      "name": "G-NAF",
      "description": "Illustrative dataset metadata. This example does not identify a real file.",
      "product": "G-NAF",
      "region": "AUSTRALIA",
      "format": "PSV",
      "release": "2025-03",
      "datum": "GDA2020",
      "publishDate": "2025-03-31",
      "version": 1,
      "versionString": "1",
      "classification": "STANDARD",
      "id": "example-dataset-001",
      "size": 1024,
      "status": "published",
      "licenced": true,
      "downloadLink": "https://example.com/datasets/example.zip"
    }
  ],
  "messages": [],
  "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/)"
}

json

application/json

Datasets v1.1 · Custom Datasets Land Parcels v1 · cadastre