Skip to content

Fork of - User created documentation for WaterNSW's monitoring data API

License

Notifications You must be signed in to change notification settings

vk2jnc/WaterNSW-data-API-documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

This is an updated version of the great work done by Andrewcowley!

I have used Postman to do all the hard work, i will list below to steps i did to make this work. This is a quick guide for Dummies like myself!!

One of the services WaterNSW provides is the monitoring of rivers, dams and groundwater across the state of New South Wales, Australia. This data is made available via their website, mobile apps as well as a web service.

The web service allows a user to request realtime and historical timeseries data for monitoring site via HTTP and have the data returned in JSON or CSV format.

This documetation aims to provide someone with some knowledge of requesting data via an HTTP API enough information to access the water monitoring data.

Dive in

The two main parts of the documentation are:

  • Getting started: make requests to the API and what can be expected in response.
  • API reference: information on the possible API calls and examples of their use.

Both sections are works in progress.

Credits

All data sourced from the NSW Water web service is subject to the WaterNSW copyright notice.

Most of the information for this document comes from the following sources:

Thank you to:

  • Kisters support for answering my questions around the Hydstra system.

Contributing

If you wish to contribute, thank you! Please read CONTRIBUTING.md making special note of the Code of Conduct.

License

MIT

About

Fork of - User created documentation for WaterNSW's monitoring data API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published