Call the PDI Property Pack APIs
in under 15 minutes.

01Environments & URLs

PDI exposes the same property data through two API surfaces on the same host. Pick whichever fits your client — auth, mTLS, signing and rate limits are identical.

OAuth client configuration

Drop these into your config.py (replace CLIENT_ID with the value shown on your application detail page in the Raidiam directory):

CLIENT_ID = "https://rp.directory.pdtf.raidiam.io/openid_relying_party/<your-app-uuid>"
SCOPES    = "property-pack"
TOKEN_URL = "https://matls-auth.directory.pdtf.raidiam.io/token"

02API endpoints & what they return

All endpoints below sit under https://sandbox-pdtf.propertydealsinsight.com. Every successful GET response carries a Detached JWS signature in the x-jws-signature header.

A — PDI native (single call, full property pack)

{
  "uprn":           "100021300679",
  "propertyType":   "Terraced",
  "internalAreaSqM": 100,
  "bedrooms":       4,
  "bathrooms":      1,
  "receptions":     2
}

curl https://sandbox-pdtf.propertydealsinsight.com/opda-opaque/appraisal/v1/property-pack/uprn \
  --cert path/to/transport.pem --key path/to/transport.key \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"uprn":"100021300679","propertyType":"Terraced","internalAreaSqM":100,"bedrooms":4,"bathrooms":1,"receptions":2}'

B — OPDA reference spec (sliced)

If your client was written against the OPDA Property-Pack reference spec, call the slice you need. All three GET slices share the same claim IDs so you can stitch them client-side without re-fetching.

Sample UPRNs

Use any of these UPRNs to explore the sandbox. They cover a mix of property types, locations and data completeness so you can see enrichment in action.

100070482318  100022539219  100071300442  10093560622   100022521703
217048506     100022598809  10090437590   217030257     202065685
100022725034  100022750316  217075263     34095084      100070405179
217018783     10091059238   100022793956  217070918     100071428730
217067551     200015088     100022599518  100070446046  100071271440
217071178     100070385755  217016110     100022802693  100022780345
10033622251   34019425      5009691       100070561271  100022778424
12003281      100022528887  202064990     202219254     5114578
34171489      100022558342  100070565556  100022562980  100022530012
100022540400  200082387     217028345     217126195     5167116

03Create an application

You provision an application in the Raidiam directory. This binds your organisation to a Client ID, an OAuth flow and your certificates.

1. Read the official OPDA sandbox guide. Open the Introduction to the Sandbox Technical Guide — it covers org onboarding and directory roles.

   

2. Open Applications → New Application in the Raidiam directory.

   

3. Enable federation, give the application a client name and version, and upload a logo (a placeholder is fine).

   

4. Set a redirect URL. A placeholder value (e.g. https://localhost/callback) is enough for sandbox use.

   

5. Critical final step. Enable Sign Request Object, set the Signed Response Algorithm to PS256, and set Token Auth Method to private_key_jwt. These three settings must match exactly or token issuance will fail.

   
   Don't skip. PS256 + private_key_jwt + Sign Request Object on. Any other combination will return 401 from the token endpoint.

04Create application certificates

You need two certificates per application: a Transport cert (used for mTLS to the PDI data API) and a Signing cert (used to sign the private_key_jwt assertion at the token endpoint).

1. Open your application and go to the App Certificates section.

   

2. Click New Certificate and choose Transport.

   

3. Run the openssl command that the directory displays. It generates two files locally: a .key (keep private) and a .csr (upload).

   

4. Upload the .csr in the next screen and save.

   

5. Download the issued .pem from the actions menu and store it next to the matching .key.

   

6. Repeat steps 2–5 for a Signing certificate. You should end with two pairs of files — a transport .key/.pem and a signing .key/.pem.

   

05Run the sample Python script

Our reference client handles the full flow: build a signed private_key_jwt, exchange it for a bearer token at Raidiam, call the PDI Property Pack API over mTLS, verify the Detached JWS, then save interactive/PDF report artefacts when links are returned.

1. Download the sample script bundle. Grab the zip and unpack it somewhere convenient — it contains access_api_pdi_with_opaque.py, requirements.txt and example.config.py.

   # https://developers.propertydealsinsight.com/opda-pdtf/sample_script_to_call_PDI_API_19052026.zip
   curl -O https://developers.propertydealsinsight.com/opda-pdtf/sample_script_to_call_PDI_API_19052026.zip
   unzip sample_script_to_call_PDI_API_19052026.zip
   cd sample_script_to_call_PDI_API_19052026

2. Create a Python virtual environment.

   # macOS / Linux / Windows
   python -m venv env

3. Activate the environment.

   # macOS / Linux
   source env/bin/activate
   
   # Windows PowerShell
   .\env\Scripts\Activate.ps1

4. Install dependencies.

   pip install -r requirements.txt

5. Create config.py by copying the contents of example.config.py.

6. Copy your Client ID from the application detail page in the Raidiam directory into config.py.

   
   

7. Set the certificate paths in config.py to point at your transport .pem/.key and signing .pem/.key.

8. Run the script. It exchanges the JWT assertion for a bearer token at Raidiam, then calls the PDI Property Pack API.

   python access_api_pdi_with_opaque.py

   To target a specific endpoint and UPRN:

   python access_api_pdi_with_opaque.py --endpoint property_pack_uprn             --uprn 100021300679
   python access_api_pdi_with_opaque.py --endpoint property_pack_interactive_uprn --uprn 100021300679
   python access_api_pdi_with_opaque.py --endpoint current_state                  --uprn 100021300679
   python access_api_pdi_with_opaque.py --endpoint claims                         --uprn 100021300679

   When you call the interactive variant, the script saves any returned interactive HTML and PDF reports under ./output/, so your team can immediately review and share client-ready files.

9. Tweak the payload. The default request body is set inside the script — swap the UPRN to explore different properties, and keep downloadPDF: true enabled when you want PDF links returned by the interactive route.

   

06Sample response

Truncated PDTF v3.5.0 Property Pack. The full schema includes valuation, comparables, EPC, council tax, flood risk, planning, utilities and sold-price history, each wrapped in a signed verifiedClaim.

{
  "transactionId": "9c19e3f1-74a6-4ef4-901f-c444391f2c27",
  "schemaVersion": "3.5.0",
  "propertyPack": {
    "address": {
      "line1": "31 Oaklands, Argyle Road, London",
      "postcode": "W13 0HG",
      "uprn": "12003281"
    },
    "valuation": {
      "avm": 428814,
      "avmConfidence": 0.9,
      "avmRangeLow": 396653,
      "avmRangeHigh": 460975,
      "rentalPcm": 1946,
      "yieldGross": 0.0545
    },
    "energyEfficiency": { "epcRating": "C", "epcEfficiency": "79" },
    "councilTax":      { "band": "D", "localAuthority": "Ealing", "annualCharge": "2138.53" },
    "floodRisk":       { "riverAndSea": "Very low", "surfaceWater": "Low" }
  },
  "verifiedClaims": [
    {
      "id": "60e1b85a-f78e-58b8-8769-a0e4d31414fc",
      "verification": { "trust_framework": "uk_pdtf", "time": "2026-05-18T12:36:56Z" },
      "claims": {
        "/propertyPack/valuation/avm": 428814,
        "/propertyPack/valuation/avmConfidence": 0.9
      }
    }
  ]
}

07Limits, errors & support

Sandbox rate limits

• 500 calls per org over 14 days.
• 5 calls per minute per org.
• One UPRN per call.
• Sandbox data only — not for live transactions.

Exceeding a limit returns 429 with a JSON body explaining when to retry.

Want more after the hackathon?

Get help

• Raidiam onboarding → paul@openpropdata.org.uk
• Calling the PDI API → support@propertydealsinsight.com
• Source & samples → MIT-licensed Python client in this folder

08Next steps — talk to PDI

When you’re ready to move past the sandbox — whether that’s a live integration, a white-labelled property pack, or a partnership conversation — here are the fastest ways in.