API Name: settlement

Introduction

Discover Settlement Data with the AfriGIS Settlement Search API

The AfriGIS Settlement Search API enables users to access detailed information about settlements across South Africa. Through a range of flexible endpoints, users can search for settlements by name, identify nearby settlements within a defined radius, or determine whether a specific location falls within a settlement boundary.

Currently the API only returns information for informal settlements in South Africa.

Overview

The API offers multiple endpoints, each designed to deliver targeted insights based on unique input parameters.

Location-Based Settlement Identification

By submitting geographic coordinates, users can determine whether a location falls within an informal settlement. If applicable, the name of the settlement is returned.

Nearby Settlements

Users can define a radius around a specific location to identify informal settlements situated within the surrounding area.

Settlement Name Search

Users can search for a settlement by entering its name. The API returns detailed information about the settlement, including its administrative area.

Authentication

This API makes use of OAuth2 authentication. To integrate, sign up for a free trial account by contacting [email protected]

For detailed integration instructions using OAuth2, please click on the following link: https://developers.afrigis.co.za/oauth2-authentication/

To view technical documentation describing the details of the Settlement API, click on the button below.