openapi: 3.1.0
x-stoplight:
id: r3ay7phqkp8ld
info:
version: '1.0'
title: Property Feed
description: The Street.co.uk Property Feed API is designed to power your agency's website and property
search functionality.
summary: The Street.co.uk Property Feed API is designed to power your agency's website and property
search functionality.
contact:
name: Street API Development Team
url: street.co.uk
email: apis@street.co.uk
servers:
- url: https://street.co.uk/api/property-feed/v1
description: The live/production API. Tokens for this can self generated via the settings area of the
CRM.
- url: https://demo.street.co.uk/api/property-feed/v1
description: The demo API. Tokens can be requested from the support team at Street.co.uk.
paths:
/properties/{property}:
parameters:
- schema:
type: string
format: uuid
name: property
in: path
required: true
description: The UUID of the Property.
get:
summary: Retrieve a Property
tags:
- Properties
parameters:
- $ref: '#/components/parameters/include'
responses:
'200':
description: The API endpoint responds with a JSON object containing detailed information about
the property identified by the provided `UUID`. The response includes various attributes related
to the property, such as its ID, address, description, price, number of bedrooms, and other
relevant details.
content:
application/vnd.api+json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/Property'
included:
$ref: '#/components/schemas/PropertyIncludes'
examples:
Example 1:
value:
data:
type: property
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
branch_uuid: b8e564e2-b92d-49d7-8331-85bb2766d8f8
inline_address: Rivendell, Main Street
public_address: Main Street, Follifoot, HG3
postcode: HG3 1DU
bedrooms: 3
bathrooms: 1
receptions: 2
floor_area: null
plot_area: null
land_area: null
property_type: House
property_style: None
is_commercial: true
property_age_bracket: 1970 - 1990
construction_year: null
status: Sold STC
sale_status: Sold STC
letting_status: For Sale and To Let
dual_listing: false
owner_label: Owner
tenure: Freehold
tenure_notes: null
lease_expiry_year: '2022'
lease_expiry_date: null
public_url: https://street.co.uk/platform/properties/0ed2e2f4-b697-4c78-a801-d805b75a75aa
viewing_booking_url: null
created_at: '2022-02-28T11:46:20+00:00'
updated_at: '2022-06-20T13:30:25+01:00'
custom_meta_data:
- meta_name: meta value
property_urls:
- media_type: audio_tour
media_url: string
last_instructed_sales_at: '2022-02-28T11:46:20+00:00'
last_instructed_lettings_at: '2022-02-28T11:46:20+00:00'
last_exchanged_at: '2022-02-28T11:46:20+00:00'
last_completed_at: '2022-02-28T11:46:20+00:00'
relationships:
address:
data:
type: address
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
details:
data:
type: details
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
salesListing:
data:
type: sales_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
lettingsListing:
data:
type: lettings_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
primaryImage:
data:
type: primary_image
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
rooms:
data:
- type: room
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
images:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
floorplans:
data:
- type: floorplan
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
features:
data:
- type: feature
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
outsideSpaces:
data:
- type: outsideSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
parkingSpaces:
data:
- type: parkingSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
epc:
data:
type: epc
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
additionalMedia:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
tags:
data:
- type: tag
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
brochure:
data:
type: brochure
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
development:
data:
type: development
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
included:
- type: address
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
anon_address: Beattock, Moffat, DG10
line_1: Telford Manor House
line_2: Beattock
line_3: Moffat
line_4: null
line_5: null
town: Moffat
country: United Kingdom
postcode: DG10 9SG
inline: Telford Manor House, Beattock, Moffat, DG10 9SG
longitude: -3.4548511
latitude: 55.3109071
royal_mail:
postcode: string
post_town: string
thoroughfare: string
building_name: string
building_number: string
department_name: string
organisation_name: string
sub_building_name: string
dependent_locality: string
dependent_thoroughfare: string
double_dependent_locality: string
headers: {}
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'406':
$ref: '#/components/responses/notAcceptable'
'415':
$ref: '#/components/responses/unsupportedMediaType'
'500':
$ref: '#/components/responses/serverError'
operationId: get-propertyId
description: This endpoint retrieves a single property by its `UUID`.
/lettings/search:
get:
summary: Search for Lettings Properties
tags:
- Lettings
responses:
'200':
description: The API endpoint responds with a JSON object containing a list of lettings properties
matching the specified criteria. Each property object within the response typically includes
information such as property ID, address, description, rental price, number of bedrooms, and
other relevant details. The response also includes pagination metadata, such as the total
number of properties, the current page number, and the number of properties per page.
content:
application/vnd.api+json:
schema:
allOf:
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Property'
included:
$ref: '#/components/schemas/PropertyIncludes'
meta:
$ref: '#/components/schemas/Pagination'
links:
$ref: '#/components/schemas/Links'
type: object
examples:
Example 1:
value:
data:
- type: property
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
branch_uuid: b8e564e2-b92d-49d7-8331-85bb2766d8f8
inline_address: Rivendell, Main Street
public_address: Main Street, Follifoot, HG3
postcode: HG3 1DU
bedrooms: 3
bathrooms: 1
receptions: 2
floor_area: null
plot_area: null
land_area: null
property_type: House
property_style: None
is_commercial: true
property_age_bracket: 1970 - 1990
construction_year: null
status: Sold STC
sale_status: Sold STC
letting_status: For Sale and To Let
dual_listing: false
owner_label: Owner
tenure: Freehold
tenure_notes: null
lease_expiry_year: '2022'
lease_expiry_date: null
public_url: https://street.co.uk/platform/properties/0ed2e2f4-b697-4c78-a801-d805b75a75aa
viewing_booking_url: null
created_at: '2022-02-28T11:46:20+00:00'
updated_at: '2022-06-20T13:30:25+01:00'
custom_meta_data:
- meta_name: meta value
property_urls:
- media_type: audio_tour
media_url: string
last_instructed_sales_at: '2022-02-28T11:46:20+00:00'
last_instructed_lettings_at: '2022-02-28T11:46:20+00:00'
last_exchanged_at: '2022-02-28T11:46:20+00:00'
last_completed_at: '2022-02-28T11:46:20+00:00'
relationships:
address:
data:
type: address
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
details:
data:
type: details
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
salesListing:
data:
type: sales_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
lettingsListing:
data:
type: lettings_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
primaryImage:
data:
type: primary_image
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
rooms:
data:
- type: room
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
images:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
floorplans:
data:
- type: floorplan
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
features:
data:
- type: feature
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
outsideSpaces:
data:
- type: outsideSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
parkingSpaces:
data:
- type: parkingSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
epc:
data:
type: epc
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
additionalMedia:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
tags:
data:
- type: tag
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
brochure:
data:
type: brochure
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
development:
data:
type: development
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
included:
- type: address
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
anon_address: Beattock, Moffat, DG10
line_1: Telford Manor House
line_2: Beattock
line_3: Moffat
line_4: null
line_5: null
town: Moffat
country: United Kingdom
postcode: DG10 9SG
inline: Telford Manor House, Beattock, Moffat, DG10 9SG
longitude: -3.4548511
latitude: 55.3109071
royal_mail:
postcode: string
post_town: string
thoroughfare: string
building_name: string
building_number: string
department_name: string
organisation_name: string
sub_building_name: string
dependent_locality: string
dependent_thoroughfare: string
double_dependent_locality: string
meta:
pagination:
total: 226
count: 10
per_page: 10
current_page: 1
total_pages: 23
links:
self: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=2
first: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1
next: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1
prev: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=3
last: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=9
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'406':
$ref: '#/components/responses/notAcceptable'
'415':
$ref: '#/components/responses/unsupportedMediaType'
'422':
$ref: '#/components/responses/unprocessableEntity'
'500':
$ref: '#/components/responses/serverError'
operationId: get-lettings-search
description: "This endpoint returns all active lettings properties in your Street account. \n\n\
By default it will only return 'active' properties i.e. those with a status of `To Let`, `For\
\ Sale and To Let` or `Let Agreed`.\n\nIt will also return properties for **ALL** branches within\
\ your Street account, if you wish to limit to a specific branch you can use the `filter[branch]`\
\ query param and pass the `UUID` of the desired branch."
parameters:
- $ref: '#/components/parameters/filter_areas'
- $ref: '#/components/parameters/filter_bedrooms'
- $ref: '#/components/parameters/filter_min_bedrooms'
- $ref: '#/components/parameters/filter_branch'
- $ref: '#/components/parameters/filter_features'
- $ref: '#/components/parameters/filter_include_land'
- $ref: '#/components/parameters/filter_max_price'
- $ref: '#/components/parameters/filter_min_price'
- $ref: '#/components/parameters/filter_postcode'
- $ref: '#/components/parameters/filter_lettings_status'
- $ref: '#/components/parameters/filter_tags'
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/page_number'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- schema:
type: string
default: 'false'
in: query
name: filter[include_archived]
description: Include archived properties within the result set
/sales/search:
get:
summary: Search for Sales Properties
tags:
- Sales
responses:
'200':
description: The API endpoint responds with a JSON object containing a list of sales properties
matching the specified criteria. Each property object within the response typically includes
information such as property ID, address, description, price, number of bedrooms, and other
relevant details. The response also includes pagination metadata, such as the total number
of properties, the current page number, and the number of properties per page.
content:
application/vnd.api+json:
schema:
allOf:
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Property'
included:
$ref: '#/components/schemas/PropertyIncludes'
meta:
$ref: '#/components/schemas/Pagination'
links:
$ref: '#/components/schemas/Links'
type: object
examples:
Example 1:
value:
data:
- type: property
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
branch_uuid: b8e564e2-b92d-49d7-8331-85bb2766d8f8
inline_address: Rivendell, Main Street
public_address: Main Street, Follifoot, HG3
postcode: HG3 1DU
bedrooms: 3
bathrooms: 1
receptions: 2
floor_area: null
plot_area: null
land_area: null
property_type: House
property_style: None
is_commercial: true
property_age_bracket: 1970 - 1990
construction_year: null
status: Sold STC
sale_status: Sold STC
letting_status: For Sale and To Let
dual_listing: false
owner_label: Owner
tenure: Freehold
tenure_notes: null
lease_expiry_year: '2022'
lease_expiry_date: null
public_url: https://street.co.uk/platform/properties/0ed2e2f4-b697-4c78-a801-d805b75a75aa
viewing_booking_url: null
created_at: '2022-02-28T11:46:20+00:00'
updated_at: '2022-06-20T13:30:25+01:00'
custom_meta_data:
- meta_name: meta value
property_urls:
- media_type: audio_tour
media_url: string
last_instructed_sales_at: '2022-02-28T11:46:20+00:00'
last_instructed_lettings_at: '2022-02-28T11:46:20+00:00'
last_exchanged_at: '2022-02-28T11:46:20+00:00'
last_completed_at: '2022-02-28T11:46:20+00:00'
relationships:
address:
data:
type: address
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
details:
data:
type: details
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
salesListing:
data:
type: sales_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
lettingsListing:
data:
type: lettings_listing
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
primaryImage:
data:
type: primary_image
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
rooms:
data:
- type: room
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
images:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
floorplans:
data:
- type: floorplan
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
features:
data:
- type: feature
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
outsideSpaces:
data:
- type: outsideSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
parkingSpaces:
data:
- type: parkingSpace
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
epc:
data:
type: epc
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
additionalMedia:
data:
- type: media
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
tags:
data:
- type: tag
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
brochure:
data:
type: brochure
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
development:
data:
type: development
id: a827a3ae-4c74-4c32-8b42-42248d4010d3
included:
- type: address
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
anon_address: Beattock, Moffat, DG10
line_1: Telford Manor House
line_2: Beattock
line_3: Moffat
line_4: null
line_5: null
town: Moffat
country: United Kingdom
postcode: DG10 9SG
inline: Telford Manor House, Beattock, Moffat, DG10 9SG
longitude: -3.4548511
latitude: 55.3109071
royal_mail:
postcode: string
post_town: string
thoroughfare: string
building_name: string
building_number: string
department_name: string
organisation_name: string
sub_building_name: string
dependent_locality: string
dependent_thoroughfare: string
double_dependent_locality: string
meta:
pagination:
total: 226
count: 10
per_page: 10
current_page: 1
total_pages: 23
links:
self: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=2
first: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1
next: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1
prev: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=3
last: https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=9
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'406':
$ref: '#/components/responses/notAcceptable'
'415':
$ref: '#/components/responses/unsupportedMediaType'
'422':
$ref: '#/components/responses/unprocessableEntity'
'500':
$ref: '#/components/responses/serverError'
operationId: get-sales-search
description: "This endpoint returns all active sales properties in your Street account. \n\nBy default\
\ it will only return 'active' properties i.e. those with a status of `For Sale`, `For Sale and\
\ To Let`, `Under Offer` or `Sold STC`.\n\nIt will also return properties for **ALL** branches\
\ within your Street account, if you wish to limit to a specific branch you can use the `filter[branch]`\
\ query param and pass the `UUID` of the desired branch."
parameters:
- $ref: '#/components/parameters/filter_areas'
- $ref: '#/components/parameters/filter_bedrooms'
- $ref: '#/components/parameters/filter_min_bedrooms'
- $ref: '#/components/parameters/filter_branch'
- $ref: '#/components/parameters/filter_features'
- $ref: '#/components/parameters/filter_include_land'
- $ref: '#/components/parameters/filter_max_price'
- $ref: '#/components/parameters/filter_min_price'
- $ref: '#/components/parameters/filter_postcode'
- $ref: '#/components/parameters/filter_sales_status'
- $ref: '#/components/parameters/filter_tags'
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/page_number'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- schema:
type: string
default: 'false'
in: query
name: filter[include_archived]
description: Include archived properties within the result set
/areas:
get:
summary: Get Areas
tags:
- Meta
responses:
'200':
description: A successful response will return array of areas that are present in your Street.co.uk
account. This endpoint does **NOT** paginate the results.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Area'
examples:
example-1:
value:
data:
- type: area
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
name: Dumfries & Galloway
property_count: 172
polygon:
- - -3.0588741
- -3.0588741
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'406':
$ref: '#/components/responses/notAcceptable'
'415':
$ref: '#/components/responses/unsupportedMediaType'
'500':
$ref: '#/components/responses/serverError'
operationId: get-areas
description: Get all Areas in your Street account. This endpoint can be used to power additional
searches on your own website.
/features:
get:
summary: Get Features
tags:
- Meta
responses:
'200':
description: A successful response will return array of key features that are present in your
Street.co.uk account. This endpoint does **NOT** paginate the results.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Feature'
examples:
example-1:
value:
data:
- type: feature
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
attributes:
name: Four Double Bedrooms
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'406':
$ref: '#/components/responses/notAcceptable'
'415':
$ref: '#/components/responses/unsupportedMediaType'
'500':
$ref: '#/components/responses/serverError'
operationId: get-features
descri
# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/openapi/street-co-property-feed-api-openapi.yml