BioNet Web Service
NSW BioNet's Open Application Programming Interface (API) allows organisations and individuals to directly integrate biodiversity data from BioNet into their software systems and operations ensuring environmental decisions are based on up to date, consistent and reliable biodiversity data. The BioNet read-only API was developed under the NSW Government Open Government initiative to unlock the innovation potential of the valuable BioNet data asset. Its ongoing development aligns with the NSW Digital Strategy.
What data is available from the BioNet Web Service API?
Data made available through the BioNet Web Service is the same as that available through other BioNet applications. However, data from some fields are not yet available this way and must be accessed using the BioNet Atlas or BioNet Vegetation Classification user interfaces.
The following BioNet data collections are available in BioNet Web Service API Release 4.0.2:
- Species Sightings
- Systematic Flora Survey
- Vegetation Classification
- NSW Landscapes
- Threatened Biodiversity
- Species Names
It also includes a thesaurus service for IT developers to enhance search functionality in software apps.
For more detailed information about the capabilities and features of the BioNet Web Service API, read the release notes:
- 4.0.2 addendum release notes
- 4.0.2 release notes
- 3.4 Release notes
- 3.3 Release notes
- 3.2 Release notes
- 3.1 Release notes
- 3.0 Release notes
- 2.0 Release notes
- 1.1 Release notes (PDF 382KB)
Published standards
Data is shared according to published standards which provide information on the field names, definitions, formats and any restrictions that might apply to specific fields:
- Flora Survey Data Standard
- NSW Landscapes Data Standard
- Species Names Data Standard
- Species Sightings Data Standard
- Thesaurus Data Standard
- Threatened Biodiversity Data Standard
- Vegetation Classification Data Standard
Accessing data via the BioNet Web Service as a non-developer
The BioNet Web Service offers a quick and convenient way to access BioNet data for everyone. No developer skills are required. Users can access our pre-made power queries or learn to create their own.
Data made available through the BioNet Web Service is the same as that available through other BioNet applications. However, note that data from some fields are not available this way and must be accessed using the BioNet Atlas or BioNet Vegetation Classification user interfaces.
If you have a need to create customised downloads, there are a number of desktop applications that support our API. A list of some of the tools available can be found at OData.org Ecosystem.
A quick guide for users of Microsoft Excel 2010 is available at BioNet Web Service Power Query quick guide.
The BioNet team has prepared a series of power queries relating to frequently accessed BioNet data. They are available from the NSW BioNet resources webpage.
Open the 'Power queries' subheadings under relevant data collections to download these refreshable power queries.
BioNet Web Service API for IT developers
To help reduce the development work needed to integrate BioNet data, we chose an open global API standard (OASIS Open Data Protocol (OData) Version 4.0).
To understand how we have implemented OData for the BioNet Web Service (read-only) API and follow our best practice guidelines, read the Developer guidelines.
There are many existing online OData communities and resources for developers, and we recommend you search the internet to see if there are existing resources for your development tools and platform.
To help you get started, here are some links to core resources:
BioNet Map Services
The BioNet Vegetation Map data collection, including State Vegetation Type Maps, is available via the NSW SEED Portal:
- NSW State Vegetation Type Map
- NSW State Vegetation Type Map (Pre-Clearing)
- BioNet Vegetation Type Map Data Collection
For step-by-step instructions, refer to the Guidelines for using BioNet Map Services.
Published standards
BioNet Vegetation Maps spatial data are delivered through the Open Geospatial Consortium (OGC) Web Map Service (WMS) and OGC Web Feature Service (WFS).
Data is shared according to the published standard, which provides information on the data fields and terminology adopted to standardise vegetation mapping in New South Wales: Vegetation Map Data Standard
This standard provides guidance to maximise integration with BioNet data products and the BioNet Web Service.
For additional information, refer to the BioNet vegetation maps page.