AfriData API Documentation

API Overview

The AfriData API provides programmatic access to African datasets, enabling developers to integrate our data repository into their applications, research workflows, and data analysis pipelines.

Base URL

https://afridata.com/api/v1/

Response Format

JSON

Rate Limit

1000 requests/hour

Authentication

AfriData API uses API key authentication. Include your API key in the Authorization header:

Authorization: Api-Key YOUR_API_KEY_HERE

Available Endpoints

Datasets

GET /api/v1/datasets/

List all datasets with pagination and filtering

Query Parameters: search, category, format, sort, page

GET /api/v1/datasets/{id}/

Retrieve a specific dataset by ID

GET /api/v1/datasets/{id}/preview/

Get dataset preview with pagination

GET /api/v1/datasets/{id}/download/

Download dataset file

GET /api/v1/datasets/{id}/comments/

Get dataset comments with pagination

POST /api/v1/datasets/upload/

Upload a new dataset (authentication required)

POST /api/v1/comment/{id}/post/

Post a comment on a dataset (authentication required)

POST /api/v1/comment/{id}/upvote/

Upvote a comment (authentication required)

Example Requests

Python (requests)

import requests

# Get all datasets
headers = {'Authorization': 'Api-Key YOUR_API_KEY'}
response = requests.get('https://afridata.com/api/v1/datasets/', headers=headers)
datasets = response.json()

# Filter datasets by category and search
params = {
    'category': 'agriculture',
    'search': 'kenya',
    'sort': 'downloads'
}
response = requests.get('https://afridata.com/api/v1/datasets/', 
                       headers=headers, params=params)

# Get dataset details
dataset_id = 1
response = requests.get(f'https://afridata.com/api/v1/datasets/{dataset_id}/', 
                       headers=headers)

# Download dataset
response = requests.get(f'https://afridata.com/api/v1/datasets/{dataset_id}/download/', 
                       headers=headers)
with open('dataset.csv', 'wb') as f:
    f.write(response.content)

# Upload new dataset
files = {'file': open('mydata.csv', 'rb')}
data = {
    'title': 'Kenya Population Census 2024',
    'bio': 'Latest population data for Kenya',
    'topics': 'demographics, kenya, population'
}
response = requests.post('https://afridata.com/api/v1/datasets/upload/', 
                        headers=headers, files=files, data=data)

cURL

# Get datasets filtered by category
curl -H "Authorization: Api-Key YOUR_API_KEY" \
     "https://afridata.com/api/v1/datasets/?category=agriculture&search=kenya"

# Get dataset details
curl -H "Authorization: Api-Key YOUR_API_KEY" \
     "https://afridata.com/api/v1/datasets/1/"

# Download dataset
curl -H "Authorization: Api-Key YOUR_API_KEY" \
     -o dataset.csv \
     "https://afridata.com/api/v1/datasets/1/download/"

# Upload new dataset
curl -X POST \
     -H "Authorization: Api-Key YOUR_API_KEY" \
     -F "file=@mydata.csv" \
     -F "title=Kenya Population Census 2024" \
     -F "bio=Latest population data for Kenya" \
     -F "topics=demographics, kenya, population" \
     https://afridata.com/api/v1/datasets/upload/

# Post a comment
curl -X POST \
     -H "Authorization: Api-Key YOUR_API_KEY" \
     -F "content=Great dataset! Very useful for research." \
     https://afridata.com/api/v1/comment/1/post/

JavaScript (fetch)

// Get datasets with filtering
const headers = {
    'Authorization': 'Api-Key YOUR_API_KEY'
};

fetch('https://afridata.com/api/v1/datasets/?category=agriculture&search=kenya', {
    headers: headers
})
.then(response => response.json())
.then(data => console.log(data));

// Get dataset details
fetch('https://afridata.com/api/v1/datasets/1/', {
    headers: headers
})
.then(response => response.json())
.then(data => console.log(data));

// Download dataset
fetch('https://afridata.com/api/v1/datasets/1/download/', {
    headers: headers
})
.then(response => response.blob())
.then(blob => {
    const url = window.URL.createObjectURL(blob);
    const a = document.createElement('a');
    a.href = url;
    a.download = 'dataset.csv';
    a.click();
});

// Upload dataset
const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('title', 'Kenya Population Census 2024');
formData.append('bio', 'Latest population data for Kenya');
formData.append('topics', 'demographics, kenya, population');

fetch('https://afridata.com/api/v1/datasets/upload/', {
    method: 'POST',
    headers: headers,
    body: formData
})
.then(response => response.json())
.then(data => console.log(data));

API Key Management

Welcome! You can manage your API keys below. Generate new keys or revoke existing ones as needed.

Your API Keys


                                                    afridata_***************_xyz789

Active

Created: January 15, 2025 • Last used: 2 hours ago


                                                    afridata_***************_abc123

Active

Created: December 28, 2024 • Last used: 1 day ago

Generate New API Key

Create a new API key for your applications. Each key can be revoked independently.

You can have up to 10 active API keys at a time

API Key Best Practices

Keep your API keys secret. Do not expose them in client-side code.
Rotate your API keys regularly to minimize the impact of a compromised key.
Use environment variables to store your API keys securely.
Monitor your API key usage for any suspicious activity.

Usage Statistics

Requests Today

1000 remaining

This Month

+0% from last month

Popular Endpoint

/datasets/

0% of requests

API Key Usage

1000 remaining