Skip to main content
GET
/
v3
/
geo
/
streets
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/geo/streets \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "usrn": 123,
        "name": "<string>",
        "location": {
          "british_national_grid": [
            [
              {
                "northing": 123,
                "easting": 123
              }
            ]
          ]
        },
        "highway_authority": "<string>",
        "highway_authority_code": 123,
        "town": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "properties": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": "<array>"
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • name_in: Filter by street name(s)
  • usrn_in: Filter by USRN (Unique Street Reference Number)

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of streets.

JSON API response object

data
A list of streets · object[]
required
meta
object
required
jsonapi
object
required
included
array

Related resources that can be included when a street is returned