The SEED API lets you access SEED environmental data without using website search.
What is metadata?
Metadata is information about each dataset in SEED. It describes when, how, why data was collected and published, any limitations on its use, and how often it is updated.
It follows a common set of terminology and standards so you can compare and categorise datasets.
Learn more about SEED metadata at About metadata statements.
What is the SEED API?
An API (or application programming interface) is a type of digital messenger that allows apps and computer programs to communicate and share information with each other.
The SEED API helps you search SEED's database of environmental datasets and get the answer back in a format your tools or code can use.
The SEED API can:
- Search for datasets by keyword, topic, organisation or tag (for example, search for all datasets tagged 'water quality').
- Get a list of all datasets in a specific category or organisation.
- Find detailed metadata for a specific dataset (its description, publisher, format, and resources).
- Share a list of recently updated datasets.
Use the SEED API when:
- You’re searching or filtering large amounts of data quickly.
- You need to build a tool, dashboard or system that pulls SEED data automatically.
- You need metadata from many datasets at once.
- Data needs to be a format other software can read, like JSON.
How to access metadata with the SEED API
Before you begin
- Some SEED API functions are public for immediate use, while others need an API key.
- You’ll need a web browser tool, like Postman, or a coding language like Python that can send web requests.
Build your request URL
- Always start with this base address: https://datasets.seed.nsw.gov.au/api/action/.
- Add the name of the function you want to use at the end (such as ‘package_search’ to search for datasets).
Add your parameters (search terms or filters)
- After the function name add ‘?’, then your search terms (such as ‘?q=water’ to search for datasets about water).
- You can filter by organisation, tag or limit how many results come back.
Send the request
- Copy and paste the full URL into your browser, or send it using your tool or code.
- SEED will send back a structured list of results in JSON format.
Review the response
- Responses will include a ‘success’ field:
- ‘True’ means your request worked.
- ‘False’ means there’s an error. Check your URL and try again.
- If successful, you’ll see a ‘result’ section with the requested metadata.
- Each dataset includes metadata or name, title, description, tags, organisation and available resources.
Quick reference
| ‘package_search’ | search for datasets by keyword |
| ‘package_show’ | get full metadata for one specific dataset |
| ‘package_list’ | get a list of all datasets |
| ‘organisation_list’ | see all organisations publishing data on SEED |
| ‘tag_list’ | see all tags used to categorise datasets |
| ‘400’ error | usually means something in your URL is wrong. Check your spelling and parameters |
| ‘403’ error | means you need to be logged in or have an API key |