v0.1.0
OpenAPI 3.0.2
PaTMa
API documentation
Client Libraries
asking-prices
asking-prices Operations
/api/prospector/v1/asking-prices/
Find statistics (mean and median) for properties currently listed for sale, centred around a postcode or location.
Query Parameters
- Type: stringpostcode
A valid UK postcode
- Type: numberlat
The latitude of a coordinate pair
- Type: numberlong
The longitude of a coordinate pair
- Type: integerbedroomsrequired
The number of bedrooms for a property
- Type: string enumproperty
_type requiredThe type of property
values- flat
- terraced
- semi
-detached - detached
- house
- Type: integermin
_data _points The minimum number of data points to find
Responses
- application/json
- application/json
Request Example for get/api/prospector/v1/asking-prices/
curl 'https://app.patma.co.uk/api/prospector/v1/asking-prices/?bedrooms=1&property_type=flat' \
--header 'Authorization: YOUR_SECRET_TOKEN'
{
"status": "success",
"response_time": 1,
"data": {
"data_points": 1,
"radius": 1,
"mean": 1,
"median": 1
},
"postcode": "string",
"lat": 1,
"long": 1,
"bedrooms": 1,
"property_type": "string"
}/api/prospector/v1/asking-prices-floor-area/
Find price per floor area statistics (mean and median) for properties currently listed for sale, centred around a postcode or location.
Query Parameters
- Type: stringpostcode
A valid UK postcode
- Type: numberlat
The latitude of a coordinate pair
- Type: numberlong
The longitude of a coordinate pair
- Type: integerbedroomsrequired
The number of bedrooms for a property
- Type: string enumproperty
_type requiredThe type of property
values- flat
- terraced
- semi
-detached - detached
- house
- Type: integermin
_data _points The minimum number of data points to find
Responses
- application/json
- application/json
Request Example for get/api/prospector/v1/asking-prices-floor-area/
curl 'https://app.patma.co.uk/api/prospector/v1/asking-prices-floor-area/?bedrooms=1&property_type=flat' \
--header 'Authorization: YOUR_SECRET_TOKEN'
{
"status": "success",
"response_time": 1,
"data": {
"data_points": 1,
"radius": 1,
"mean_per_sqft": 1,
"mean_per_sqm": 1,
"median_per_sqft": 1,
"median_per_sqm": 1
},
"postcode": "string",
"lat": 1,
"long": 1,
"bedrooms": 1,
"property_type": "string"
}local-environment (Collapsed)
local-environment Operations
- get/api/prospector/v1/crime/
- get/api/prospector/v1/demographics/
- get/api/prospector/v2/demographics/
- get/api/prospector/v1/designated-areas/
- get/api/prospector/v2/designated-areas/
- post/api/prospector/v2/designated-areas/
- get/api/prospector/v1/flood-risk/
- get/api/prospector/v2/flood-risk/
- post/api/prospector/v2/flood-risk/
- get/api/prospector/v1/geographies/
- get/api/prospector/v2/geographies/
- post/api/prospector/v2/geographies/
- get/api/prospector/v1/schools/
planning (Collapsed)
planning Operations
properties (Collapsed)
properties Operations
property-listings (Collapsed)
rental (Collapsed)
rental Operations
rental-prices (Collapsed)
sold-prices (Collapsed)
sold-prices Operations
- get/api/prospector/v1/price-history/
- get/api/prospector/v1/sold-prices/
- get/api/prospector/v1/sold-prices-within/
- post/api/prospector/v1/sold-prices-within/
- get/api/prospector/v1/sold-prices-floor-area/
- get/api/prospector/v1/sold-prices-floor-area-within/
- post/api/prospector/v1/sold-prices-floor-area-within/
stamp-duty (Collapsed)
stamp-duty Operations