GET api/property/historicalprices/postcode/{postcode}?propertyType={propertyType}&styleType={styleType}&leaseType={leaseType}&pageNumber={pageNumber}&pageSize={pageSize}

Get historical prices for a property by its Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
postcode

The postcode to get historical price data for.

string

Required

propertyType

Options are: DetachedHouse, SemiDetachedHouse, TerracedHouse, Flat

string

Required

styleType

Options are: New, Older

string

Required

leaseType

Options are: Freehold, Leasehold

string

Required

pageNumber

integer

Default value is 1

pageSize

integer

Default value is 20

Body Parameters

None.

Response Information

Resource Description

A list of prices

PagedCollectionDataContractOfHistoricalPriceDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of HistoricalPriceDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "TransactionId": "dc90d943-94ee-409d-a58e-f5b4c08fae96",
      "Price": 2,
      "DateTime": "2020-07-05T22:26:40.4996184Z",
      "Postcode": "sample string 4",
      "Outcode": "sample string 5",
      "Incode": "sample string 6",
      "PropertyType": "sample string 7",
      "StyleType": "sample string 8",
      "LeaseType": "sample string 9",
      "NumberParsed": 1,
      "NumberSuffix": "sample string 10",
      "Number": "sample string 11",
      "BuildingName": "sample string 12",
      "Latitude": 13.1,
      "Longitude": 14.1,
      "LatitudeLongitude": "13.1,14.1",
      "AddressId": "sample string 15"
    },
    {
      "TransactionId": "dc90d943-94ee-409d-a58e-f5b4c08fae96",
      "Price": 2,
      "DateTime": "2020-07-05T22:26:40.4996184Z",
      "Postcode": "sample string 4",
      "Outcode": "sample string 5",
      "Incode": "sample string 6",
      "PropertyType": "sample string 7",
      "StyleType": "sample string 8",
      "LeaseType": "sample string 9",
      "NumberParsed": 1,
      "NumberSuffix": "sample string 10",
      "Number": "sample string 11",
      "BuildingName": "sample string 12",
      "Latitude": 13.1,
      "Longitude": 14.1,
      "LatitudeLongitude": "13.1,14.1",
      "AddressId": "sample string 15"
    }
  ]
}