Places API

Places

Get a list of places

get /places

Query parameters

Name	Type	Description
`usrn`	string	Limit results to those related to the street with this USRN.
`postcode`	string	Limit results to those with a matching postcode.

Example responses

HTTP code: 200

[
  {
    "usrn": "123456789012",
    "@id": "/places/1",
    "address": {
      "region": "Anyshire",
      "postcode": "AB1 2CD",
      "street_address": "1 Acacia Avenue",
      "locality": "Anytown"
    },
    "uprn": "123456789012",
    "geo": {
      "latitude": "40.75",
      "@type": "GeoCoordinates",
      "longitude": "73.98"
    },
    "@type": "Place"
  }
]

Get a single place using its UPRN as ID.

get /places/{UPRN}

Example responses

HTTP code: 200

{
  "usrn": "12345678",
  "@id": "/places/1",
  "address": {
    "locality": "Anytown",
    "region": "Anyshire",
    "street": "Acacia Avenue",
    "postcode": "AB1 2CD",
    "@type": "BS7666Address",
    "paon": "1"
  },
  "geo_osgb36": {
    "easting": "1",
    "northing": "2"
  },
  "uprn": "123456789012",
  "geo": {
    "latitude": "40.75",
    "@type": "GeoCoordinates",
    "longitude": "73.98"
  },
  "@type": "Place"
}