Leaseholds
Retrieve leasehold records for a property by property_id / uprn / udprn.
[Usage & billing] Each call costs 6 credits.
query Parameters
property_idPropalt Property ID. Provide exactly one of property_id, uprn, or udprn.
uprnUnique Property Reference Number (OS). Provide exactly one of property_id, uprn, or udprn.
udprnUnique Delivery Point Reference Number (Royal Mail). Provide exactly one of property_id, uprn, or udprn.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Leasehold records for a property
property_idProperty ID.
uprnUnique Property Reference Number.
Register order number.
Description of the registered property.
Price paid for the lease.
Description of the associated property.
Date the lease was granted.
Date the lease expires.
Length of the lease term.
Lease term description.
Agent
Retrieve estate agent branches by first_postcode or brand_id with pagination.
[Usage & billing] Each call costs 2 credits. Every page is a separate billable call: page is a 0-based index and limit sets the page size (default 100, max 100). Fetch only the pages the user actually asked for; do not page through a whole result set speculatively.
query Parameters
first_postcode^([A-Za-z]{1,2}\d[A-…Outward postcode (first part) of the agent branch.
brand_id^[a-zA-Z0-9_]+$Brand identifier for the agent group.
limitMaximum number of results to return.
pagePage number for pagination (0-based).
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Agent branches matching the filter
Name of the estate agent branch.
Outward postcode of the agent branch.
Full address of the agent branch.
Number of properties currently listed for sale by this branch.
Number of properties currently listed for let by this branch.
Brand identifier for the agent group.
Landlords
Find landlord/proprietor audiences for properties in one UK area. Provide one area selector: first_postcode, sector_code_list (max 4), or polygon_str (max 15 sq miles). Filter by area ownership, linked agents, director age/count, portfolio size, proprietor type, purchases, sale/rental listings.
[Usage & billing] Each call costs 200 credits, one of the most expensive tools available here. Every page is a separate billable call: page is a 0-based index and limit sets the page size (default 20, max 20). Fetch only the pages the user actually asked for; do not page through a whole result set speculatively. If you only need a total, call once with return_type='count' instead of paging. Check with the user before fetching further pages.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
UK outward postcode (e.g. 'SA1'). Provide exactly one of first_postcode, sector_code_list, or polygon_str.
List of UK postcode sectors (e.g. ['SA1 1', 'SA1 2']), max 4. Provide exactly one of first_postcode, sector_code_list, or polygon_str.
Polygon geometry string defining the search area (max 15 sq. miles). Provide exactly one of first_postcode, sector_code_list, or polygon_str.
limitMaximum number of properties to return. Default 20, max 20.
page0-based page index. Offset = page * limit. Default 0.
return_type'count' returns a count only; 'data' returns full property records. Default 'data'.
return in selected area landlords only: 1:True, 0:Flase, None:ignore
filter the number of selected area landlords's linked national agents
only return_object is company then director_age will be considerd, valid input N or N-M ,rent:18<=N<M<80
only return_object is company then director_count will be considerd, valid input N or N-M ,1<=N<M<100
portfolio_size valid input N or N-M ,1<=N<M<=40000
valid options: private, business, house_association, local_authority
filter the number of landlords's national recently_purchased_count
filter the number of landlords's national for_rent_count
filter the number of landlords's national for_sale_count
Filter to specific OS AddressBase property classes, e.g. shops, offices, restaurants. Accepts a 1-character top-level code, which expands to every code under it (e.g. 'C' = all Commercial); a 2-character group key, which expands to every code in that group, or an exact 2-character class (e.g. 'CR' = all Retail); or a full 4/6-character class code (e.g. 'CR08' = Shop, 'CO01' = Office). A 4- or 6-character code matches that class exactly and does not include the codes beneath it; to cover a whole family, use the 1- or 2-character group code, or list the specific codes. Multiple values are OR'd together; case-insensitive; max 20 items. Look up valid codes, labels, and national address counts with GET /property/classifications before filtering — an unrecognised value returns 422. For this endpoint, matching landlords are those with at least one property in any of the given classes (e.g. find landlords owning a cafe).
Responses
ListResponse containing count plus matching landlord records. For return_type='count', data is empty; for return_type='data', data contains up to limit LandlordsOutput records.
countOS AddressBase class codes from the request's class_list that are valid but have zero addresses nationally. Only present when class_list was supplied and at least one requested code is nationally unpopulated; omitted otherwise.