List metrics

Catalogue of metrics this organisation can request, with stable key, label, description, unit, domain, source, nation coverage, supported geographies and period basis. Query parameters are ignored. This endpoint uses no credits.

GET /v1/metrics

List metrics

cURL

curl --request GET \
  --url https://api.catchment.app/v1/metrics \
  --header 'Authorization: Bearer <token>'

200

{
  "request_id": "146b728a-d25b-4a42-a902-893e4f415d5f",
  "metrics": [
    {
      "key": "avg_income",
      "label": "Average Household income",
      "description": "ONS average income per household.",
      "domain": "affluence",
      "unit": "currency_gbp",
      "source": "ONS small area income estimates, FYE 2023",
      "nations": null,
      "geographies": [
        "catchment",
        "hex"
      ],
      "period_basis": "source_period"
    },
    {
      "key": "avg_price",
      "label": "Average House Price (2024/5)",
      "description": "Average residential sale price (2025 figures) from MH Land Registry.",
      "domain": "affluence",
      "unit": "currency_gbp",
      "source": "HM Land Registry Price Paid Data",
      "nations": null,
      "geographies": [
        "catchment",
        "hex"
      ],
      "period_basis": "source_period"
    },
    {
      "key": "la_occupancy_pct",
      "label": "Local authority occupancy",
      "description": "Reported English older-adult residential and nursing occupancy, excluding specialist beds. This is an authority figure, not catchment occupancy.",
      "domain": "care",
      "unit": "percent",
      "source": "Capacity Tracker",
      "nations": [
        "E92000001"
      ],
      "geographies": [
        "local_authority"
      ],
      "period_basis": "latest_reporting_month"
    }
  ],
  "credits": {
    "used": 0,
    "remaining": 1000
  }
}

​

Catalogue scope

The catalogue is filtered by the organisation’s API dataset and metric permissions. geographies controls which endpoint can read a key. local_authority keys can also be included in a postcode catchment request; they remain authority values in that response.

period_basis identifies source-period, current published, mixed population/supply, financial-year or monthly observations. It is not a claim that every dataset is current-year data. nations: null means no explicit nation restriction in the catalogue, within the API’s overall Great Britain coverage; individual values may still be unavailable.

The static metric catalogue describes the current full-access set. This endpoint is the discovery contract for your own organisation. Query parameters are ignored. No credits are consumed.

Authorizations

Authorization · string · header · required

An API key created under Account > Catchment API. Keys start with ck_.

Response

200

application/json

Available metric definitions. The example is abbreviated to three entries; the actual response lists every metric permitted for the organisation.

request_id · string<uuid> · required

metrics · object[] · required

Show child attributes

credits · object · required

Show child attributes