Overview
The address must include a full UK postcode. Postcode pages list every sold property on the street. This API parses the input itself — house number, street, postcode, building name — then ranks those records. match is set only for an exact property. matches is always the candidate list.
Exact input
4 Chilcombe Close, LE4 2FP → one UPRN, confidence high.
Partial input
Chilcombe Close, LE4 2FP → match is null; matches lists the street.
Authentication
On RapidAPI, send your RapidAPI application key. The origin key is injected by RapidAPI and is not required in client code.
X-RapidAPI-Key: YOUR_RAPIDAPI_KEY X-RapidAPI-Host: addresstouprn.p.rapidapi.com
Direct calls to this origin use X-API-Key or X-RapidAPI-Key with the provider secret.
Endpoint
GET /uprn/v1/lookup
RapidAPI host addresstouprn.p.rapidapi.com
curl -s "https://addresstouprn.p.rapidapi.com/uprn/v1/lookup?address=4%20chilcombe%20close%20le4%202fp" \ -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \ -H "X-RapidAPI-Host: addresstouprn.p.rapidapi.com"
Parameters
| Name | In | Type | Description | |
|---|---|---|---|---|
address |
query | string | required | UK address including a full postcode. House number and street improve the match. Alias: q. |
limit |
query | integer 1–20 | optional | How many rows to return in matches. Default 10. |
Response body
Always wrapped in data. First lookup can take 10–20 seconds.
| Field | Type | Meaning |
|---|---|---|
query | string | Normalised input. |
parsed | object | houseNumber, houseName, street, locality, postcode, flat. |
match | object | null | Exact property only. Null if the house number is missing or not found. |
matches | array | Ranked possibles. Includes the exact hit first when present. |
alternatives | array | Same list without the exact hit. |
matchCount | integer | Candidates before limit is applied. |
warning | string | null | Set when we could not pin a single property. |
Match object
| Field | Type | Meaning |
|---|---|---|
uprn | string | Unique Property Reference Number. |
address | string | Canonical address from the source record. |
confidence | string | high, medium, or low. |
exactHouseNumber | boolean | True when the house number is the same as the query. |
score | integer | Internal rank. Higher is better. Neighbours are often negative. |
latestSalePrice | integer | null | Last known sale, GBP, unformatted. |
latestSaleYear | integer | null | Year of that sale. |
Examples
Exact house number
4 chilcombe close le4 2fp
{
"data": {
"query": "4 chilcombe close le4 2fp",
"parsed": {
"houseNumber": "4",
"street": "chilcombe close",
"postcode": "LE4 2FP"
},
"match": {
"uprn": "246503937",
"address": "4 Chilcombe Close, Leicester, LE4 2FP",
"confidence": "high",
"exactHouseNumber": true,
"latestSalePrice": 75500,
"latestSaleYear": 2006
},
"matches": [ "…4 first, then neighbouring numbers…" ],
"warning": null
}
}
Street or postcode only
Chilcombe Close LE4 2FP — match is null; use matches.
{
"data": {
"match": null,
"matches": [
{ "uprn": "246503937", "address": "4 Chilcombe Close, Leicester, LE4 2FP" },
{ "uprn": "246503940", "address": "6 Chilcombe Close, Leicester, LE4 2FP" }
],
"warning": "No house number supplied; possible UPRNs listed"
}
}
House number not on the page
match is null. Nearby properties remain in matches. We will not return number 6 when you asked for 99.
Errors
| HTTP | error | When |
|---|---|---|
| 400 | bad_request | address missing, or no full UK postcode in the address. |
| 401 | unauthorized | Missing or invalid API key. |
| 502 / 504 | — | Upstream timeout. Retry once; allow 90 seconds. |
{
"error": "bad_request",
"message": "A UK postcode is required in address",
"details": { "address": "40 empire road perivale" }
}
Limits
Free RapidAPI BASIC is capped per month. The origin is polite to the source site (~0.4 requests/second). First response may take 10–20 seconds. This product is unofficial and is not affiliated with Zoopla or GeoPlace.