API DocsProperty Market Intel
Getting StartedServiced Accommodation
AI & Integrations
Pricing
API Reference
1. Property Identity & Lookup
2. Valuations & Pricing
3. Rental Market Intelligence
5. Listings & Sourcing
6. Location Intelligence
7. Environmental & Risk
8. Planning & Regulatory
9. Account & Platform
Free Tier

Get 100 credits free, no card required. Try every endpoint with your own key.

Get a free keyNo credit card · cancel anytime

STR Revenue Estimate (property-level)

POST50 credits
POST/valuations/str-estimate

12-month revenue projection for a specific property operated as short-term-let — monthly ADR, occupancy, revenue PCM, RevPAR, annual totals.

Overview

Runs a similarity-weighted regression over up to ~100 comp listings within 2 km, weighted by resemblance to the subject property on beds, baths, and property type.

Returns a month-by-month breakdown so seasonality is visible.

Why this endpoint exists

A property-level 12-month revenue projection runs per-request and is callable from your own product — which means you can embed it in a site, pass it through an agent, or batch it over a pipeline.

For property management companies specifically, a £0.35 API call has ~£140–£200 LTV when embedded as a lead widget — a 400–600× return.

Body parameters
uprnstringOne of

Property UPRN (preferred — we auto-detect beds/baths/type if omitted).

postcodestringOne of

Full postcode (for off-market or new-build properties).

lat+lngOne of

Exact coordinates.

bedroomsintegerRequired

Bedroom count — the biggest driver of projected revenue.

bathroomsintegerOptional

Defaults to max(1, bedrooms - 1).

property_typestringOptional

house | apartment. Defaults inferred from nearby comps.

finish_qualitystringOptional · default average

below_average | average | above_average | very_high. Shifts ADR ±10% around the comp median.

include_comparablesbooleanOptional · default false

If true, response includes the listing-level comps used.

Response Schema
location_label

Human-readable location label.

currency

Always "GBP".

projected_monthly

{ adr, occupancy_pct, revenue_pcm, revpar }.

projected_annual

{ revenue, occupancy_pct, high_season_months, low_season_months }.

monthly_breakdown

Array of 12 × { month, adr, occupancy_pct, revenue_pcm, revpar }.

comps

{ listings_sampled, radius_m, similarity_weight_avg, comparables: [...] } (comparables only when include_comparables=true).

confidence

"High" | "Medium" | "Low".

Example

RequestLive key
curl -X POST https://pmi-api-beta-7tvvt.ondigitalocean.app/v1/valuations/str-estimate \
  -H "Authorization: Bearer pmi_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "uprn": "72226528",
    "bedrooms": 2,
    "bathrooms": 1,
    "property_type": "apartment",
    "finish_quality": "above_average"
  }'

Try this endpoint with your own key

100 free credits, no card required.

Sign up free →
Response200 OK
{
  "location_label": "BA1 1, Bath",
  "currency": "GBP",
  "projected_monthly": {
    "adr": 156,
    "occupancy_pct": 71,
    "revenue_pcm": 3355,
    "revpar": 111
  },
  "projected_annual": {
    "revenue": 40260,
    "occupancy_pct": 71,
    "high_season_months": [
      "Jun",
      "Jul",
      "Aug"
    ],
    "low_season_months": [
      "Jan",
      "Feb",
      "Nov"
    ]
  },
  "monthly_breakdown": [
    {
      "month": "Jan",
      "adr": 128,
      "occupancy_pct": 52,
      "revenue_pcm": 2066,
      "revpar": 67
    },
    {
      "month": "Jun",
      "adr": 178,
      "occupancy_pct": 84,
      "revenue_pcm": 4484,
      "revpar": 150
    }
  ],
  "comps": {
    "listings_sampled": 42,
    "radius_m": 1800,
    "similarity_weight_avg": 0.74
  },
  "confidence": "High"
}

More about this endpoint

Use Cases
Primary

Property management companies embedding an instant revenue-projection widget on their website as a lead-capture tool.

1

Property management companies embed a "what could your property earn?" widget on their homepage. Owner enters address + bedrooms, sees a £38k/yr projection in 2 seconds, then clicks "Book a management consultation". At ~£0.35 per call and 2% conversion to managed clients (£7–10k/yr fee), every API call is worth ~£140–£200 in LTV. Break-even conversion is 1 in 20,000.

2

Pre-acquisition underwriting: £420k 3-bed semi in York → projected £48.2k/yr, 64% occupancy, ADR £207. At 35% costs + 6% finance the deal cash-flows. You offer.

3

Strategy decision on a current BTL: £260k 2-bed flat letting for £1,100 pcm. str-estimate says £32k/yr STR = £2,670 pcm gross = £1,730 pcm net. STR beats long-let by 57%.

4

SA-mortgage verification: Lenders (Together, Paragon, Precise) need third-party revenue projections. This endpoint returns one in <2s with a reproducible methodology.

5

Portfolio screening at scale: 200 acquisition targets/year × 50 credits = 10k credits — fits comfortably in the Pro tier cap.

6

Due diligence in SA-sale transactions: Brokers need independent revenue numbers to show buyers — more trusted than self-reported P&L.

Embedded Widget Economics
Scenario: Property management company website lead widget
Cost per submission

50 credits ≈ £0.35 (Pro tier, £0.007/credit)

Typical lead → managed client conversion

~2%

Typical SA management fee

15–20% of revenue = £7k–£10k/yr per client

Effective LTV per £0.35 API call

~£140–£200 (2% conversion × 1-year retention)

Break-even conversion rate

1 in 20,000 — you'll beat that by 3 orders of magnitude

Implementation Notes
01

Cache responses by UPRN for 30 days — most owners share their result, friends re-request. Cuts costs further.

02

Use include_comparables=false (default) so responses are small and fast to render.

03

Set finish_quality=average on public widgets; let customers upgrade during onboarding.

04

Add your 15–20% management fee deduction to the displayed number ("You keep £38,400/yr after our fee") — converts better than the gross figure.

05

Server-side proxy the call with a site-wide key; never expose your Bearer token in the browser.

06

Rate-limit per-IP or per-session in your own code — PMI rate limits are per-API-key, not per-end-user.

Base URL: https://pmi-api-beta-7tvvt.ondigitalocean.app/v1API version 1.1