Introduction

Estate Intel offers Africa's most comprehensive real estate data API, which provides access to market indicators for multiple African cities.

Learn how to integrate our API seamlessly into your application.

API Fundamentals

To start using the ei API, simply sign up for an account.

Your API account on ei comes with rate limits, find out more about them here

If you need additional functionality or higher rate limits, kindly request custom features.

We provide you with a RESTful API that gives you access to the real estate data you need. This API is called via an HTTP method.

HTTP Method

GET	GET is used to request data from the ei API. You will be using this method throughout your integration.

Example Requests

We provide example API calls in cURL, PHP, and Node.js. These examples are for demonstration purposes, and you are free to use any language or framework of your choice. Just insert your parameters and values to test and integrate our API.

Additionally, Postman or any other API testing tools like Swagger can be used to test our API. You can explore our Postman API documentation to gain a deeper understanding of how the API works.

Requests and Responses

All your requests should always have Content-Type and Accept headers set to application/json. Our responses are always returned as JSON.

All responses body data are a combination of these keys:

Keys

success boolean	This lets you know if your request was successful or not. It returns true or false. We recommend that you use this in combination with HTTP status codes to determine the result of an API call.
message string	This is a summary of the response and its status. For instance when trying to fetch land price for Ikoyi, message might read "Land price for ikoyi,NG found".
data object	This contains the results of your request. It can either be an object, or an array depending on the request made. When you are expecting a single result, data will be an object. When you are expecting a list of results, an array will be returned.
errors object	You should not expect this except when you pass a wrong value to a parameter i.e when your request fails a validation test. The keys of this object are the names of the parameters that contain wrong values. The values of this object are an array of error messages. Expect it when your response HTTP response code is 422 Unprocessable Content.

Response Format

200 Ok

{
  "success": "[boolean]",
  "message": "[string]",
  "data": "[object]"
}