# AfricaEnergyDataAPI v1 ## Endpoints and Example Requests. ### Endpoints The table below shows the list of the endpoints available in the API for fetching data per sector, checking API health, and testing API Key validation The API provides access to structured datasets related to **electricity**, **energy**, and **economic** indicators across African countries. You can explore and test all endpoints interactively via the Swagger documentation below: - **Swagger UI:** [https://localhost:8000/docs](https://localhost:8000/docs) | Endpoint | Method | Description | Required Query Parameters | Example Request | |-----------|--------|--------------|----------------------------|-----------------| | `/api/v1/electricity` | `GET` | Fetches electricity-related data for a given country, such as installed capacity, generation, and access metrics. | `country` *(string)* | `/api/v1/electricity?country=Kenya` | | `/api/v1/energy` | `GET` | Retrieves general energy sector data for a specific country and sub-sector (e.g., access, efficiency, renewables). | `country` *(string)*, `sub_sector` *(string, optional)* | `/api/v1/energy?country=Egypt&sub_sector=Access` | | `/api/v1/economic` | `GET` | Returns economic indicators (e.g., GDP, inflation, energy spending) for a given country and optional year range. | `country` *(string)*, `start_year` *(int, optional)*, `end_year` *(int, optional)* | `/api/v1/economic?country=South Africa&start_year=2000&end_year=2010` | | `/api/v1/health` | `GET` | Health check endpoint to verify the API is running correctly. | None | `/api/v1/health` | ### Expected Parameters The following are the parameters expected to be used while querying the API. - `country`: type `str`, the name of the country, example `country=Kenya` - `country_serial`: type `int`, the unique identifier for a country arranged in ascending order alphabetically, for example, for Algeria, `country_serial=1`, for Kenya, `country_serial=26` - `metric`: type `str`, the standard metric for the data queried, example `metric=GDP` - `unit`: type `str`, the standard unit of the data, example `unit=Current US$` - `year`: type `int`, the year you want data from, example `year=2015` - `start_year`: type `int`, defines the first year in a yearly range let's say 2010 - 2022, example `start_year=2010` - `end_year`: type `int`, defines the last year in a yearly range let's say 2010 - 2022, example `start_year=2022` - `sub_sector`: type `str`, the name of the sub sector you want data from, example in the Social and Economic sector, `sub_sector=National Account`. - `sub_sub_sector`: type `str`, the name of the sub-sub-sector you want data from, example in the Social and Economic sector, `sub_sub_sector=GDP (current US$)` **NOTE: Don't query `sub_sub_sector` with the words in the brackets, use `unit` or `metric` instead as sub_sub_sector is a combination of both** ### Code examples Below are sample requests in different programming languages to access the Africa Energy API.

Python using requests

```python import requests url = "https://africa-energy-api.onrender.com/api/v1/energy" headers = {"x-rapidapi-key": "your_api_key_here"} params = { "country": "Kenya", "start_year": 2000, "end_year": 2010 } response = requests.get(url, headers=headers, params=params) if response.status_code == 200: print(response.json()) else: print("Error:", response.status_code, response.text) ```

JavaScript using fetch

```javascript const url = "https://africa-energy-api.onrender.com/api/v1/energy?country=Kenya&year=2023"; const options = { headers: { "x-rapidapi-key": "your_api_key_here", }, }; fetch(url, options) .then((response) => response.json()) .then((data) => console.log(data)) .catch((error) => console.error("Error:", error)); ```

TypeScript using Axios

```typescript import axios from "axios"; const url = "https://africa-energy-api.onrender.com/api/v1/energy?country=Kenya&year=2023"; const headers = { "x-rapidapi-key": "your_api_key_here" }; axios .get(url, { headers }) .then((res) => console.log(res.data)) .catch((err) => console.error(err)); ```

Java using HttpClient

```java import java.net.http.*; import java.net.URI; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://africa-energy-api.onrender.com/api/v1/energy?country=Kenya&year=2023")) .header("x-rapidapi-key", "your_api_key_here") .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } } ```

### Example output ```json [ { "country": "Kenya", "country_serial": 26, "metric": "GDP", "unit": "Current US$", "sector": "Social and Economic", "sub_sector": "National Account", "sub_sub_sector": "GDP (current US$)", "source_link": "https://africa-energy-portal.org/database", "source": "Africa Energy Portal", "data": { "2000": 12608177152.0, "2001": 12983226368.0, "2002": 13102940160.0, "2003": 14904453120.0, "2004": 16095233024.0, "2005": 18739030016.0 } }, { "country": "Kenya", "country_serial": 26, "metric": "Rural population", "unit": "Millions of people", "sector": "Social and Economic", "sub_sector": "Population", "sub_sub_sector": "Rural population (millions of people)", "source_link": "https://africa-energy-portal.org/database", "source": "Africa Energy Portal", "data": { "2000": 25.19, "2001": 25.78, "2002": 26.37, "2003": 26.98, "2004": 27.6, "2005": 28.23 } } ] ```