STstreet
Meta

Get Areas

Changed on

Get all Areas in your Street account. This endpoint can be used to power additional searches on your own website.

get/areas

Request

Response

A successful response will return array of areas that are present in your Street.co.uk account. This endpoint does NOT paginate the results.

Example response

{
  "data": [
    {
      "type": "area",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "attributes": {
        "name": "Dumfries & Galloway",
        "property_count": 172,
        "polygon": [
          [
            -3.0325611,
            55.0388624
          ]
        ]
      }
    }
  ]
}

Changes

  • 84de2fa11dd7Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status