List areas for a cell
curl --request GET \
--url https://api.catchment.app/v1/cell-areas \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.catchment.app/v1/cell-areas"
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/cell-areas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"request_id": "475e5c94-b1de-4ed8-9268-f243c89c50d8",
"areas": [
{
"code": "E00023938",
"share_of_area": 0.762328,
"share_of_cell": 0.324435
},
{
"code": "E00190384",
"share_of_area": 0.854688,
"share_of_cell": 0.247392
},
{
"code": "E00023937",
"share_of_area": 0.368425,
"share_of_cell": 0.116549
},
{
"code": "E00023939",
"share_of_area": 0.380803,
"share_of_cell": 0.066488
},
{
"code": "E00023936",
"share_of_area": 0.12474,
"share_of_cell": 0.06293
},
{
"code": "E00023941",
"share_of_area": 0.653133,
"share_of_cell": 0.03963
},
{
"code": "E00023943",
"share_of_area": 1,
"share_of_cell": 0.032123
},
{
"code": "E00175226",
"share_of_area": 0.190148,
"share_of_cell": 0.031734
},
{
"code": "E00023935",
"share_of_area": 0.079619,
"share_of_cell": 0.030109
},
{
"code": "E00023942",
"share_of_area": 0.331528,
"share_of_cell": 0.028748
},
{
"code": "E00023946",
"share_of_area": 0.056701,
"share_of_cell": 0.019864
}
],
"cell": {
"h3": "88195da493fffff"
},
"type": "oa",
"credits": {
"used": 0,
"remaining": 977
}
}
Area mappings
List areas for a cell
Returns the areas of one type that overlap an H3 cell, with the share of each area in the cell and the share of the cell each area covers. Areas are ordered by share_of_cell, largest first. This endpoint uses no credits.
GET
/
v1
/
cell-areas
List areas for a cell
curl --request GET \
--url https://api.catchment.app/v1/cell-areas \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.catchment.app/v1/cell-areas"
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/cell-areas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"request_id": "475e5c94-b1de-4ed8-9268-f243c89c50d8",
"areas": [
{
"code": "E00023938",
"share_of_area": 0.762328,
"share_of_cell": 0.324435
},
{
"code": "E00190384",
"share_of_area": 0.854688,
"share_of_cell": 0.247392
},
{
"code": "E00023937",
"share_of_area": 0.368425,
"share_of_cell": 0.116549
},
{
"code": "E00023939",
"share_of_area": 0.380803,
"share_of_cell": 0.066488
},
{
"code": "E00023936",
"share_of_area": 0.12474,
"share_of_cell": 0.06293
},
{
"code": "E00023941",
"share_of_area": 0.653133,
"share_of_cell": 0.03963
},
{
"code": "E00023943",
"share_of_area": 1,
"share_of_cell": 0.032123
},
{
"code": "E00175226",
"share_of_area": 0.190148,
"share_of_cell": 0.031734
},
{
"code": "E00023935",
"share_of_area": 0.079619,
"share_of_cell": 0.030109
},
{
"code": "E00023942",
"share_of_area": 0.331528,
"share_of_cell": 0.028748
},
{
"code": "E00023946",
"share_of_area": 0.056701,
"share_of_cell": 0.019864
}
],
"cell": {
"h3": "88195da493fffff"
},
"type": "oa",
"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 |
areas list, for example an LSOA request for a cell in 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.
- A cell outside the grid returns
404withoutside_coverage.
Authorizations
An API key created under Account > Catchment API. Keys start with ck_.
Query Parameters
H3 cell index at resolution 8. Case is ignored.
Example:
"88195da493fffff"
Area type.
Available options:
oa, lsoa, msoa, data_zone, intermediate_zone