Request AccessSupport

API Summary

The Geographic Place API provides a unified and structured way for clients to access Enable's address and location data to simplify integration with Enable's APIs and systems. The Geographic Place API provides live data directly from Enable’s GIS system, allowing access to real-time data rather than relying on outdated, 24-hour-old information as Enables existing API suite currently offers.

At the core of the Geographic Place API is a common data model, known as "Place", which standardises how geographic information is represented and consumed across different systems. This model is loosely based on the TM Forum address APIs and is designed to facilitate seamless integration with Enable's other APIs and Services.

A Place can be classified as either:

  • Address – An address can be described with a postal address (e.g., residential or commercial properties).
  • Location – A point of interest that does not have a postal address but is still relevant for ordering Fibre products. Within Enable, these are known as Non-Building Access Points (NBAPs) and typically refer to fibre service locations identified by coordinates or a common name.

The Geographic Place API will replace Enable’s existing address-related APIs by providing the same functionality with real-time data which allows for a more efficient, scalable, and accurate system for managing the geographic data. The Geographic Place API will replace the following APIs:

  • Fibre Broadband Availability API
  • Address Lookup API
  • Proactive Address API

The Geographic Place API provides the following features:

  • Place Export – Generates a publicly accessible S3 link for programmatic downloads of place data files.
  • Place Search – Allows clients to search for places using flexible search criteria such as street names, coordinate-based radius searches, ONT serials, and related locations.
  • Place Details – Provides comprehensive information about a place, including fibre availability and other relevant details.
  • Place Resources – Lists all resources associated with a place, such as ONTs.
  • Place Update – A restricted endpoint that allows service partners to update address information.

More information on the Geographic Place API functionality can be found in the API specifications. 

The API Basepath is:

  • https://apis.enable.net.nz/geoPlaceAPI/v1
  • https://staging.apis.enable.net.nz/geoPlaceAPI/v1