Datasets v1.1 · Custom 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 custom datasets

GET

https://api.psma.com.au

/v1/datasets/custom

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

List published custom datasets available to your organisation. Results exclude expired custom datasets.

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.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/custom" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "query=localities"

List custom datasets › query Parameters

release

string

Release month as YYYY-MM, an inclusive range YYYY-MM,YYYY-MM, or lowercase latest. See Finding Datasets for grouping.

product

string[] · style: form

Exact custom product names as one comma-separated value. Preserve the supplied casing. These names are specific to your organisation.

query

string

Free-text search combined with the other filters.

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

List custom datasets › Responses

Matching datasets and pagination links.

DatasetsV11_customDataset.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.

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"}

GET/v1/datasets/custom

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/custom" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "query=localities"

Example Responses

{
  "datasets": [
    {
      "id": "example-custom-dataset-001",
      "name": "Locality boundaries",
      "region": "AUSTRALIA",
      "format": "GEOJSON",
      "release": "2025-03",
      "datum": "GDA2020",
      "version": "1",
      "size": 1024,
      "publishDate": "2025-03-31"
    }
  ],
  "messages": [],
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)",
  "links": {
    "numberMatched": 1,
    "numberReturned": 1,
    "self": "/v1/datasets/custom?limit=100&offset=0"
  }
}

json

application/json

Get custom dataset download

GET

https://api.psma.com.au

/v1/datasets/custom/{datasetId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve metadata and a signed download link for one custom dataset supplied to your organisation.

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/custom/example-custom-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Get custom dataset download › path Parameters

datasetId

string · required

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

Get custom dataset download › Responses

Metadata and a download link for one dataset.

DatasetsV11_customDataset.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/custom/{datasetId}

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

Example Responses

{
  "datasets": [
    {
      "id": "example-custom-dataset-001",
      "name": "Locality boundaries",
      "region": "AUSTRALIA",
      "format": "GEOJSON",
      "release": "2025-03",
      "datum": "GDA2020",
      "version": "1",
      "size": 1024,
      "publishDate": "2025-03-31",
      "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://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)"
}

json

application/json

Buildings v1 · Search Datasets v1.1 · Datasets

Geoscape API

Datasets v1.1 · Custom Datasets

Download schema

List custom datasets

GET

https://api.psma.com.au

/v1/datasets/custom

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

List published custom datasets available to your organisation. Results exclude expired custom datasets.

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.

Code
curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/custom" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "query=localities"

List custom datasets › query Parameters

release

string

Release month as YYYY-MM, an inclusive range YYYY-MM,YYYY-MM, or lowercase latest. See Finding Datasets for grouping.

product

string[] · style: form

Exact custom product names as one comma-separated value. Preserve the supplied casing. These names are specific to your organisation.

query

string

Free-text search combined with the other filters.

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

List custom datasets › Responses

Matching datasets and pagination links.

DatasetsV11_customDataset.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.

DatasetsV11_links.yaml · required

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

GET/v1/datasets/custom

curl --fail-with-body --get \
  "https://api.psma.com.au/v1/datasets/custom" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json" \
  --data-urlencode "query=localities"

Example Responses

{
  "datasets": [
    {
      "id": "example-custom-dataset-001",
      "name": "Locality boundaries",
      "region": "AUSTRALIA",
      "format": "GEOJSON",
      "release": "2025-03",
      "datum": "GDA2020",
      "version": "1",
      "size": 1024,
      "publishDate": "2025-03-31"
    }
  ],
  "messages": [],
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Developer Terms and Conditions (https://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)",
  "links": {
    "numberMatched": 1,
    "numberReturned": 1,
    "self": "/v1/datasets/custom?limit=100&offset=0"
  }
}

json

application/json

Get custom dataset download

GET

https://api.psma.com.au

/v1/datasets/custom/{datasetId}

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve metadata and a signed download link for one custom dataset supplied to your organisation.

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/custom/example-custom-dataset-001" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Accept: application/json"

Get custom dataset download › path Parameters

datasetId

string · required

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

Get custom dataset download › Responses

Metadata and a download link for one dataset.

DatasetsV11_customDataset.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/custom/{datasetId}

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

Example Responses

{
  "datasets": [
    {
      "id": "example-custom-dataset-001",
      "name": "Locality boundaries",
      "region": "AUSTRALIA",
      "format": "GEOJSON",
      "release": "2025-03",
      "datum": "GDA2020",
      "version": "1",
      "size": 1024,
      "publishDate": "2025-03-31",
      "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://developer.geoscape.com.au/legal). Data is subject to copyright (https://geoscape.com.au/legal/data-copyright-and-disclaimer/)"
}

json

application/json

Buildings v1 · Search Datasets v1.1 · Datasets