List cells for an area
curl --request GET \
--url https://api.catchment.app/v1/area-cells \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.catchment.app/v1/area-cells"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.catchment.app/v1/area-cells', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"request_id": "dcf66588-6358-4b1e-8e67-39a5efef8f3a",
"area": {
"code": "E01000001",
"type": "lsoa"
},
"cells": [
{
"h3": "88194ad329fffff",
"share_of_area": 0.512728,
"share_of_cell": 0.122357
},
{
"h3": "88194ad363fffff",
"share_of_area": 0.408265,
"share_of_cell": 0.097457
},
{
"h3": "88194ad305fffff",
"share_of_area": 0.079011,
"share_of_cell": 0.018861
}
],
"credits": {
"used": 0,
"remaining": 977
}
}Area mappings
List cells for an area
Returns the H3 cells an area overlaps, with the share of the area in each cell and the share of each cell the area covers. Cells are ordered by share_of_area, largest first. This endpoint uses no credits.
GET
/
v1
/
area-cells
List cells for an area
curl --request GET \
--url https://api.catchment.app/v1/area-cells \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.catchment.app/v1/area-cells"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.catchment.app/v1/area-cells', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"request_id": "dcf66588-6358-4b1e-8e67-39a5efef8f3a",
"area": {
"code": "E01000001",
"type": "lsoa"
},
"cells": [
{
"h3": "88194ad329fffff",
"share_of_area": 0.512728,
"share_of_cell": 0.122357
},
{
"h3": "88194ad363fffff",
"share_of_area": 0.408265,
"share_of_cell": 0.097457
},
{
"h3": "88194ad305fffff",
"share_of_area": 0.079011,
"share_of_cell": 0.018861
}
],
"credits": {
"used": 0,
"remaining": 977
}
}Area types
type | Areas | Coverage |
|---|---|---|
oa | Output areas: 2021 in England and Wales, 2022 in Scotland | Great Britain |
lsoa | 2021 lower layer super output areas | England and Wales |
msoa | 2021 middle layer super output areas | England and Wales |
data_zone | 2022 data zones | Scotland |
intermediate_zone | 2022 intermediate zones | Scotland |
Shares
| Field | Definition |
|---|---|
share_of_area | Fraction of the area’s land that lies in the cell. Summed over an area’s cells it is 1, less a small remainder for some coastal areas. |
share_of_cell | Fraction of the cell covered by the area. Summed over a cell’s areas of one type it is 1 for a cell wholly on land, and less for a cell partly at sea. |
- Shares are by area, measured on the spheroid. They are not the address-weighted shares used for some metrics.
- Shares are rounded to 6 decimal places.
- Cells are H3 resolution 8, the grid the metrics are built on.
Authorizations
An API key created under Account > Catchment API. Keys start with ck_.
Query Parameters
Area type.
Available options:
oa, lsoa, msoa, data_zone, intermediate_zone Area code: a letter followed by eight digits. Case is ignored.
Example:
"E01000001"