API Guide

The UrbanBiome API provides programmatic access to the datasets and analyses we produce. It is designed for developers, researchers, and planners who wish to integrate our data into their own applications and workflows.

Authentication

Access to the API requires an API key. To request a key, please contact us with a brief description of your intended use case.

All requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

To ensure fair usage for all users, our API has a rate limit of 100 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests status code.

Example: Get NDVI Data for an Area

This endpoint allows you to retrieve the average NDVI value for a specified geographic area (currently limited to Bristol wards).

GET /api/v1/ndvi/area

Query Parameters:

Parameter	Type	Description
area	string	The name of the ward, e.g., "Clifton".

Example Request:

curl -X GET "[https://api.urbanbiome.co.uk/api/v1/ndvi/area?area=Clifton](https://api.urbanbiome.co.uk/api/v1/ndvi/area?area=Clifton)" \
     -H "Authorization: Bearer YOUR_API_KEY"
{
  "area": "Clifton",
  "average_ndvi": 0.42,
  "last_updated": "2025-06-18T14:00:00Z",
  "data_source": "Sentinel-2"
}