PDI Logo
API docs by Redocly

Property Data APIs (1.0)

PDI Sales: sales@propertydealsinsight.com URL: https://www.propertydealsinsight.com/contact Terms of Service

The UKs Most Comprehensive Property Data API

UK Property Data API Solutions: Easy access to comprehensive data for over 30 million+ residential properties nationwide. Deliver in-depth information on almost any property in the UK to your clients in seconds and generate more business.

Get ahead of your competition: Add a new dimension to your business with our bespoke Property Data APIs. Material Information for 30 Million UK homes: Is your business ready for the new regulations that mandate upfront information on any UK home?

Some of the Most Popular APIs:

  • Valuations Data APIs: Access the latest sales, rental valuations, and yield on any UK property.
  • Property UPRN Data: Access key data objects linked to UPRN records for millions of UK homes.
  • Agent Performance: Insights into agency or branch performance nationwide.
  • Market Intelligence APIs: Insights into stock coming to market, withdrawals, and property trends.
  • Sold Prices API: Easily access data on sold property prices to help you make informed decisions on buying or selling property.
  • Energy Performance Data: Access energy performance data to help you make informed decisions on the energy efficiency of a property..
  • Mobile and Broadband Coverage API: Access data on mobile and broadband coverage for properties in UK.
  • Council Tax Bands API: Easily access data on council tax bands to help you understand your outlays and comparisions for properties in UK.
  • Mobile and Broadband Coverage API: Access data on mobile and broadband coverage for properties in UK.
  • GEO Coding API: Easily access PDIs GEO coding API allowing you to access geo coordinates for any location or perform a postcode lookup using reverse geocode lookup..
  • ... and many more!

100+ Data Sets Available via APIs: These are just the mainstream APIs we have made available, new data sources are added regularly, enriching the services you get all the time.

Can’t find the API you are looking for?: Ask us to create a bespoke API that delivers the exact information you want and technical consultation can be booked to.

Powered by Property Deals Insight: Integrate your platform with our APIs and make use of our offerings in your own solutions.

Property know-how + Sophisticated Tech = Deliver Top class solutions: Book Your Free Consultation Now

Get API Token

To get your api token

  1. Register / Login with Property Deals Insight (PDI)
  2. Go to My Account page.
  3. Click on Get API Token from the left navigation menu and click on Generate API Token button.

PS: You must have a valid API Subscription plan to be able to do that.

get api token screenshot

Agent

Marketing Time By Agent

We begin by compiling a comprehensive list of properties that have been marked as sold and are also registered in the UK registry data. Next, we calculate the time difference between the initial listing date and the date they were sold. This calculation provides you with the average number of days it takes for an agent to sell properties within a specified postcode area.

Request Body

Parameter Type Description Example Optional
region string A valid UK postcode area HA
BD
EC
limit integer maximum number of results to return 50 Y
pageNumber integer to navigate through multiple pages of results 1 Y
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

region
required
string (provide UK region) [ 1 .. 2 ] characters

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "region": "HA"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 50,
  • "pageNumber": 1,
  • "totalElements": 3,
  • "totalPages": 1,
  • "data": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Agent Performance

We measure agent performance using several key parameters:

  • Number of Listings: The total number of properties listed by the agent.
  • Listings Sold: The number of properties sold by the agent within a specific timeframe.
  • Time to Sale: The average duration from listing to sale.
  • Valuation vs. Sale Price: The difference between the initial property valuation and the actual sale price.

These metrics provide a comprehensive overview of an agent's effectiveness and efficiency in the real estate market.

Request Body

Parameter Type Description Example Optional
outcode string A valid UK outcode B5
BS18
EH10
limit integer maximum number of results to return 50 Y
pageNumber integer to navigate through multiple pages of results 1 Y
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "B1"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 50,
  • "pageNumber": 1,
  • "totalElements": 3,
  • "totalPages": 1,
  • "data": [
    • {},
    • {
      },
    • {}
    ]
}

Agent Wise Property Type

The purpose of this is to provide you with a breakdown of the total number of listings categorized by property type and organized by the respective agents.

Request Body

Parameter Type Description Example Optional
region string A valid UK postcode area HA
BD
EC
limit integer maximum number of results to return 50 Y
pageNumber integer to navigate through multiple pages of results 1 Y
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

region
required
string (provide UK region) [ 1 .. 2 ] characters

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "region": "EC"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 50,
  • "pageNumber": 1,
  • "totalElements": 3,
  • "totalPages": 1,
  • "data": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Agent Wise Stock

Get Agentwise total listings within a given no of days and for a particular outcode

Request Body

Parameter Type Description Example Optional
outcode string A valid UK outcode B5
BS18
EH10
forDays integer get total stock for days 182 Y
limit integer maximum number of results to return 50 Y
pageNumber integer to navigate through multiple pages of results 1 Y
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

forDays
integer (for days) [ 7 .. 365 ]
Default: 182

get no. of stocks for provided days.

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "B1",
  • "forDays": 182
}

Response samples

Content type
application/json
{}

List Of Agents

Returns a list of agent branches that operate in the specified outcode.

Request Body

Parameter Type Description Example Optional
outcode string A valid UK outcode B5, BS18, EH10 No
limit integer Maximum number of results to return 10 Yes (default: 10)
pageNumber integer Page number for pagination 1 Yes (default: 1)

Response

Field Description Example
agent_name Name of the agent / company name Bloomsbury Invest
agent_address Agent branch address 2 Stephen Street, London
agent_logo Agent brand logo URL https://dataapi.propertydealsinsight.com/r/L02/ia/zoopla_static_agent_logo_(596116).png

💷 Credit Cost
1 credit per 10 results (minimum 1 credit will be deducted for each request)

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "B1"
}

Response samples

Content type
application/json
{}

Agent Listings

This will return a list of on market listings (both sale and rental) listed by an agent.

Request Body

Parameter Type Description Example
agentName string A valid agent name which PDI supports Maguire Jackson
Barrows & Forrester
Davidson Estates
agentBranch string A valid agent branch address which PDI supports 33 George Street, Birmingham
14a Frederick Road, Edgbaston, Birmingham

Response

Fields Description Examples
pdi_listing_id A unique PDI identifier for the listing PDI-122916113
PDI-115165772
category Type of listing sale
rent
type_of_property Type of property flat
terraced
detached
bedrooms No of Bedrooms 2
3
price Asking price 180000
364000
current_status Status of the listing live
sold
expired
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

agentName
required
string (Agentname)
agentBranch
required
string (Agentbranch)

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "agentName": "Barrows & Forrester",
  • "agentBranch": "19 Kenyon Forge, Kenyon Street, Birmingham"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "isSuccess": true,
  • "message": "string",
  • "limit": 0,
  • "pageNumber": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "data": [
    • { }
    ],
  • "metadata": { }
}

Auto Complete

Find UK postcodes, outcodes, and estate agent names as you type. These search suggestions help you pick the right property location or agent faster, without typing them fully.

Suggest full UK postcodes as you type

Returns matching UK postcodes that start with text you enter (for example, typing "SW1" may suggest "SW1A 1AA"). Use this to provide autocomplete suggestions for postcodes as the user types.

Authorizations:
Bearer Authentication
path Parameters
postcode
required
string
Example: HA1

Partial UK postcode prefix to search. Matches postcodes that start with this text Do not include spaces unless you are searching from that point onward.

Responses

Response samples

Content type
application/json

Request: GET /v1/autocomplete/postcode/E17

{
  • "postCode": [
    • "E17 0AA",
    • "E17 0AG",
    • "E17 0AR",
    • "E17 0BR",
    • "E17 0EG"
    ]
}

Suggest UK outcodes as you type

Returns matching outcodes (the first part of a UK postcode, such as "M1" or "SW12"). Use this to provide autocomplete suggestions for outcodes as the user types.

Authorizations:
Bearer Authentication
path Parameters
outcode
required
string
Example: SW1

Partial UK outcode prefix to search. Matches areas that start with this text (for example, "SW1", "M1", or "HA1").

Responses

Response samples

Content type
application/json

Request: GET /v1/autocomplete/outcode/SW1

{
  • "postCode": [
    • "SW10",
    • "SW11",
    • "SW12",
    • "SW13",
    • "SW1V",
    • "SW1Y"
    ]
}

Suggest estate agent names as you type

Returns estate agent names that match what you enter. Use this to provide autocomplete suggestions for agent names as the user types.

Authorizations:
Bearer Authentication
path Parameters
agentname
required
string
Example: Fox

Partial estate agent name to search. Matches agent names that starts with this text in the name (case-insensitive in practice for most searches).

Responses

Response samples

Content type
application/json

Request: GET /v1/autocomplete/agentname/Foxtons

{
  • "agentNames": [
    • "Foxtons",
    • "Foxtons - Harrow",
    • "Foxtons - Pinner",
    • "Foxtons - Southgate",
    • "Foxtons Estate Agents"
    ]
}

Cash Flow

Estimate property cash flow and rental yield for a UK buy-to-let or investment deal. Enter purchase costs, rent, mortgage, and running costs to see monthly cash flow, annual profit, and a 10-year projection.

Calculate property cash flow and rental yield

Works out the cash flow and rental yield for a UK property investment based on the purchase price, deposit, stamp duty, mortgage, rent, and ongoing costs you provide. Returns monthly and annual figures, gross rental yield, a 10-year cash flow projection, and mortgage repayment schedules.

Request Body

Parameter Type Description Example Optional
propInsightValuation string Purchase price or property value in GBP 450000
rentalPayments string Expected monthly rent in GBP 2063
propRentalYields string Expected gross rental yield as a percentage 5.5
downPayment string Deposit amount in GBP (calculated from downPaymentPercentage if omitted) 90000 Y
downPaymentPercentage string Deposit as a percentage of the purchase price 20 Y
stampDuty string Stamp Duty Land Tax (SDLT) level or amount in GBP Low Y
stampDutyLow string Lower SDLT estimate in GBP (returned by the service if omitted) 12000 Y
stampDutyHigh string Higher SDLT estimate in GBP (returned by the service if omitted) 13000 Y
renovationCost string One-off refurbishment or improvement cost in GBP 15000 Y
mortgageAndValuationFees string Mortgage arrangement and valuation fees in GBP 2000 Y
legalPack string Conveyancing and legal fees in GBP 800 Y
mortgagePayments string Monthly mortgage payment in GBP (calculated if omitted) 1200 Y
miscExpenses string Other monthly running costs in GBP 200 Y
cleaningCost string Monthly cleaning or turnover cost in GBP 150 Y
mortgageMonthlyRePayment string Monthly mortgage repayment in GBP (calculated if omitted) 1200 Y
mortgageInterestRate string Annual mortgage interest rate as a percentage 3.5 Y
mortgageType string Mortgage type, such as interest only or repayment interest only Y
maintenanceCosts string Annual maintenance budget in GBP 3000 Y
propertyManagement string Annual letting agent or management fees in GBP 1200 Y
insurance string Annual landlord insurance in GBP 800 Y
voidPeriod string Yearly allowance in GBP for times the property stands empty. If you leave it out, it is set to half of one month's rent. Real empty periods depend on the location, the property type and how well the property is let and managed, so send your own figure 1032 Y
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Property valuation, costs, rent, mortgage details, and standard PDI request header.

object (Header)

Header parameters

propInsightValuation
string

Property insight valuation

propRentalYields
string

Property rental yields

downPayment
string

Initial down payment for the property

downPaymentPercentage
string

Down payment percentage

stampDuty
string

Stamp duty costs

stampDutyLow
string

Lower estimate of stamp duty costs

stampDutyHigh
string

Higher estimate of stamp duty costs

renovationCost
string

Cost of renovation

mortgageAndValuationFees
string

Mortgage and valuation fees

legalPack
string

Conveyancing and legal fees in GBP

rentalPayments
string

Monthly rental payments

mortgagePayments
string

Monthly mortgage payments

miscExpenses
string

Miscellaneous expenses

cleaningCost
string

Cleaning costs

mortgageMonthlyRePayment
string

Monthly mortgage repayment amount

mortgageInterestRate
string

Mortgage interest rate

mortgageType
string

Type of mortgage

maintenanceCosts
string

Annual maintenance costs

propertyManagement
string

Property management fees

insurance
string

Insurance costs

voidPeriod
string

Void period (months)

Responses

Request samples

Content type
application/json

Request: POST /v1/cashflow_yields

{
  • "propInsightValuation": "450000",
  • "propRentalYields": "5.5",
  • "downPayment": "90000",
  • "downPaymentPercentage": "20",
  • "stampDuty": "12500",
  • "stampDutyLow": "12000",
  • "stampDutyHigh": "13000",
  • "renovationCost": "15000",
  • "mortgageAndValuationFees": "2000",
  • "legalPack": "800",
  • "rentalPayments": "2063",
  • "mortgagePayments": "1200",
  • "miscExpenses": "200",
  • "cleaningCost": "150",
  • "mortgageMonthlyRePayment": "1200",
  • "mortgageInterestRate": "3.5",
  • "mortgageType": "interest only",
  • "maintenanceCosts": "3000",
  • "propertyManagement": "1200",
  • "insurance": "800",
  • "voidPeriod": "1032",
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "API Enterprise 30K",
    • "role": "API Enterprise 30K",
    • "X-PDI-Channel-Id": "PDI Data API",
    • "X-PDI-Process-Name": "cash flow"
    }
}

Response samples

Content type
application/json

Response: POST /v1/cashflow_yields

{
  • "isSuccess": true,
  • "propInsightValuation": "450000",
  • "oneOffCosts": "120300",
  • "downPayment": "90000",
  • "downPaymentPercentage": "20",
  • "stampDuty": "12500",
  • "stampDutyLow": "12000",
  • "stampDutyHigh": "13000",
  • "renovationCost": "15000",
  • "mortgageAndValuationFees": "2000",
  • "legalPack": "800",
  • "netMonthInOut": "513",
  • "rentalPayments": "2063",
  • "mortgagePayments": "1200",
  • "miscExpenses": "200",
  • "cleaningCost": "150",
  • "mortgageMonthlyRePayment": "1200",
  • "mortgageInterestRate": "3.5",
  • "mortgageType": "interest only",
  • "maintenanceCosts": "3000",
  • "propertyManagement": "1200",
  • "insurance": "800",
  • "voidPeriod": "1032",
  • "annualCosts": "5000",
  • "grossRentalYield": "5.5",
  • "annualCashFlow": "1156",
  • "cashFlowAnalysis": {
    • "1": {
      },
    • "2": {
      }
    },
  • "mortageRS": {
    • "mortgageMonthly": [
      ],
    • "mortgageYearly": [
      ]
    },
  • "xPDIEndToEndId": "40c40930-ce7d-4989-b4b7-a696f9d8967f"
}

Council Tax

Get Council Tax Information

Get council tax information for a given address and postcode

Request Body

Parameter Type Required Description Example
address string Yes Property address "10 Downing Street"
postcode string Yes A valid UK postcode "HA1 1SE"
limit int No Results per page (default: 20) 20
pageNumber int No Page number (default: 1) 1

Response Body

Parameter Type Description Example
address string Full property address 14, BETHECAR ROAD, HARROW
band string Council tax band (A-I or Deleted) E
localAuthority string Local authority name Harrow
detailLink string Link to check council tax band details https://www.tax.service.gov.uk/...
taxAmount string Annual council tax charge (not present for Deleted) 2928.27

💷 Credit Cost
1 credit per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

Address (string) or Address (null) (Address)

Property address

postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "address": "10 Downing Street",
  • "postcode": "SW1A 2AA"
}

Response samples

Content type
application/json
{}

Direct Mail

Submit a direct mail campaign

Accepts a direct mail campaign submission, transforms and sends to external API, returns campaignId and paymentLink.

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
campaignName
required
string (Campaignname)
required
object (PreferencesModel)
required
Array of objects (Recipients)

Responses

Request samples

Content type
application/json
{
  • "campaignName": "string",
  • "preferences": {
    • "sender": {
      },
    • "letter": {
      }
    },
  • "recipients": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{ }

Energy Performance

Energy Performance Certificate With Recommendation

This endpoint provides you with domestic energy performance certificates for properties, along with suggestions on how to improve their energy efficiency. It also gives you the estimated total cost to achieve a better energy rating, along with specific recommendations for each property.

Example Get Requests

Title Get Parameters
Filtering by postcode ?postcode=HA1
?postcode=HA1 1SE
Filtering by uprn ?uprn=12345678
Filtering by address ?address=liverpool
Filtering by address with limit ?address=liverpool&size=20
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name

Responses

Response samples

Content type
application/json
[
  • {
    • "address": "Apartment 3, 71, Knutsford Road",
    • "postcode": "WA4 1AB",
    • "uprn": "10090372041",
    • "current-energy-rating": "E",
    • "potential-energy-rating": "C",
    • "indicative-total-cost-to-reach-potential-energy-rating": "£8,795 - £22,785",
    • "lodgement-datetime": "2018-04-17 14:13:58",
    • "lmk-key": "1623958649202018041714135850789738",
    • "recommendations": [
      ]
    }
]

Flip Analysis

Estimate profit and return on investment for a UK property flip. Enter a purchase price to see acquisition, finance, renovation, and selling costs, plus overall ROI.

Calculate property flip profit and return on investment

Estimates the potential profit and return on investment (ROI) for a UK property flip before you buy. Enter the purchase price (or estimated value), and the calculator works out acquisition costs, mortgage finance, renovation spend, selling costs, cash invested, gain or loss, and overall ROI. Optional cost sections can be left out, sensible defaults are applied automatically.

Request Body

Parameter Type Description Example Optional
propInsightValuation number Purchase price or estimated property value in GBP 250000
acquisitionCosts object Buy-side costs such as deposit, stamp duty, and legal fees — Y
financeMortgage object Mortgage details such as loan amount, interest rate, and term — Y
projectCosts object Renovation and other project costs — Y
salesCosts object Expected sale price after refurbishment and selling fees — Y
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Purchase price or estimated property value. Optional cost sections can be included to override defaults.

object (Header)

Header parameters

propInsightValuation
integer <int32>

Property insight valuation

object (AcquisitionCosts)

AcquisitionCosts model

object (FinanceMortgage)

Finance mortgage

object (ProjectCosts)

Project costs

object (SalesCosts)

Sales costs

Responses

Request samples

Content type
application/json

Request: POST /v1/flip/calculate

{
  • "propInsightValuation": 250000
}

Response samples

Content type
application/json

Response: POST /v1/flip/calculate

{
  • "isSuccess": true,
  • "propInsightValuation": 250000,
  • "acquisitionCosts": {
    • "legalFees": 1000,
    • "downPayment": 62500,
    • "stampDuty": 2500,
    • "highStampDuty": 15000,
    • "totalAcquisitionCosts": 66000
    },
  • "financeMortgage": {
    • "loanAmount": 187500,
    • "interestRate": 7,
    • "loanTerm": 12,
    • "closingCosts": 500,
    • "totalFinanceCosts": 13625
    },
  • "projectCosts": {
    • "renovation": 7500,
    • "otherCosts": 0,
    • "totalProjectCosts": 7500
    },
  • "salesCosts": {
    • "postRefurbValuation": 300000,
    • "agentComission": 2500,
    • "miscelleneuous": 0,
    • "earlyRepaymentCharges": 0,
    • "salesProceeds": 297500
    },
  • "flipValuation": {
    • "cashInvested": 87125,
    • "gainOrLoss": 22875,
    • "postRefurbValuation": 300000,
    • "investPeriod": 12,
    • "financeCost": 7,
    • "returnOnInvest": 36.6
    }
}

Flood Risk

Check flood risk for a UK property or location. Shows risk from rivers and the sea, and from surface water, using a UPRN, postcode, address, or map coordinates.

Get flood risk for a property or location

Checks the long term flood risk for a UK property or location. Returns how likely the area is to flood from rivers and the sea, and from surface water (for example heavy rain). Each risk is shown as a simple band such as Very low, Low, Medium, or High, along with the map coordinates used for the check.

Request Body

Parameter Type Description Example Optional
uprn string Unique Property Reference Number for a specific property 100022527251 Y*
postcode string Valid UK postcode HA1 1SE Y*
location string Property address or place name 18 Bethecar Road, Harrow Y*
latitude number Latitude coordinate (must be sent with longitude) 51.59703 Y*
longitude number Longitude coordinate (must be sent with latitude) -0.034365 Y*

* Provide exactly one of: uprn, postcode, location, or latitude and longitude together.

Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Identify the place using exactly one of UPRN, postcode, location, or latitude and longitude, plus the standard PDI request header.

object (Header)

Header parameters

uprn
string

UPRN

postcode
string

Postcode

location
string

Location / address

latitude
number <double>

Latitude

longitude
number <double>

Longitude

Responses

Request samples

Content type
application/json

Request: POST /v1/flood-risk/search

{
  • "uprn": "100022527251",
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "AGENT_PREMIUM_YEARLY",
    • "role": "AGENT_PREMIUM_YEARLY",
    • "X-PDI-Channel-Id": "PDI digital",
    • "X-PDI-End-To-End-Id": "0497274b-8c53-4ef8-954c-93828de38521",
    • "X-PDI-Process-Name": "agent performance"
    }
}

Response samples

Content type
application/json

Response: POST /v1/flood-risk/search

{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "data": [
    • {
      }
    ],
  • "xPDIEndToEndId": "0497274b-8c53-4ef8-954c-93828de38521"
}

Network Coverage

Check mobile and broadband network coverage for UK properties by postcode. Returns Ofcom coverage data including signal quality and predicted broadband speeds for each address at the postcode.

Get mobile and broadband coverage by postcode

Returns mobile and broadband network coverage for all properties at a UK postcode. Includes predicted broadband speeds (standard, superfast, ultrafast) and mobile signal quality from major UK networks.

Request Body

Parameter Type Description Example Optional
postcode string UK postcode to look up coverage for L329SP
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

UK postcode and standard PDI request header.

object (Header)

Header parameters

postcode
required
string

UK postcode to look up coverage for

address
string

Optional address to filter results to a single property

uprn
integer <int64>

Optional UPRN to filter results to a single property

Responses

Request samples

Content type
application/json

Request: POST /v1/networkcoverage

{
  • "postcode": "L329SP",
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "AGENT_PREMIUM_YEARLY",
    • "role": "AGENT_PREMIUM_YEARLY",
    • "X-PDI-Channel-Id": "PDI Data API",
    • "X-PDI-Process-Name": "property insight",
    • "X-PDI-End-To-End-Id": "6e296dc9-4ea7-4483-b6bc-79758b6b5139"
    }
}

Response samples

Content type
application/json

Response: POST /v1/networkcoverage

{
  • "mobileCoverage": {
    • "PostCode": "L329SP",
    • "Availability": [
      ]
    },
  • "broadBandCoverage": {
    • "PostCode": "L329SP",
    • "Availability": [
      ]
    },
  • "isSuccess": true,
  • "xPDIEndToEndId": "6e296dc9-4ea7-4483-b6bc-79758b6b5139123"
}

On Market

Get full address details for on-market UK properties from portal URLs.

Get full address for an on-market listing

Resolves the full UK address and last sold details for an on-market property listing. Pass a portal listing URL. Returns matched address candidates with confidence scoring against sold price, sold year, and property type.

Query Parameters

Parameter Type Description Example Optional
URL string Portal listing URL (Rightmove or Zoopla, for sale or to rent) https://www.rightmove.co.uk/properties/90268878#/?channel=RES_BUY

Example URLs

Authorizations:
Bearer Authentication
query Parameters
URL
string
Example: URL=https://www.rightmove.co.uk/properties/90268878#/?channel=RES_BUY

Portal listing URL (Rightmove or Zoopla). Used when provided; otherwise propertyIdentifier is used.

propertyIdentifier
string

Alternative lookup key when URL is omitted. Supports PDI-prefixed identifiers.

Responses

Response samples

Content type
application/json

Response: GET /v1/onmarket/getFullAddress?URL=https://www.rightmove.co.uk/properties/90268878

{
  • "isSuccess": true,
  • "userPackage": { },
  • "data": [
    • {
      }
    ],
  • "listing_for": "for-sale"
}

On Market Comparable

Find comparable on-market UK property listings from portal by postcode, property type, and bedroom count.

Get on-market comparable listings

Returns paginated on-market comparable property listings near a UK postcode. Searches portal listings matching property type, bedroom count, and listing type. The search radius defaults to 1 mile and automatically widens (doubling each step) up to 4 miles only when radius is not provided. When radius is explicitly set, that value is used as-is (capped at 4 miles).

Request Body

Parameter Type Description Example Optional
postcode string UK postcode or outcode to search around BH23 3NN
listingType string Listing type. Values: SALE, RENT SALE
propertyType string Property type. Values: APARTMENT, FLAT, DETACHED, SEMI_DETACHED, TERRACED SEMI_DETACHED
numberOfBeds integer Target number of bedrooms 3
numberOfBedsVariance integer Bedroom range lower bound is numberOfBeds minus this value (inclusive up to numberOfBeds) 1 Y
radius number Search radius in miles (max 4). Defaults to 1.0 when omitted or 0; auto-widens up to 4 only when radius is not specified 1.0 Y
pageNumber integer Page index (0-based) 0 Y
pageSize integer Number of results per page 3
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Postcode, listing criteria, pagination, and standard PDI request header.

object (Header)

Header parameters

postcode
required
string

UK postcode or outcode to search around

propertyType
string
Enum: "APARTMENT" "FLAT" "DETACHED" "SEMI_DETACHED" "TERRACED"

Property type. Values: APARTMENT, FLAT, DETACHED, SEMI_DETACHED, TERRACED

numberOfBeds
integer <int32>

Target number of bedrooms

numberOfBedsVariance
integer <int32>

Bedroom range lower bound is numberOfBeds minus this value (inclusive up to numberOfBeds)

radius
number <float>

Search radius in miles (max 4). Defaults to 1.0 when omitted or 0

propertyAddress
string

Optional property address for context

listingType
required
string
Enum: "SALE" "RENT"

Listing type. Values: SALE, RENT

pageNumber
integer <int32>

Page index (0-based)

pageSize
integer <int32>

Number of results per page

Responses

Request samples

Content type
application/json

Request: POST /v1/pdionmarket/comparables

{
  • "listingType": "SALE",
  • "numberOfBeds": 3,
  • "numberOfBedsVariance": 1,
  • "propertyAddress": "",
  • "postcode": "BH23 3NN",
  • "propertyType": "SEMI_DETACHED",
  • "pageNumber": 0,
  • "pageSize": 3,
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "AGENT_PREMIUM_YEARLY",
    • "role": "AGENT_PREMIUM_YEARLY",
    • "X-PDI-Channel-Id": "PDI digital",
    • "X-PDI-End-To-End-Id": "afe87694-0ce1-46bf-ad43-b79694acb97c",
    • "X-PDI-Process-Name": "property insight"
    }
}

Response samples

Content type
application/json

Response: POST /v1/pdionmarket/comparables

{}

PDI Appraisal Report

Revolutionary Appraisals in seconds - Present comprehensive data & insights on any of the 30 Million UK homes.

Helping you get some of the most crucial details like:

  • Property Valuation Estimate: Estimated value of the property.
  • Sales Comparison: Local Sales stock and comparables in the area.
  • Rental Comparison: Local Rental stock and comparables in the area.
  • Recent Sales: Details of Recently Sold Properties (Land Registry and Ministry of Housing Data).
  • EPC Details: Energy Performance Certificate details for the property.
  • Cash Flow: Estimated BTL cash flow for the property.

Type of the appraisal report

Report Type Contains
Default Property Valuation
Sales Comparison
Rental Comparison
Recent Sales
EPC Details
Cash Flow
Sale Property Valuation
Sales Comparison
Recent Sales
EPC Details
Rent Property Valuation
Rental Comparison
EPC Details
Buy Property Valuation
Sales Comparison
Rental Comparison
Recent Sales
EPC Details
Cash Flow

Pdi Appraisal Report

This endpoint allows you to create an appraisal report by providing the necessary information about the property.You get instant property valuation estimates using our proprietary automated valuation model.

In response, you will receive a link containing a report based on your preference.

Request Body

Parameter Type Description Example Optional
address string A valid UK Address format which our system supports Flat 6, 221 Stockton Road, Hartlepool

209, Stockton Road

Apartment 1, 1 Garrett Street
postcode string A valid UK postcode WA4 1AB
propertyType enum: Flat, Detached, Semi-Detached, Terraced Type of the property Flat YES
internalArea integer Property's internal area in Square Meter 29 YES
bedrooms integer Number of bedrooms in the property 2 YES
bathrooms integer Number of bathrooms in the property 1 YES
receptions integer Number of reception rooms in the property 1 YES
reportType enum: Default, Sale, Rent, Buy Type of the appraisal report Sale YES
downloadPDF boolean Set to true if you want report in PDF true YES
mapType enum: Street, Satellite, Roadmap Type of map to show on the front page of the report Roadmap YES
pdiDataEnrichment boolean Set to true if you want to auto populate the mandatory fields like property type, internal area and bedrooms true YES
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
address
required
string (A valid UK Address format which our system supports) [ 5 .. 100 ] characters
postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters
PropertyType (string) or null
Internal Area (integer) or Internal Area (null) (Internal Area)

internal property area

number of bedrooms (integer) or number of bedrooms (null) (number of bedrooms)

number of bedrooms

bathrooms
integer (number of bathrooms) [ 0 .. 10 ]
Default: 0

number of bathrooms

receptions
integer (number of receptions) [ 0 .. 4 ]
Default: 0

number of receptions

ReportType (string) or null
downloadPDF
boolean (Download PDF)
Default: false

make this True if you want PDF link

mapType
string (MapType)
Enum: "Street" "Satellite" "Roadmap"
pdiDataEnrichment
boolean (PDI Data Enrichment)
Default: false

make this True if you want to enrich the data with PDI data

Responses

Request samples

Content type
application/json
{
  • "address": "Flat 2, 71 Knutsford Road",
  • "postcode": "WA4 1AB",
  • "propertyType": "Flat",
  • "internalArea": 70,
  • "bedrooms": 2,
  • "bathrooms": 1,
  • "receptions": 0,
  • "reportType": "Default",
  • "downloadPDF": false,
  • "mapType": "Street",
  • "pdiDataEnrichment": false
}

Response samples

Content type
application/json
Example

Report type is Default with link

{}

Pdi Appraisal Report By Uprn

This endpoint allows you to create an appraisal report by providing the necessary information about the property.You get instant property valuation estimates using our proprietary automated valuation model.

In response, you will receive a link containing a report based on your preference.

Request Body

Parameter Type Description Example Optional
uprn string Unique Property Reference Number 10090372040
propertyType enum: Flat, Detached, Semi-Detached, Terraced Type of the property Flat YES
internalArea integer Property's internal area in Square Meter 29 YES
bedrooms integer Number of bedrooms in the property 2 YES
bathrooms integer Number of bathrooms in the property 1 YES
receptions integer Number of reception rooms in the property 1 YES
reportType enum: Default, Sale, Rent, Buy Type of the appraisal report Sale YES
downloadPDF boolean Set to true if you want report in PDF true YES
mapType enum: Street, Satellite, Roadmap Type of map to show on the front page of the report Roadmap YES
pdiDataEnrichment boolean Set to true if you want to auto populate the mandatory fields like property type, internal area and bedrooms true YES
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
uprn
required
string (Unique Property Reference Number)
PropertyType (string) or null
Internal Area (integer) or Internal Area (null) (Internal Area)

internal property area

number of bedrooms (integer) or number of bedrooms (null) (number of bedrooms)

number of bedrooms

bathrooms
integer (number of bathrooms) [ 0 .. 10 ]
Default: 0

number of bathrooms

receptions
integer (number of receptions) [ 0 .. 4 ]
Default: 0

number of receptions

ReportType (string) or null
downloadPDF
boolean (Download PDF)
Default: false

make this True if you want PDF link

mapType
string (MapType)
Enum: "Street" "Satellite" "Roadmap"
pdiDataEnrichment
boolean (PDI Data Enrichment)
Default: false

make this True if you want to enrich the data with PDI data

Responses

Request samples

Content type
application/json
{
  • "uprn": "10090372040",
  • "propertyType": "Flat",
  • "internalArea": 70,
  • "bedrooms": 2,
  • "bathrooms": 1,
  • "receptions": 0,
  • "reportType": "Default",
  • "downloadPDF": false,
  • "mapType": "Street",
  • "pdiDataEnrichment": false
}

Response samples

Content type
application/json
Example

Report type is Default with link

{}

Pdi Appraisal Report Data

Run the same orchestration as /pdi-appraisal-report but stop short of generating the static map, share link and PDF. Returns the raw JSON payloads from each backend API stitched together so the caller can shape them (e.g. into a PDTF property pack).

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
address
required
string (A valid UK Address format which our system supports) [ 5 .. 100 ] characters
postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters
PropertyType (string) or null
Internal Area (integer) or Internal Area (null) (Internal Area)

internal property area

number of bedrooms (integer) or number of bedrooms (null) (number of bedrooms)

number of bedrooms

bathrooms
integer (number of bathrooms) [ 0 .. 10 ]
Default: 0

number of bathrooms

receptions
integer (number of receptions) [ 0 .. 4 ]
Default: 0

number of receptions

ReportType (string) or null
downloadPDF
boolean (Download PDF)
Default: false

make this True if you want PDF link

mapType
string (MapType)
Enum: "Street" "Satellite" "Roadmap"
pdiDataEnrichment
boolean (PDI Data Enrichment)
Default: false

make this True if you want to enrich the data with PDI data

Responses

Request samples

Content type
application/json
{
  • "address": "Flat 2, 71 Knutsford Road",
  • "postcode": "WA4 1AB",
  • "propertyType": "Flat",
  • "internalArea": 70,
  • "bedrooms": 2,
  • "bathrooms": 1,
  • "receptions": 0,
  • "reportType": "Default",
  • "downloadPDF": false,
  • "mapType": "Street",
  • "pdiDataEnrichment": false
}

Response samples

Content type
application/json
null

Pdi Appraisal Report Data By Uprn

Same orchestration as /pdi-appraisal-report-data but driven by UPRN. Address and postcode are resolved from the UPRN automatically. Property type, internal area and bedrooms are enriched from the database when pdiDataEnrichment is True and not explicitly provided.

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
uprn
required
string (Unique Property Reference Number)
PropertyType (string) or null
Internal Area (integer) or Internal Area (null) (Internal Area)

internal property area

number of bedrooms (integer) or number of bedrooms (null) (number of bedrooms)

number of bedrooms

bathrooms
integer (number of bathrooms) [ 0 .. 10 ]
Default: 0

number of bathrooms

receptions
integer (number of receptions) [ 0 .. 4 ]
Default: 0

number of receptions

ReportType (string) or null
downloadPDF
boolean (Download PDF)
Default: false

make this True if you want PDF link

mapType
string (MapType)
Enum: "Street" "Satellite" "Roadmap"
pdiDataEnrichment
boolean (PDI Data Enrichment)
Default: false

make this True if you want to enrich the data with PDI data

Responses

Request samples

Content type
application/json
{
  • "uprn": "10090372040",
  • "propertyType": "Flat",
  • "internalArea": 70,
  • "bedrooms": 2,
  • "bathrooms": 1,
  • "receptions": 0,
  • "reportType": "Default",
  • "downloadPDF": false,
  • "mapType": "Street",
  • "pdiDataEnrichment": false
}

Response samples

Content type
application/json
null

PDI Market Intelligence

Market Prospects

Unparalleled On/Off Market data - Use this API to get a list of properties that are/were on the market in a specific outcode. You can filter the listings by type (sale or rent) and include only those with a complete property address. The response includes a list of properties with details such as price, number of bedrooms, number of bathrooms, property type, listing status, and more. You can also view images, floorplans, and features of the property. The response includes a total count of properties and the total number of pages.

Request

Parameter Type Description Examples
outcode string A valid UK outcode BA11, E16, W5
type string Type of listing SALE, RENT
withFullAddressOnly boolean Filter listings to include only those with a complete property address true, false

Response

Fields Description Examples
identifier Unique identifier for the property PDI-RM01-159269036
postcode
Postcode associated with the address
 BA11 6NX
full_property_address Property address 5, Hughes Court, High Street, Rode, Frome, Somerset BA11 6NX

49b, Catherine Street, Frome, Somerset BA11 1DA
address Property address High Street, Rode, Frome, Somerset

Catherine Street, Frome, Somerset
uprn Unique Property Reference Number 250033921
num_bedrooms Number of bedrooms 3
num_bathrooms Number of bathrooms 1
price Listed price in GBP (sale price or rent per month) £500,000
£1,950
price_qualifier Qualifier for the price Guide Price
price_frequency Frequency of the price not specified
property_type Type of property Flat, Terraced, Detached etc
first_published_date Listed on date 2025-02-19 11:44:23.0
listing_update_reason When listing gets updated, you get status here (price reduced / increse etc) price_reduced
listing_type Type of listing, can be sale or rent sale
status Current status of listing. If its live, sold or expired for_sale
to_rent
expired
archived
sold
secondary_status This is secondary status of listing, i.e. Just added, Sold STC, Let etc Just added
latitude gps coordinates of the propery 51.285003
longitude gps coordinates of the propery -2.28072
listing_url URL link to open portal listing https://dataapi.propertydealsinsight.com/r/L01/d/properties/158438741
images A list of available listing images https://dataapi.propertydealsinsight.com/r/L01/ixl/dir/10k/9102/158438741/9102_DDB250034_IMG_00_0000.jpeg
features A list of features of the property Two double bedrooms
Ground floor
Private garden
Over 100 year lease
Period conversion
No onward chain
floorplans A list of floorplans of the property https://dataapi.propertydealsinsight.com/r/L01/ixl/108k/107680/159269036/107680_33731497_FLP_00_0000.jpeg
agent Listed by agent name, address and phone number Martin & Co Westbury
Connells - Gillingham
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

type
string (ListingTypeEnum)
Enum: "SALE" "RENT"
withFullAddressOnly
boolean (With Full Address Only)
Default: false

Filter listings to include only those with a complete property address

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "E16",
  • "type": "SALE",
  • "withFullAddressOnly": false
}

Response samples

Content type
application/json
{}

Market Prospects Status

Unparalleled On/Off Market data - Use this API to get a list of properties in a specific outcode based on predefined sourcing lists such as newly listed, under offer, price reduced, withdrawn or suspected sold in a specific outcode. You can also filter listings to include only those with a complete property address.

Request

Parameter Type Description Examples
outcode string A valid UK outcode BA11, E16, W5
type string Type of listing SALE, RENT
withFullAddressOnly boolean Filter listings to include only those with a complete property address true, false
status string Status of the listing NEW_INSTRUCTIONS, UNDER_OFFER, WITHDRAWALS

Meaning of status:

  • NEW_INSTRUCTIONS: When a property is newly listed
  • UNDER_OFFER: When a property goes from on market to under offer/sold STC
  • WITHDRAWALS: When an on-market property is withdrawn from the website - Presenting a great opportunity to win the instruction
  • SUSPECTED_SOLD: When a property that is under offer/sold STC is withdrawn from the website
  • FALL_THROUGHS: When a property sale falls through - Presenting an opportunity to win the instruction
  • PRICE_REDUCTIONS: When a property price is reduced - this can indicate the vendor is motivated to sell/let and is likely to be open to offers or changing agents

Response

Fields Description Examples
identifier Unique identifier for the property PDI-RM01-159269036
postcode
Postcode associated with the address
 BA11 6NX
full_property_address Property address 5, Hughes Court, High Street, Rode, Frome, Somerset BA11 6NX

49b, Catherine Street, Frome, Somerset BA11 1DA
address Property address High Street, Rode, Frome, Somerset

Catherine Street, Frome, Somerset
uprn Unique Property Reference Number 250033921
num_bedrooms Number of bedrooms 3
num_bathrooms Number of bathrooms 1
price Listed price in GBP (sale price or rent per month) £500,000
£1,950
price_qualifier Qualifier for the price Guide Price
price_frequency Frequency of the price not specified
property_type Type of property Flat, Terraced, Detached etc
first_published_date Listed on date 2025-02-19 11:44:23.0
listing_update_reason When listing gets updated, you get status here (price reduced / increse etc) price_reduced
listing_type Type of listing, can be sale or rent sale
status Current status of listing. If its live, sold or expired for_sale
to_rent
expired
archived
sold
secondary_status This is secondary status of listing, i.e. Just added, Sold STC, Let etc Just added
latitude gps coordinates of the propery 51.285003
longitude gps coordinates of the propery -2.28072
listing_url URL link to open portal listing https://dataapi.propertydealsinsight.com/r/L01/d/properties/158438741
images A list of available listing images https://dataapi.propertydealsinsight.com/r/L01/ixl/dir/10k/9102/158438741/9102_DDB250034_IMG_00_0000.jpeg
features A list of features of the property Two double bedrooms
Ground floor
Private garden
Over 100 year lease
Period conversion
No onward chain
floorplans A list of floorplans of the property https://dataapi.propertydealsinsight.com/r/L01/ixl/108k/107680/159269036/107680_33731497_FLP_00_0000.jpeg
agent Listed by agent name, address and phone number Martin & Co Westbury
Connells - Gillingham
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

type
string (ListingTypeEnum)
Enum: "SALE" "RENT"
withFullAddressOnly
boolean (With Full Address Only)
Default: false

Filter listings to include only those with a complete property address

status
required
string (MarketProspectsStatusEnum)
Enum: "NEW_INSTRUCTIONS" "FALL_THROUGHS" "UNDER_OFFER" "PRICE_REDUCTIONS" "WITHDRAWALS" "SUSPECTED_SOLD"

Enum representing different market prospect statuses for properties.

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "E16",
  • "type": "SALE",
  • "withFullAddressOnly": false,
  • "status": "NEW_INSTRUCTIONS"
}

Response samples

Content type
application/json
{}

Get Single Listing

Get a single listing by passing an identifier which could be PDI identifier(recommended) or property UPRN for the listing.

Request

Parameter Type Description Examples
identifier string A valid listing identifier or UPRN PDI-RM01-159269036 or 250033921

Response

Fields Description Examples
identifier Unique identifier for the property PDI-RM01-159269036
postcode
Postcode associated with the address
 BA11 6NX
full_property_address Property address 5, Hughes Court, High Street, Rode, Frome, Somerset BA11 6NX

49b, Catherine Street, Frome, Somerset BA11 1DA
address Property address High Street, Rode, Frome, Somerset

Catherine Street, Frome, Somerset
uprn Unique Property Reference Number 250033921
num_bedrooms Number of bedrooms 3
num_bathrooms Number of bathrooms 1
price Listed price in GBP (sale price or rent per month) £500,000
£1,950
price_qualifier Qualifier for the price Guide Price
price_frequency Frequency of the price not specified
property_type Type of property Flat, Terraced, Detached etc
first_published_date Listed on date 2025-02-19 11:44:23.0
listing_update_reason When listing gets updated, you get status here (price reduced / increse etc) price_reduced
listing_type Type of listing, can be sale or rent sale
status Current status of listing. If its live, sold or expired for_sale
to_rent
expired
archived
sold
secondary_status This is secondary status of listing, i.e. Just added, Sold STC, Let etc Just added
latitude gps coordinates of the propery 51.285003
longitude gps coordinates of the propery -2.28072
listing_url URL link to open portal listing https://dataapi.propertydealsinsight.com/r/L01/d/properties/158438741
images A list of available listing images https://dataapi.propertydealsinsight.com/r/L01/ixl/dir/10k/9102/158438741/9102_DDB250034_IMG_00_0000.jpeg
features A list of features of the property Two double bedrooms
Ground floor
Private garden
Over 100 year lease
Period conversion
No onward chain
floorplans A list of floorplans of the property https://dataapi.propertydealsinsight.com/r/L01/ixl/108k/107680/159269036/107680_33731497_FLP_00_0000.jpeg
agent Listed by agent name, address and phone number Martin & Co Westbury
Connells - Gillingham
header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

identifier
required
string (Listing Identifier)

Listing identifier

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "identifier": "PDI-RM01-159269036"
}

Response samples

Content type
application/json
{}

PDI Property Enrichment

Resolve UK addresses to UPRNs and return the property behind them: property type, bedrooms, floor area, council tax band and annual charge, and EPC rating and heating fuel.

Match an address you already hold, enrich a UPRN you already have, or list the addresses at a postcode for a user to choose from. Coverage spans England, Wales and Scotland.

UPRN by address

Resolve a UK address and postcode to a UPRN.

Matches an address you already hold against PDI's property register and returns its Unique Property Reference Number (UPRN). No property data is returned — use it to attach UPRNs to your records, then enrich only the ones you need.

Match outcomes

Branch on match_status. Every outcome is returned with HTTP 200, including no match.

match_status Meaning uprn
MATCHED One property identified Populated
MULTIPLE_MATCHES Several properties qualify and none is an exact match. matches lists them null
NO_MATCH No property could be verified. reason_code says why null

To resolve a MULTIPLE_MATCHES result, send the address and postcode of the chosen entry in matches as a new request.

Common use cases

  • Bulk reconciliation — attach UPRNs to an existing customer or property book.
  • De-duplication — find records that refer to the same property.
  • Joining datasets — use the UPRN as the key to other property data.

Works well with

  • /pdi-property-enrichment/core and /pdi-property-enrichment/base — enrich a UPRN you have resolved.
  • /pdi-property-enrichment/core-by-address — match and enrich in a single call.

Request

Parameter Type Description Example
address string The address as you hold it, as free text 8 Wall Street, Blackpool
postcode string A full, valid UK postcode. Case and spacing are normalised FY1 2EG

The postcode is the search key: an address is only matched against properties at the postcode supplied.

Response (data)

Field Description
input_address The address you sent
postcode The postcode you sent, normalised
match_status MATCHED, MULTIPLE_MATCHES or NO_MATCH
multiple_matches true when several properties qualified
match_confidence HIGH, MEDIUM or LOW when MATCHED; otherwise null
score 0–1, how closely the matched address corresponds to your input, when MATCHED; otherwise null
uprn Unique Property Reference Number, when MATCHED; otherwise null
matched_address The address of the identified property, when MATCHED; otherwise null
address_source ADDRESS_MASTER (PDI property register) or EPC (EPC register), when MATCHED or MULTIPLE_MATCHES; otherwise null
reason_code Why a single property was not identified — see below. Null when MATCHED
matches When MULTIPLE_MATCHES, the candidates, each with address, postcode, score and address_source. Candidates carry no UPRN. Empty otherwise

reason_code

Code Meaning
MULTIPLE_CANDIDATES Several properties qualified. Choose from matches
NO_CANDIDATE_PASSED_VERIFICATION Properties exist at the postcode, but none matched the address closely enough — often a missing or different flat or unit number
NO_CANDIDATE_RETRIEVED Nothing at the postcode resembled the address. Check the postcode is right
NO_RESOLVABLE_ADDRESS The address is a single name with no number, such as a town on its own

Credits

Charged only when a property is identified (MATCHED). MULTIPLE_MATCHES, NO_MATCH and rejected requests are not charged. The rate below applies to a MATCHED result, and the X-PDI-Credits-Deducted response header states what each accepted request cost.

💷 Credit Cost
1 credit per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

address
required
string (Address)
postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters
debug
boolean (Debug)
Default: false

When true, include internal matching details and alternative candidates in metadata. Ignored unless config DEBUG is true.

Array of Include (strings) or Include (null) (Include)

Optional response blocks: 'two_field_address', 'match_code'. Omit for the standard response. Unknown names are ignored.

Responses

Request samples

Content type
application/json
{
  • "address": "8 Wall Street, Blackpool",
  • "postcode": "FY1 2EG"
}

Response samples

Content type
application/json
Example
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 1,
  • "totalElements": 1,
  • "data": [
    • {
      }
    ]
}

Property attributes by UPRN

Return the core attributes of a UK property from its UPRN.

Returns the property's address, type, bedrooms and floor area, with the source of each value. For council tax and EPC as well, use /pdi-property-enrichment/core.

Common use cases

  • Record enrichment — add property type, size and bedrooms to records already keyed by UPRN.
  • Portfolio segmentation — group a set of properties by type and size.

Works well with

  • /address/uprn-lookup-by-address — resolve an address to a UPRN first.
  • /pdi-property-enrichment/core — the same attributes plus council tax and EPC.

Request

Parameter Type Description Example
uprn string Unique Property Reference Number, digits only 100010837358

Response (data)

Field Description
address The property's address
postcode The property's postcode
uprn Unique Property Reference Number
property_type Type of property, for example Flat, Terraced, Semi-Detached, Detached or House. Null when not held
bedrooms Number of bedrooms. Null when not held
total_floor_area Floor area in square metres. Null when not held
source The dataset each of property_type, bedrooms and total_floor_area came from, for example EPC, price_paid (HM Land Registry) or Portal (property listings)

A UPRN with no record returns HTTP 200 with an empty data list and the message No property found for this UPRN.

Credits

Charged when a property is returned. A UPRN with no record is not charged, and neither is a rejected request. When a property is returned, the X-PDI-Credits-Deducted response header states the charge.

💷 Credit Cost
1 credit per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

uprn
required
string (Uprn) [ 1 .. 20 ] characters ^\d+$

Unique Property Reference Number

Responses

Request samples

Content type
application/json
{
  • "uprn": "100010837358"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 1,
  • "totalElements": 1,
  • "data": [
    • {
      }
    ]
}

Property enrichment by UPRN

Return a UK property's attributes, council tax and EPC from its UPRN.

Everything in /pdi-property-enrichment/base, plus the council tax band and annual charge, and the latest EPC rating and heating fuel.

Common use cases

  • Energy and utilities — identify mains gas and off-grid properties, and the energy rating, before a quote.
  • Household cost estimates — combine the council tax charge with property size and type.
  • Record enrichment — add property, council tax and energy data to records already keyed by UPRN.

Works well with

  • /address/uprn-lookup-by-address — resolve an address to a UPRN first.
  • /pdi-property-enrichment/core-by-address — match an address and enrich it in a single call.

Request

Parameter Type Description Example
uprn string Unique Property Reference Number, digits only 100010837358

Response (data)

Field Description
address The property's address
postcode The property's postcode
uprn Unique Property Reference Number
property_type Type of property, for example Flat, Terraced, Semi-Detached, Detached or House. Null when not held
bedrooms Number of bedrooms. Null when not held
total_floor_area Floor area in square metres. Null when not held
source The dataset each of property_type, bedrooms and total_floor_area came from, for example EPC, price_paid (HM Land Registry) or Portal (property listings)
council_tax Council tax for the property — see below. Null when no council tax record is matched
epc The latest Energy Performance Certificate — see below. Null when no certificate is held

council_tax

Field Description
band Council tax band: A–H in England and Scotland, A–I in Wales
authority The billing authority
amount The annual charge for that band at that authority, in GBP. It is the band charge, not a property-specific bill. Null when not held
year The charging year amount applies to

epc

Field Description
rating Current energy rating, A–G
heating_type The main heating description on the certificate
main_fuel The main fuel as recorded on the certificate. Often null for Scottish properties
mains_gas_flag Y or N where the certificate records it; otherwise null. Not recorded on Scottish certificates
fuel_category The fuel, normalised: MAINS_GAS, COMMUNITY_HEAT, OFF_GRID_ELECTRIC, OFF_GRID_OIL, OFF_GRID_LPG, OFF_GRID_SOLID_FUEL or OFF_GRID_UNSPECIFIED. Null when it cannot be determined
lodgement_date The date the certificate was lodged

Use fuel_category rather than main_fuel in your logic: the raw fuel text is worded differently between certificates and between nations.

A UPRN with no record returns HTTP 200 with an empty data list and the message No property found for this UPRN.

Credits

Charged when a property is returned. A UPRN with no record is not charged, and neither is a rejected request. When a property is returned, the X-PDI-Credits-Deducted response header states the charge.

💷 Credit Cost
3 credits per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

uprn
required
string (Uprn) [ 1 .. 20 ] characters ^\d+$

Unique Property Reference Number

Responses

Request samples

Content type
application/json
{
  • "uprn": "100010837358"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 1,
  • "totalElements": 1,
  • "data": [
    • {
      }
    ]
}

Property enrichment by address

Match a UK address and return the property, with council tax and EPC.

Matches an address you already hold against PDI's property register. When a single property is identified, the same response carries its UPRN, attributes, council tax and EPC — one call instead of a lookup followed by an enrichment.

Match outcomes

Branch on match_status. Every outcome is returned with HTTP 200, including no match.

match_status Meaning Property fields
MATCHED One property identified Populated
MULTIPLE_MATCHES Several properties qualify and none is an exact match. matches lists them null
NO_MATCH No property could be verified. reason_code says why null

To resolve a MULTIPLE_MATCHES result, send the address and postcode of the chosen entry in matches as a new request.

Common use cases

  • Quotes and onboarding — turn an address a customer gives you into property details at the point of capture.
  • Energy and utilities — identify mains gas and off-grid properties from an address.
  • Record enrichment — enrich records that carry an address but no UPRN.

Works well with

  • /pdi-property-enrichment/address-selector — let a user pick their address at a postcode, then send the selection here.
  • /address/uprn-lookup-by-address — the UPRN only, when you do not need property data yet.
  • /pdi-property-enrichment/core — enrich by UPRN when you already hold one.

Request

Parameter Type Description Example
address string The address as you hold it, as free text 8 Wall Street, Blackpool
postcode string A full, valid UK postcode. Case and spacing are normalised FY1 2EG

The postcode is the search key: an address is only matched against properties at the postcode supplied.

Response (data) — match fields

Field Description
input_address The address you sent
postcode The postcode you sent, normalised
match_status MATCHED, MULTIPLE_MATCHES or NO_MATCH
multiple_matches true when several properties qualified
match_confidence HIGH, MEDIUM or LOW when MATCHED; otherwise null
score 0–1, how closely the matched address corresponds to your input, when MATCHED; otherwise null
uprn Unique Property Reference Number, when MATCHED; otherwise null
matched_address The address of the identified property, when MATCHED; otherwise null
address_source ADDRESS_MASTER (PDI property register) or EPC (EPC register), when MATCHED or MULTIPLE_MATCHES; otherwise null
reason_code Why a single property was not identified — see below. Null when MATCHED
matches When MULTIPLE_MATCHES, the candidates, each with address, postcode, score and address_source. Candidates carry no UPRN or property data. Empty otherwise

Response (data) — property fields

Populated when match_status is MATCHED; null otherwise.

Field Description
address The identified property's address
property_type Type of property, for example Flat, Terraced, Semi-Detached, Detached or House. Null when not held
bedrooms Number of bedrooms. Null when not held
total_floor_area Floor area in square metres. Null when not held
source The dataset each of property_type, bedrooms and total_floor_area came from, for example EPC, price_paid (HM Land Registry) or Portal (property listings)
council_tax Council tax for the property — see below. Null when no council tax record is matched
epc The latest Energy Performance Certificate — see below. Null when no certificate is held

council_tax

Field Description
band Council tax band: A–H in England and Scotland, A–I in Wales
authority The billing authority
amount The annual charge for that band at that authority, in GBP. It is the band charge, not a property-specific bill. Null when not held
year The charging year amount applies to

epc

Field Description
rating Current energy rating, A–G
heating_type The main heating description on the certificate
main_fuel The main fuel as recorded on the certificate. Often null for Scottish properties
mains_gas_flag Y or N where the certificate records it; otherwise null. Not recorded on Scottish certificates
fuel_category The fuel, normalised: MAINS_GAS, COMMUNITY_HEAT, OFF_GRID_ELECTRIC, OFF_GRID_OIL, OFF_GRID_LPG, OFF_GRID_SOLID_FUEL or OFF_GRID_UNSPECIFIED. Null when it cannot be determined
lodgement_date The date the certificate was lodged

Use fuel_category rather than main_fuel in your logic: the raw fuel text is worded differently between certificates and between nations.

reason_code

Code Meaning
MULTIPLE_CANDIDATES Several properties qualified. Choose from matches
NO_CANDIDATE_PASSED_VERIFICATION Properties exist at the postcode, but none matched the address closely enough — often a missing or different flat or unit number
NO_CANDIDATE_RETRIEVED Nothing at the postcode resembled the address. Check the postcode is right
NO_RESOLVABLE_ADDRESS The address is a single name with no number, such as a town on its own

Credits

Charged only when a property is identified (MATCHED). MULTIPLE_MATCHES, NO_MATCH and rejected requests are not charged. The rate below applies to a MATCHED result, and the X-PDI-Credits-Deducted response header states what each accepted request cost.

💷 Credit Cost
4 credits per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

address
required
string (Address)
postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters
Array of Include (strings) or Include (null) (Include)

Optional response blocks: 'two_field_address', 'match_code'. Omit for the standard response. Unknown names are ignored.

Responses

Request samples

Content type
application/json
{
  • "address": "8 Wall Street, Blackpool",
  • "postcode": "FY1 2EG"
}

Response samples

Content type
application/json
Example
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 1,
  • "totalElements": 1,
  • "data": [
    • {
      }
    ]
}

Addresses by postcode

Return the addresses held at a full UK postcode.

Addresses are returned in house-number order, one entry per address.

Common use cases

  • Address selection — let a user pick their property from a list instead of typing it, for sign-up, checkout and quote forms.
  • Address validation — confirm an address exists at the postcode a user supplied before you store it.

Works well with

  • /v1/autocomplete/postcode/{postcode} — suggest full postcodes as a user types, then call this endpoint with the one they choose.
  • /pdi-property-enrichment/core-by-address — pass a selected address and postcode exactly as returned to get the UPRN, property attributes, council tax and EPC for that property.
  • /address/uprn-lookup-by-address — pass a selected address and postcode to get the UPRN only.

Tip: send the address and postcode values on unchanged. They are returned in the form those endpoints expect.

Request

Parameter Type Description Example
postcode string A full, valid UK postcode FY1 2EG

Response (data)

Field Description
address The address, without the postcode
postcode The postcode

A postcode with no addresses returns an empty data list.

Credits

Charged per call when at least one address is returned. A call that returns no addresses is not charged, and neither is a rejected request. When addresses are returned, the X-PDI-Credits-Deducted response header states the charge.

💷 Credit Cost
1 credit per request

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters

Responses

Request samples

Content type
application/json
{
  • "postcode": "FY1 2EG"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 41,
  • "totalElements": 41,
  • "data": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

PDI Sourcing Lists

Search for property deals including buy refurb refinance, biggest bargains, auction, planning approved, HMO Licensed and more properties and investment opportunities across the UK property market.

Auction Deals

This endpoint allows you to search for auction property deals in the UK market. You can search by either providing a valid UK postcode or a location name.

Request Body

Parameter Type Description Example Required
postcode string A valid UK postcode E16 2QU Either postcode or location
location string A valid UK location name London Either postcode or location
radius float Search radius in miles (0.25-10) 5 No (default: 3)
property_type string Type of property FLATS No (default: ALL)
min_price integer Minimum property price in GBP 100000 No
max_price integer Maximum property price in GBP 1000000 No
limit integer Maximum number of results (1-100) 20 No (default: 20)
pageNumber integer Page number for pagination 1 No (default: 1)

Response

Field Description Example
property_identifier Unique property identifier PDI-ZL01-65693544
first_published_date Date when property was first listed 2023-09-26T16:36:06
image Property images object {"thumbnail": "...", "image": "..."}
address Property address London W1F
postcode Full UK postcode W1F 0UH
property_type Type of property flat
num_bedrooms Number of bedrooms 2
num_bathrooms Number of bathrooms 0
price Property price in GBP 1650000
reduced_increased_by Price change percentage 0.00
agent Agent information object {"name": "...", "address": "...", "phone": "..."}
distance Distance from search location in miles 0.6
listing_url URL to property details https://dataapi.propertydealsinsight.com/r/L02/d/for-sale/details/65693544/

Note: At least one of postcode or location must be provided. Both fields cannot be empty.

Price Filtering: Use min_price and max_price to filter results by property price. If max_price is provided, it must be greater than or equal to min_price.

Search Radius: The radius parameter controls the search area around the specified postcode or location. Default is 3 miles with a range of 0.25 to 10 miles.

💷 Credit Cost
1 credit per 20 results (minimum 1 credit will be deducted for each request)

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

a valid UK postcode (string) or a valid UK postcode (null) (a valid UK postcode) [ 6 .. 9 ] characters
Default: ""
Location (string) or Location (null) (Location)

A valid UK location name

radius
number (radius in miles) [ 0.25 .. 10 ]
Default: 3

radius in miles

property_type
string (PropertyTypeEnum)
Enum: "ALL" "FLATS" "HOUSES" "LAND"
Minimum Price (integer) or Minimum Price (null) (Minimum Price)

Minimum property price in GBP

Maximum Price (integer) or Maximum Price (null) (Maximum Price)

Maximum property price in GBP

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "postcode": "E16 2QU",
  • "location": "London",
  • "radius": 3,
  • "property_type": "ALL",
  • "min_price": 100000,
  • "max_price": 1000000
}

Response samples

Content type
application/json
{}

PDTF / OPDA Sandbox

PDI's Data Provider endpoints into the OPDA Smart Property Data Trust Framework (PDTF) Sandbox operated by Raidiam.

Auth: OAuth2 client_credentials with private_key_jwt, presented over mTLS, issued by matls-auth.directory.pdtf.raidiam.io.

Responses are signed via Detached JWS in the x-jws-signature header (PS256, RFC 7515 + RFC 7797).

Routes live under /opda/... and are excluded from PDI's internal JWT and credit-deduction middleware.

OPDA hub webhook health probe

Use this URL as callbackUrl when registering at POST https://api.smve-staging.co.uk/opda/subscribe. GET confirms the endpoint is reachable; POST receives signed JWT notifications.

Responses

Response samples

Content type
application/json
{ }

OPDA PDTF Hub webhook callback

Receives transaction event notifications from the SMVE OPDA hub. The request body is a signed JWT (not JSON). All stages are logged to application logs and logs/webhooks/opda-hub/ for debugging.

Responses

Response samples

Content type
application/json
null

Retrieve a Property Pack by UPRN

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
X-SSL-Client-Fingerprint
string (X-Ssl-Client-Fingerprint)
Default:
Request Body schema: application/json
required
uprn
required
string (Uprn)
PropertyType (string) or null
Internalareasqm (integer) or Internalareasqm (null) (Internalareasqm)
Bedrooms (integer) or Bedrooms (null) (Bedrooms)
Bathrooms (integer) or Bathrooms (null) (Bathrooms)
Receptions (integer) or Receptions (null) (Receptions)
downloadPDF
boolean (Downloadpdf)
Default: false

Responses

Request samples

Content type
application/json
{
  • "uprn": "string",
  • "propertyType": "Detached",
  • "internalAreaSqM": 5,
  • "bedrooms": 15,
  • "bathrooms": 10,
  • "receptions": 10,
  • "downloadPDF": false
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "schemaVersion": "3.5.0",
  • "propertyPack": {
    • "address": {
      },
    • "dimensions": {
      },
    • "energyEfficiency": {
      },
    • "priceInformation": {
      },
    • "propertyType": "Flat",
    • "rooms": {
      },
    • "uprn": "100022100237",
    • "valuation": {
      }
    },
  • "verifiedClaims": [
    • { }
    ]
}

Retrieve a Property Pack by UPRN

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
X-SSL-Client-Fingerprint
string (X-Ssl-Client-Fingerprint)
Default:
Request Body schema: application/json
required
uprn
required
string (Uprn)
PropertyType (string) or null
Internalareasqm (integer) or Internalareasqm (null) (Internalareasqm)
Bedrooms (integer) or Bedrooms (null) (Bedrooms)
Bathrooms (integer) or Bathrooms (null) (Bathrooms)
Receptions (integer) or Receptions (null) (Receptions)
downloadPDF
boolean (Downloadpdf)
Default: false

Responses

Request samples

Content type
application/json
{
  • "uprn": "string",
  • "propertyType": "Detached",
  • "internalAreaSqM": 5,
  • "bedrooms": 15,
  • "bathrooms": 10,
  • "receptions": 10,
  • "downloadPDF": false
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "schemaVersion": "3.5.0",
  • "propertyPack": {
    • "address": {
      },
    • "dimensions": {
      },
    • "energyEfficiency": {
      },
    • "priceInformation": {
      },
    • "propertyType": "Flat",
    • "rooms": {
      },
    • "uprn": "100022100237",
    • "valuation": {
      }
    },
  • "verifiedClaims": [
    • { }
    ]
}

PDTF / OPDA Sandbox (Opaque Token)

Retrieve a Property Pack by UPRN (Opaque Token)

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:
Request Body schema: application/json
required
uprn
required
string (Uprn)
PropertyType (string) or null
Internalareasqm (integer) or Internalareasqm (null) (Internalareasqm)
Bedrooms (integer) or Bedrooms (null) (Bedrooms)
Bathrooms (integer) or Bathrooms (null) (Bathrooms)
Receptions (integer) or Receptions (null) (Receptions)
downloadPDF
boolean (Downloadpdf)
Default: false

Responses

Request samples

Content type
application/json
{
  • "uprn": "string",
  • "propertyType": "Detached",
  • "internalAreaSqM": 5,
  • "bedrooms": 15,
  • "bathrooms": 10,
  • "receptions": 10,
  • "downloadPDF": false
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "schemaVersion": "3.5.0",
  • "propertyPack": {
    • "address": {
      },
    • "dimensions": {
      },
    • "energyEfficiency": {
      },
    • "priceInformation": {
      },
    • "propertyType": "Flat",
    • "rooms": {
      },
    • "uprn": "100022100237",
    • "valuation": {
      }
    },
  • "verifiedClaims": [
    • { }
    ]
}

Retrieve a Property Pack by UPRN (Opaque Token)

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:
Request Body schema: application/json
required
uprn
required
string (Uprn)
PropertyType (string) or null
Internalareasqm (integer) or Internalareasqm (null) (Internalareasqm)
Bedrooms (integer) or Bedrooms (null) (Bedrooms)
Bathrooms (integer) or Bathrooms (null) (Bathrooms)
Receptions (integer) or Receptions (null) (Receptions)
downloadPDF
boolean (Downloadpdf)
Default: false

Responses

Request samples

Content type
application/json
{
  • "uprn": "string",
  • "propertyType": "Detached",
  • "internalAreaSqM": 5,
  • "bedrooms": 15,
  • "bathrooms": 10,
  • "receptions": 10,
  • "downloadPDF": false
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "schemaVersion": "3.5.0",
  • "propertyPack": {
    • "address": {
      },
    • "dimensions": {
      },
    • "energyEfficiency": {
      },
    • "priceInformation": {
      },
    • "propertyType": "Flat",
    • "rooms": {
      },
    • "uprn": "100022100237",
    • "valuation": {
      }
    },
  • "verifiedClaims": [
    • { }
    ]
}

PDTF / OPDA Sandbox (Reference Spec)

OPDA spec: current state (materialised property pack)

Returns the materialised Property Pack for a UPRN — i.e. the current-state body without the verified-claims envelope. This is the OPDA-spec equivalent of /appraisal/v1/property-pack/uprn. Body is signed via Detached JWS in x-jws-signature.

path Parameters
uprn
required
string (Uprn) [ 1 .. 24 ] characters
header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:

Responses

Response samples

Content type
application/json
null

OPDA spec: verified claims for a UPRN

Returns the full array of OIDC-IDA verified-claim envelopes (electronic_record and vouch) that back the property pack.

path Parameters
uprn
required
string (Uprn) [ 1 .. 24 ] characters
header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:

Responses

Response samples

Content type
application/json
null

OPDA spec: pointer-keyed provenance map

Returns a flat map of JSON Pointer → provenance descriptor so a consumer can answer 'who said this field and when' in a single lookup without walking the claims array.

path Parameters
uprn
required
string (Uprn) [ 1 .. 24 ] characters
header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:

Responses

Response samples

Content type
application/json
null

OPDA spec: add a claim (HACKATHON STUB — not persisted)

Accepts an OIDC-IDA verified-claim envelope for a UPRN. Stub: the claim is logged and a deterministic acknowledgement id is returned, but nothing is persisted. Returns 202 Accepted.

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

OPDA spec: subscribe to claim notifications (HACKATHON STUB)

Accepts a { uprn, callbackUrl } body and returns a subscription id. Stub: no callbacks will actually fire during the hackathon.

header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

OPDA spec: cancel a subscription (HACKATHON STUB)

path Parameters
subscription_id
required
string (Subscription Id) [ 1 .. 64 ] characters
header Parameters
X-SSL-Client-Verify
string (X-Ssl-Client-Verify)
Default:
X-SSL-Client-DN
string (X-Ssl-Client-Dn)
Default:
Authorization
string (Authorization)
Default:

Responses

Response samples

Content type
application/json
{
  • "detail": [
    • {
      }
    ]
}

Planning Application

Get Planning Applications

Get planning applications for a given postcode or latitude and longitude with radius

Request Body

Parameter Type Description Example
postcode string A valid UK postcode (optional if lat/lon or location provided) "E16 2QU"
latitude float Latitude coordinate (optional if postcode or location provided) 51.5074
longitude float Longitude coordinate (optional if postcode or location provided) -0.0796
location string Location name (optional if postcode or lat/lon provided) "London"
radius float Search radius in meters (default: 1000, max: 5000) 500
limit int Limit the number of results per page (default: 100, max: 10000) 20
pageNumber int Page number (default: 1) 1

Response Body

Parameter Type Description Example
local_authority string Local authority handling the application Birmingham
application_reference string Unique reference number 2025/04888/PA
application_link string URL to view full application details https://application.birmingham.gov.uk?ref=2025/04888/PA
application_type string Type of application Outline, Full, Conditions
application_size_category string Categorizes planning applications by development scale and potential impact, derived from statutory processing requirements, development complexity, and dwelling count. This categorization helps supporting Material Information and impact-based proximity filtering. Small, Medium, Large
application_description string Description of proposed work Application to determine if prior approval is required for a proposed change of use from Commercial, Business & Service (Use Class E) to 13 no. 1 bed residential dwellings (Use Class C3)
address_location string Property address 79 - 81 Chester Street Birmingham B6 4AE
postcode string Postcode B6 4AE
date_received string Date application was submitted 2025-08-29
date_validated string Date application was validated 2025-09-01
decided_date string Date application was decided 2025-09-15
target_decision_date string Target decision date 2025-09-15
status string Current status Awaiting decision, Registered
latitude float Latitude of the application 51.541340000000000
longitude float Longitude of the application -0.303650000000000
distance float Distance from search point in km 1.05

💷 Credit Cost
1 credit per result (minimum 1 credit will be deducted for each request)

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit the number of results per page) [ 1 .. 10000 ]
Default: 100
pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

a valid UK postcode (string) or a valid UK postcode (null) (a valid UK postcode) [ 6 .. 9 ] characters
Latitude (number) or Latitude (null) (Latitude)
Longitude (number) or Longitude (null) (Longitude)
Location (string) or Location (null) (Location)
Radius in meter (number) or Radius in meter (null) (Radius in meter)
Default: 1000

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "postcode": "E16 2QU",
  • "latitude": 52.4862,
  • "longitude": -1.8904,
  • "location": "London",
  • "radius": 50
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 200,
  • "pageNumber": 1,
  • "size": 200,
  • "totalElements": 833,
  • "totalPages": 5,
  • "data": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Get Planning Applications By Uprn

Get planning applications for a given UPRN and nearby applications.

Request Body

Parameter Type Description Example
uprn string A valid UK UPRN "10000000269"

Response Body

Parameter Type Description Example
local_authority string Local authority handling the application Birmingham
application_reference string Unique reference number 2025/04888/PA
application_link string URL to view full application details https://application.birmingham.gov.uk?ref=2025/04888/PA
application_type string Type of application Outline, Full, Conditions
application_size_category string Categorizes planning applications by development scale and potential impact, derived from statutory processing requirements, development complexity, and dwelling count. This categorization helps supporting Material Information and impact-based proximity filtering. Small, Medium, Large
application_description string Description of proposed work Application to determine if prior approval is required for a proposed change of use from Commercial, Business & Service (Use Class E) to 13 no. 1 bed residential dwellings (Use Class C3)
address_location string Property address 79 - 81 Chester Street Birmingham B6 4AE
postcode string Postcode B6 4AE
date_received string Date application was submitted 2025-08-29
date_validated string Date application was validated 2025-09-01
decided_date string Date application was decided 2025-09-15
target_decision_date string Target decision date 2025-09-15
status string Current status Awaiting decision, Registered
category string Category of application. If it is matching with the UPRN, then it will be 'source' otherwise it will be 'nearby' source, nearby
latitude float Latitude of the application 51.138136000000000
longitude float Longitude of the application -0.400334000000000
distance float Distance from search point in km 1.05

💷 Credit Cost
1 credit per result (minimum 1 credit will be deducted for each request)

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
uprn
required
string (Uprn)
no_of_nearest_small_applications
integer (No Of Nearest Small Applications)
Default: 20
no_of_nearest_medium_applications
integer (No Of Nearest Medium Applications)
Default: 3
no_of_nearest_large_applications
integer (No Of Nearest Large Applications)
Default: 2

Responses

Request samples

Content type
application/json
{
  • "uprn": "10000000269",
  • "no_of_nearest_small_applications": 10,
  • "no_of_nearest_medium_applications": 3,
  • "no_of_nearest_large_applications": 2
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 200,
  • "pageNumber": 1,
  • "size": 200,
  • "totalElements": 833,
  • "totalPages": 5,
  • "data": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Property Data Object

Get a consolidated UK property profile combining Land Registry sold prices, EPC data, UPRN, council tax, and network coverage by address or UPRN.

Get property data by UPRN

Returns a consolidated property data object for a UK property identified by UPRN (Unique Property Reference Number). Resolves the address from UPRN, then returns Land Registry, EPC, council tax, and network coverage data where available.

Query parameters

Parameter Type Description Example Optional
uprn string Unique Property Reference Number 100021300679

Example request

GET /v1/pdiproperty/data/uprn?uprn=100021300679

Response sections

The response combines property data from multiple sources where available.

1. propertyObjectEpc

Field Description
buildingReferenceNumber EPC building reference number
currentEnergyRating Current energy rating (A–G)
potentialEnergyRating Potential energy rating (A–G)
currentEnergyEfficiency Current energy efficiency score
potentialEnergyEfficiency Potential energy efficiency score
propertyType Property type from EPC register
builtForm Built form (e.g. detached, mid-terrace)
inspectionDate Date of the EPC inspection
lodgementDatetime Date and time the EPC was lodged
totalFloorArea Total floor area (sqm)
numberHabitableRooms Number of habitable rooms
address Property address
postcode Property postcode
latitude Latitude coordinate
longitude Longitude coordinate
uprn Unique Property Reference Number

2. propertyObjectPpd

Field Description
price Land Registry sold price
dateOfTrn Date of transaction
postcode Property postcode
duration Tenure (Freehold/Leasehold)
address Property address
ppdCtgType Property category (e.g. terraced, flat)

3. propertyObjectUprn

Field Description
uprn Unique Property Reference Number
latitude Latitude coordinate
longitude Longitude coordinate

4. broadbandCoverageResponse

Ofcom broadband availability including predicted download and upload speeds.

5. mobileCoverageResponse

Ofcom mobile network coverage for voice and data (EE, Three, O2, Vodafone).

6. councilTaxResponse

Council tax band and local authority information for the property.

Permissions required: CLIENT or PDI_Valuation_access

Authorizations:
Bearer Authentication
query Parameters
uprn
required
string
Example: uprn=100021300679

Unique Property Reference Number

header Parameters
userContext
required
string
Example: youremail@yourdomain.com

Email address of the API user

Responses

Response samples

Content type
application/json
{
  • "propertyObjectEpc": [
    • {
      }
    ],
  • "propertyObjectPpd": [
    • {
      }
    ],
  • "propertyObjectUprn": [
    • {
      }
    ],
  • "broadbandCoverageResponse": {
    • "PostCode": "HA51JH",
    • "Availability": [
      ],
    • "ErrorMessage": "Not found"
    },
  • "mobileCoverageResponse": {
    • "PostCode": "HA51JH",
    • "Availability": [
      ],
    • "ErrorMessage": "Not found"
    },
  • "councilTaxResponse": {
    • "isSuccess": true,
    • "message": "success",
    • "totalCount": 1,
    • "data": [
      ],
    • "code": 200,
    • "errorType": "TECHINCAL",
    • "getxPDIEndToEndId": "40c40930-ce7d-4989-b4b7-a696f9d8967f",
    • "result": { },
    • "lastSearchedDate": "2019-08-24T14:15:22Z",
    • "xpdirequestId": "string"
    }
}

Get property data by address

Returns a consolidated property data object for a specific UK property address. Includes Land Registry sold prices, EPC records, UPRN and coordinates, council tax band, and broadband and mobile coverage where available.

Query parameters

Parameter Type Description Example Optional
address string Full or partial UK property address 78, Durley Avenue
postcode string Valid UK postcode for the address HA5 1JH

Example request

GET /v1/pdiproperty/data/address?postcode=HA5 1JH&address=78, Durley Avenue

Response sections

The response combines property data from multiple sources where available.

1. propertyObjectEpc

Field Description
buildingReferenceNumber EPC building reference number
currentEnergyRating Current energy rating (A–G)
potentialEnergyRating Potential energy rating (A–G)
currentEnergyEfficiency Current energy efficiency score
potentialEnergyEfficiency Potential energy efficiency score
propertyType Property type from EPC register
builtForm Built form (e.g. detached, mid-terrace)
inspectionDate Date of the EPC inspection
lodgementDatetime Date and time the EPC was lodged
totalFloorArea Total floor area (sqm)
numberHabitableRooms Number of habitable rooms
address Property address
postcode Property postcode
latitude Latitude coordinate
longitude Longitude coordinate
uprn Unique Property Reference Number

2. propertyObjectPpd

Field Description
price Land Registry sold price
dateOfTrn Date of transaction
postcode Property postcode
duration Tenure (Freehold/Leasehold)
address Property address
ppdCtgType Property category (e.g. terraced, flat)

3. propertyObjectUprn

Field Description
uprn Unique Property Reference Number
latitude Latitude coordinate
longitude Longitude coordinate

4. broadbandCoverageResponse

Ofcom broadband availability including predicted download and upload speeds.

5. mobileCoverageResponse

Ofcom mobile network coverage for voice and data (EE, Three, O2, Vodafone).

6. councilTaxResponse

Council tax band and local authority information for the property.

Permissions required: CLIENT or PDI_Valuation_access

Authorizations:
Bearer Authentication
query Parameters
postcode
required
string
Example: postcode=HA5 1JH

Valid UK postcode for the address

address
required
string
Example: address=78, Durley Avenue

Full or partial UK property address

header Parameters
userContext
required
string
Example: youremail@yourdomain.com

Email address of the API user

Responses

Response samples

Content type
application/json
{
  • "propertyObjectEpc": [
    • {
      }
    ],
  • "propertyObjectPpd": [
    • {
      }
    ],
  • "propertyObjectUprn": [
    • {
      }
    ],
  • "broadbandCoverageResponse": {
    • "PostCode": "HA51JH",
    • "Availability": [
      ],
    • "ErrorMessage": "Not found"
    },
  • "mobileCoverageResponse": {
    • "PostCode": "HA51JH",
    • "Availability": [
      ],
    • "ErrorMessage": "Not found"
    },
  • "councilTaxResponse": {
    • "isSuccess": true,
    • "message": "success",
    • "totalCount": 1,
    • "data": [
      ],
    • "code": 200,
    • "errorType": "TECHINCAL",
    • "getxPDIEndToEndId": "40c40930-ce7d-4989-b4b7-a696f9d8967f",
    • "result": { },
    • "lastSearchedDate": "2019-08-24T14:15:22Z",
    • "xpdirequestId": "string"
    }
}

Property Evaluation

Get automated UK property sales valuations and recent sold price data. Send property details to receive an AVM valuation, confidence score, and comparable sale history for any UK address.

Get recent sold prices for a UK postcode area

Returns recent sold price records for properties in a UK postcode area. Use this to view Land Registry sale prices, sold dates, floor areas, and tenure for comparable homes near the property you are evaluating.

Request Body

Parameter Type Description Example Optional
postcode string Valid UK postcode to search recent sold prices for L18 0HX
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

UK postcode to search for recent sold property prices.

object (Header)

Header parameters

postcode
required
string

Postcode

town_city
required
string

Town

address
string

Address of the property

district
string

District

bedrooms
integer <int32>

Number of bedrooms

receptions
integer <int32>

Number of reception rooms

prop_type
string

Type of property

build_type
string

Type of building

internalarea
string

Internal area of the property

internalAreaFeet
string

Internal area of the property in feet

numberOfGarage
integer <int32>

Number of garage spaces

numberOfBaths
integer <int32>

Number of bathrooms

typeOfGarden
string

Type of garden

buildYear
string

Build era. Values: pre (Pre 1914), between (Between 1914-2000), new (After 2000). Only pre and new adjust valuation

currentCondition
string

Current condition of the property

parking
string

Parking availability

priceOrValuation
string

Price or valuation of the property

areaUnit
string

Area unit

finishQuality
string

Quality of finish

minPrice
number <float>

Minimum price

maxPrice
number <float>

Maximum price

uprn
string

UPRN

Responses

Request samples

Content type
application/json

Request: POST /v1/sold/price

{
  • "postcode": "L18 0HX"
}

Response samples

Content type
application/json

Response: POST /v1/sold/price

{
  • "isSuccess": true,
  • "soldPrices": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Get automated sales valuation for a UK property

Get an automated sales valuation for a UK property. Send the address, postcode, and property details, and our automated valuation model (AVM) analyses local sold prices, comparable properties, and EPC data to return an estimated market value, confidence level, and supporting property information.

Request Body

Parameter Type Description Example Optional
address string Full UK property address used to match sold prices and EPC records 5 Trafalgar Cottages, Tackleway
postcode string Valid UK postcode TN34 3DF
prop_type string Property type. Values: Detached, Terraced, Semi-Detached, Flat Terraced
bedrooms integer Number of bedrooms (also used with receptions for comparable data count) 2
internalarea string Internal floor area (in SQM) as a number (used in valuation calculation) 58
numberOfBaths integer Number of bathrooms. Adjustments apply for 2, 3 2 Y
receptions integer Number of reception rooms 0 Y
buildYear string Build era. Values: pre (Pre 1914), between (Between 1914-2000, no adjustment), new (After 2000). pre Y
currentCondition string Property condition. Values: excellent, good, modernisation, rundown, newBuildBasic, newBuildAverage, newBuildPremium good Y
typeOfGarden string Garden size. Values: small, large, huge large Y
parking string Number of parking spaces as a number. Values: 1, 2, 3 1 Y
uprn string Unique Property Reference Number. Optional; improves last sold and EPC matching if known 100062573471 Y
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Property address, postcode, characteristics, and standard PDI request header.

object (Header)

Header parameters

postcode
required
string

Postcode

town_city
required
string

Town

address
string

Address of the property

district
string

District

bedrooms
integer <int32>

Number of bedrooms

receptions
integer <int32>

Number of reception rooms

prop_type
string

Type of property

build_type
string

Type of building

internalarea
string

Internal area of the property

internalAreaFeet
string

Internal area of the property in feet

numberOfGarage
integer <int32>

Number of garage spaces

numberOfBaths
integer <int32>

Number of bathrooms

typeOfGarden
string

Type of garden

buildYear
string

Build era. Values: pre (Pre 1914), between (Between 1914-2000), new (After 2000). Only pre and new adjust valuation

currentCondition
string

Current condition of the property

parking
string

Parking availability

priceOrValuation
string

Price or valuation of the property

areaUnit
string

Area unit

finishQuality
string

Quality of finish

minPrice
number <float>

Minimum price

maxPrice
number <float>

Maximum price

uprn
string

UPRN

Responses

Request samples

Content type
application/json

Request: POST /v1/property_evaluation

{
  • "address": "5 Trafalgar Cottages, Tackleway",
  • "postcode": "TN34 3DF",
  • "prop_type": "Terraced",
  • "bedrooms": 2,
  • "buildYear": "new",
  • "currentCondition": "good",
  • "numberOfBaths": 2,
  • "typeOfGarden": "large",
  • "internalarea": "58",
  • "parking": "1",
  • "receptions": 0,
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "AGENT_PREMIUM_YEARLY",
    • "role": "AGENT_PREMIUM_YEARLY",
    • "X-PDI-Channel-Id": "PDI digital",
    • "X-PDI-Process-Name": "property insight"
    }
}

Response samples

Content type
application/json

Response: POST /v1/property_evaluation

{
  • "address": "5 Trafalgar Cottages, Tackleway",
  • "postcode": "TN34 3DF",
  • "propertyType": "T",
  • "noOfhabitablerooms": 2,
  • "totalfloorarea": 58,
  • "lastSoldPrice": "220000",
  • "lastSoldDate": "2013-08-07 00:00:00.0",
  • "priceChange": "55777",
  • "avgPricePerSqM": 4802.81,
  • "propertyInsightScore": 275777,
  • "dataPointAssessed": 3482,
  • "valuationVariance": 7.5,
  • "valuationPostcodematchLevel": "Exact Postcode",
  • "confidenceLevel": "High",
  • "duration": "Freehold",
  • "uprn": "100062573471",
  • "avgPricePerSqFt": 446.19,
  • "areaUnit": "SQM",
  • "isSuccess": true,
  • "xPDIEndToEndId": "460a23a2-e38b-40e4-a10f-1571cbd4b5bb",
  • "energyPerformance": {
    • "certificateNumber": "221661461052009120215405202019151",
    • "currentEnergyRating": "E",
    • "potentialEnergyRating": "E",
    • "currentEnergyEfficiency": "42",
    • "potentialEnergyEfficiency": "47",
    • "inspectionDate": "2009-12-01",
    • "lodgementDate": "2009-12-02",
    • "epcExpiryDate": "2019-12-02",
    • "buildingReferenceNumber": "1126127568",
    • "builtForm": "Mid-Terrace"
    }
}

Property Ownership

Company

Get list of properties owned by company along with title number, this list includes any overseas owners too

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

outcode
required
string (Outcode) [ 2 .. 4 ] characters ^[A-Z]{1,2}\d[A-Z\d]?

provide UK outcode

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "outcode": "BN14"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "limit": 20,
  • "pageNumber": 1,
  • "size": 2,
  • "totalElements": 2,
  • "totalPages": 1,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Get Rental Valuation for any property

This endpoint provides comprehensive rental valuation estimates for properties across the UK. Our algorithm analyzes local market data, property characteristics, and comparable rentals to deliver bank grade valuations.

Request Body

Parameter Type Description Example Required
postcode string A valid UK postcode HA1 1SE Either postcode, location, or latitude/longitude
location string A valid UK location name London Either postcode, location, or latitude/longitude
latitude string Latitude of the location 51.5074 Either postcode, location, or latitude/longitude
longitude string Longitude of the location -0.1278 Either postcode, location, or latitude/longitude
property_type string Type of property House Yes
number_of_beds string Number of bedrooms 3 Yes

Response

Field Description Example
rentalvaluation Monthly rental valuation estimate in GBP 3517
isSuccess Request success status true
message Response message or error details "Success"
Authorizations:
Bearer Authentication
Request Body schema: application/json
required

Rental valuation request parameters

object (Header)

Header parameters

location
string

A valid UK location (i.e. HA1 1SE, London, etc.)

postcode
string

A valid UK postcode

latitude
string

Latitude of the location

longitude
string

Longitude of the location

property_type
required
string

Type of the property (e.g., house, apartment)

number_of_beds
required
string

Number of bedrooms in the property

Responses

Request samples

Content type
application/json
Example

Using Postcode

{
  • "postcode": "HA1 1SE",
  • "property_type": "Detached",
  • "number_of_beds": "3",
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userPackage": "API Enterprise 30K",
    • "role": "API Enterprise 30K",
    • "X-PDI-Channel-Id": "PDI Data API",
    • "X-PDI-Process-Name": "rental valuation"
    }
}

Response samples

Content type
application/json

Successful Response

{
  • "isSuccess": true,
  • "rentalvaluation": 3368,
  • "xPDIEndToEndId": "28374773-8da9-4cf1-82e3-18afa5d5db42"
}

Water Supplier

Find water and sewerage supplier by postcode

Returns water and sewerage supplier information for the given UK postcode using PDI_PortalsData.pdi_postcode database and Ofwat boundary data.

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name
Request Body schema: application/json
required
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

The maximum number of results to return.

pageNumber
integer (Pagenumber) >= 1
Default: 1

Page number

postcode
required
string (a valid UK postcode) [ 6 .. 9 ] characters

Responses

Request samples

Content type
application/json
{
  • "limit": 20,
  • "pageNumber": 1,
  • "postcode": "HA1 1SE"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 1,
  • "data": [
    • {
      }
    ]
}

Get complete list of water and sewerage companies

Returns a comprehensive list of all water supply and sewerage service companies operating in England and Wales.

header Parameters
X-PDI-Authorization
required
string (X-Pdi-Authorization)
Example: eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyX25hbWUiOiJt...
X-PDI-Channel-Id
required
string (X-Pdi-Channel-Id)
Example: PDI Data API
X-PDI-End-To-End-Id
required
string (X-Pdi-End-To-End-Id)
Example: 6e296dc9-4ea7-4483-b6bc-79758b6b5139
X-PDI-Process-Name
required
string (X-Pdi-Process-Name)
Example: property insight
role
required
string (Role)
Example: API Enterprise 30K
userContext
required
string (Usercontext)
Example: youremail@yourdomain.com
userPackage
required
string (Userpackage)
Example: API Enterprise 30K
X-PDI-API-Name
string (X-Pdi-Api-Name)
Example: api name

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "",
  • "size": 2,
  • "data": [
    • {
      },
    • {
      }
    ]
}

Get Water Supplier by Postcode

Get water supplier details by postcode.

Authorizations:
Bearer Authentication
Request Body schema: application/json
required
object (Header)

Header parameters

postcode
required
string

Postcode

Responses

Request samples

Content type
application/json
{
  • "header": {
    • "userContext": "youremail@yourdomain.com",
    • "userToken": "eyJhbGciOiJSUzI1NiJ9.eyJ1c",
    • "userPackage": "API Enterprise 30K",
    • "role": "API Enterprise 30K",
    • "X-PDI-Channel-Id": "PDI Data API",
    • "X-PDI-Process-Name": "property insight",
    • "X-PDI-API-Name": "api name",
    • "X-PDI-End-To-End-Id": "6e296dc9-4ea7-4483-b6bc-79758b6b5139",
    • "X-PDI-RequestId": "43555"
    },
  • "postcode": "BT1 1GJ"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "isSuccess": true,
  • "message": "success",
  • "limit": 20,
  • "pageNumber": 1,
  • "size": 1,
  • "totalElements": 1,
  • "totalPages": 1,
  • "data": [
    • {}
    ],
  • "metadata": { },
  • "errorType": "TECHINCAL",
  • "getxPDIEndToEndId": "40c40930-ce7d-4989-b4b7-a696f9d8967f",
  • "result": { },
  • "lastSearchedDate": "2019-08-24T14:15:22Z",
  • "xpdirequestId": "string"
}