curl --request GET \
--url https://api.ctrl-hub.com/v3/property-search-results \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"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>"
},
"uprn": 123
},
"meta": {
"relevenance": 123,
"score": 123
}
}
],
"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>"
}
}Search for properties.
curl --request GET \
--url https://api.ctrl-hub.com/v3/property-search-results \
--header 'X-Session-Token: <api-key>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"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>"
},
"uprn": 123
},
"meta": {
"relevenance": 123,
"score": 123
}
}
],
"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>"
}
}Session token for authentication.
Limit the number of resources returned by the API
x >= 1Offset the resources returned by the API
x >= 0