Introduction

The WiFi API allows you to discover Telstra WiFi Hotspots near a specified location. Given the latitude and longitude coordinates and the radius you want to search around it, the API will return a list of WiFi hotspots in that area. This API will only return hotspots in Australia owned by Telstra.

For more information on Telstra WiFi Hotspots, please visit this link.

Authentication

To get an OAuth 2.0 Authentication token, pass through your Consumer Key and Consumer Secret that you received when you registered for the WiFi API key. The grant_type should be left as ‘client_credentials’ and the scope as ‘WIFI’. The token will expire in one hour.

Response

Get WiFi Hotspots

The Get WiFi hotspots method will return a list of Telstra WiFi Hotspots within the given coordinates and radius. The response will contain a list of WiFi hotspots with information on each hotspot's coordinates and address.

Considerations
  • The coordinates need to be in the decimal degrees format.
  • The radius is in meters.
  • The number of records in the response is limited to 10.
  • The records in the response are sorted from nearest to furthest.
Response

HTTP Status Codes

Status Code Description
200 OK Successful request
400 Bad Request Invalid or missing request parameters
401 Unauthorized Invalid or no credentials passed in the request
500 Internal Server An internal error occurred when processing the request
503 Service Unavailable The service requested is currently unavailable

Demo Application - kwɪəri

A community demo application called 'kwɪəri' has been developed to present Telstra Air Hotspots on a map.

The application is written in Python using the Flask framework and also uses the Google Maps APIs.

The source of the demo application can be accessed from https://github.com/christrewin/kwieri

Things You Need To Know

Telstra does not guarantee that the list of WiFi hotspots is up to date. For example, new hotspots may not appear in the list. This is because there can be a delay in the update to the latest available data on hotspots.