Datasets API
Use this page to choose a dataset search or download workflow, check access requirements, and find guidance on releases and product versions.
When to use this API
List and search published Geoscape datasets, find custom datasets supplied to your organisation, and retrieve download links for bulk files.
Start with the Datasets Quickstart to find a licensed dataset, request a download link, and retrieve its file.
| You want to… | Use |
|---|---|
| Find published datasets | List datasets |
| Request a published dataset's download link | Get dataset download |
| Find datasets supplied to your organisation | List custom datasets |
| Request a custom dataset's download link | Get custom dataset download |
Access: Use a Geoscape Hub application with Datasets API access. Listing and searching are free. Downloading a licensed dataset requires an Enterprise Agreement covering its product, region, and release. Contact +61 2 6260 9000 or sales@geoscape.com.au for licensed dataset access.
Send its Consumer Key directly in the Authorization header. See Authentication for application and tester setup.
Responses
- Check product, region, format, datum, release, and version metadata before selecting a file
- Follow
links.nextwhen another page of matching datasets is available - Download links expire. Request a fresh link when needed and do not send your Consumer Key to the storage URL
- Response examples use synthetic metadata. Example IDs and download URLs do not identify real files
Further guidance
- Finding Datasets: choose filters and releases, page through results, and download files
- Products and Versions: understand product families and versions
- Error Handling and Rate Limiting: handle API failures and download errors
Versions
| Version | Reference |
|---|---|
| v1.1 (current) | Endpoint reference |