---
title: "Determine local rental yields"
method: GET
path: "/yields"
---

# Determine local rental yields

`GET /yields`

## Request

- Base URL: `https://api.propertydata.co.uk`
- URL: `https://api.propertydata.co.uk/yields`
- Auth: HTTP bearer

Costs 1 credit per call.

## Query parameters

- `postcode` string
- `location` string
- `town` string

## Response `200`

Successful response

- object
  - `status` string
  - `postcode` string
  - `postcode_type` string
  - `url` string
  - `bedrooms` integer
  - `data` object
    - `long_let` object
      - `points_analysed` integer
      - `radius` string
      - `gross_yield` string
  - `process_time` string: Server processing time in seconds

## Other responses

- `4XX`: Error response. Common codes: X02 missing key (400), X03 invalid key (422), X04 credit limit exceeded (403), X06/X07 missing or invalid location input (400/422), X08 insufficient data for location (404), X13 free trial limit exceeded (403), X14 rate limited (429), X20 server busy, retry after 60 seconds (503).

---

[API](https://skmtc.dev/propertydata/apis/propertydata-api.md) · [All operations](https://skmtc.dev/propertydata/apis/propertydata-api/llms.txt) · [OpenAPI document](https://skmtc.dev/propertydata/apis/propertydata-api/revisions/38ab011f2f4c?raw)