Welcome to the FreeTaps API

Table of contents

  1. Summary
  2. Authentification
  3. Documentation
  4. Examples

Summary

Route HTTP Method Action
/waterpoints GET Return all water points.
/waterpoints/closest/range/latitude/longitude GET Return water points at <range>km around the given location.

Authentification

Authentification is done through basic HTTP authentification.

Documentation

GET - /waterpoints

Return all water points. Optional parameters can be passed to limit the number of results or specify the format of the output.

Required parameters

No parameter required.

Optional parameters

GET - /waterpoints/closest/<range>/<latitude>/<longitude>

Return water points at <range>km around the given location. Optional parameters can be passed to limit the number of results or specify the format of the output. Specifying a limit will return the closest water points to the given location.

Required parameters

Optional parameters

Examples

https://api.freetaps.earth/waterpoints?limit=20

https://api.freetaps.earth/waterpoints?limit=20&format=xml

https://api.freetaps.earth/waterpoints/closest/10/44.8455/-0.5749