curl --request GET \
--url https://api.ctrl-hub.com/v3/geo/properties \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"uprn": 123,
"location": {
"british_national_grid": {},
"lat_long": {},
"psr": {
"latitude": 123,
"longitude": 123
}
},
"address": {
"description": "<string>",
"department": "<string>",
"organisation": "<string>",
"number": "<string>",
"name": "<string>",
"thoroughfare": "<string>",
"dependent_thoroughfare": "<string>",
"post_town": "<string>",
"postcode": "<string>",
"po_box": "<string>",
"country": "<string>"
},
"meters": [
{
"type": "mpan",
"number": 123
}
],
"psr": {
"indicator": true,
"priority": {},
"notes": {},
"contact": {}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"street": {
"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>"
}Retrieve a list of properties.
curl --request GET \
--url https://api.ctrl-hub.com/v3/geo/properties \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"uprn": 123,
"location": {
"british_national_grid": {},
"lat_long": {},
"psr": {
"latitude": 123,
"longitude": 123
}
},
"address": {
"description": "<string>",
"department": "<string>",
"organisation": "<string>",
"number": "<string>",
"name": "<string>",
"thoroughfare": "<string>",
"dependent_thoroughfare": "<string>",
"post_town": "<string>",
"postcode": "<string>",
"po_box": "<string>",
"country": "<string>"
},
"meters": [
{
"type": "mpan",
"number": 123
}
],
"psr": {
"indicator": true,
"priority": {},
"notes": {},
"contact": {}
}
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"street": {
"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>"
}Session token for authentication.
A comma separated list of related resources to include.
pressure_tests Filters the response data based on the value provided.
Available filters:
mprn_in: Filter by MPRN(s) (Meter Point Reference Number)uprn_in: Filter by UPRN(s) (Unique Property Reference Number)on_psr: Filter for properties on the Priority Services Registerpostcode_in: Filter by postcode(s)number_in: Filter by property number(s)thoroughfare_in: Filter by thoroughfare name(s)For more information on using named filters, see the docs
Limit the number of resources returned by the API
x >= 1Offset the resources returned by the API
x >= 0