{ "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\nBy 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", "description": "Get all property Features in your Street account. This endpoint can be used to power additional searches on your own website." } } }, "components": { "schemas": { "toOneRelationship": { "title": "To One Relationship", "description": "A one to one relationship to another model, conforming to the JSON:API specification.", "type": [ "object", "null" ], "properties": { "data": { "type": [ "null", "object" ], "required": [ "id", "type" ], "properties": { "id": { "description": "The UUID of the entity.", "type": "string", "format": "uuid" }, "type": { "description": "The type/model the entity represents.", "type": "string" } } }, "links": { "$ref": "#/components/schemas/Links" } }, "x-tags": [ "JSON:API Structures", "Relationships" ] }, "toManyRelationship": { "title": "To Many Relationship", "description": "A one to many relationship to another model, conforming to the JSON:API specification.", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The UUID of the entity.", "type": "string", "format": "uuid" }, "type": { "description": "The type/model the entity represents.", "type": "string" } } } }, "links": { "$ref": "#/components/schemas/Links" } } }, "Property": { "title": "Property", "description": "A single Property entity and related relationships.", "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "example": "property" }, "attributes": { "type": "object", "properties": { "branch_uuid": { "type": "string", "format": "uuid" }, "inline_address": { "type": "string", "example": "Rivendell, Main Street" }, "public_address": { "type": "string", "description": "Public anonymous address - can be overridden with 'customise address' when editing a property ", "example": "Main Street, Follifoot, HG3" }, "postcode": { "type": "string", "example": "HG3 1DU" }, "bedrooms": { "type": "integer", "example": 3, "minimum": 1 }, "bathrooms": { "type": "integer", "minimum": 1, "example": 1 }, "receptions": { "type": "integer", "example": 2 }, "floor_area": { "type": [ "null", "integer" ], "minimum": 1 }, "plot_area": { "type": [ "null", "integer" ], "minimum": 1 }, "land_area": { "type": [ "null", "number" ], "minimum": 1 }, "property_type": { "type": "string", "enum": [ "Not Specified", "Other", "House", "Mews House", "Cluster House", "Ground Floor Flat", "Flat", "Studio Flat", "Ground Floor Maisonette", "Maisonette", "Bungalow", "Dormer Bungalow", "Mobile Home", "Land (Residential)", "Link Detached", "Town House", "Cottage", "Chalet", "Chalet Bungalow", "Character Property", "House Unspecified", "Villa", "Apartment", "Penthouse", "Finca", "Barn Conversion", "Serviced Apartment", "Parking", "Sheltered Housing", "Retirement Property", "House Share", "Flat Share", "Park Home", "Garages", "Farm House", "Equestrian Facility", "Duplex", "Triplex", "Longere", "Gite", "Barn", "Trulli", "Mill", "Ruins", "Restaurant", "Cafe", "Castle", "Village House", "Cave House", "Cortijo", "Farm Land", "Plot", "Country House", "Stone House", "Caravan", "Lodge", "Log Cabin", "Manor House", "Stately Home", "Off Plan", "Detached Villa", "Bar Nightclub", "Shop", "Riad", "House Boat", "Hotel Room", "Block Of Apartments", "Private Halls", "Office", "Business Park", "Serviced Office", "Retail Property (High Street)", "Retail Property (Out Of Town)", "Convenience Store", "Hairdresser Barber Shop", "Hotel", "Petrol Station", "Post Office", "Pub", "Workshop Retail Space", "Distribution Warehouse", "Factory", "Heavy Industrial", "Industrial Park", "Light Industrial", "Storage", "Showroom", "Warehouse", "Land (Commercial)", "Commercial Development", "Industrial Development", "Residential Development", "Commercial Property", "Data Centre", "Farm", "Healthcare Facility", "Marine Property", "Mixed Use", "Research Development Facility", "Science Park", "Guest House", "Hospitality", "Leisure Facility", "Takeaway", "Childcare Facility", "Smallholding", "Place Of Worship", "Trade Counter", "Coach House", "House Of Multiple Occupation", "Sports Facilities", "Spa", "Campsite Holiday Village", "Chateau", "Farm Commercial" ], "description": "The property type", "example": "House" }, "property_style": { "type": [ "string", "null" ], "enum": [ "None", "Detached", "Semi Detached", "Terraced", "Mid-Terraced", "End of Terrace", "Link Detached" ], "description": "The property style" }, "is_commercial": { "type": "boolean" }, "property_age_bracket": { "type": "string", "enum": [ "Unspecified", "New Build", "2020s", "2010s", "2000s", "1990s", "1970 - 1990", "1960 - 1970", "1940 - 1960", "1910 - 1940", "Edwardian (1901 - 1910)", "Victorian (1830 - 1901)", "Georgian (1710 - 1830)", "Pre-Georgian (pre 1710)" ], "example": "1970 - 1990" }, "construction_year": { "type": [ "null", "integer" ] }, "status": { "type": "string", "enum": [ "Sold STC", "For Sale", "Not On The Market", "Under Offer", "Exchanged", "Completed", "For Sale and To Let", "Let", "To Let", "Let Agreed" ] }, "sale_status": { "type": "string", "enum": [ "Sold STC", "For Sale", "Not On The Market", "Under Offer", "Exchanged", "Completed", "For Sale and To Let" ], "deprecated": true }, "letting_status": { "type": "string", "enum": [ "For Sale and To Let", "Let", "To Let", "Let Agreed" ], "deprecated": true }, "dual_listing": { "type": "boolean", "description": "This flag denotes wether a Property is both For Sale AND To Let", "default": false }, "owner_label": { "type": "string", "description": "The label for the owner. Vendor for Sales Properties, Landlord for lettings listings", "enum": [ "Landlord", "Vendor", "Owner" ], "example": "Owner" }, "tenure": { "type": [ "null", "string" ], "enum": [ "Leasehold", "Freehold", "Commonhold", "Share of Freehold", "Flying Freehold", "Share Transfer" ], "example": "Freehold" }, "tenure_notes": { "type": [ "null", "string" ], "description": "Specific notes relating to the tenure of the property." }, "lease_expiry_year": { "type": [ "null", "string" ], "example": "2022", "pattern": "^\\d{4}$" }, "lease_expiry_date": { "type": [ "null", "string" ] }, "public_url": { "type": "string", "example": "https://street.co.uk/platform/properties/0ed2e2f4-b697-4c78-a801-d805b75a75aa" }, "viewing_booking_url": { "type": [ "null", "string" ] }, "last_instructed_sales_at": { "type": [ "null", "string" ], "example": "2022-02-28T11:46:20+00:00" }, "last_instructed_lettings_at": { "type": [ "null", "string" ], "example": "2022-02-28T11:46:20+00:00" }, "last_exchanged_at": { "type": [ "null", "string" ], "example": "2022-02-28T11:46:20+00:00" }, "last_completed_at": { "type": [ "null", "string" ], "example": "2022-02-28T11:46:20+00:00" }, "created_at": { "type": "string", "example": "2022-02-28T11:46:20+00:00" }, "updated_at": { "type": "string", "example": "2022-06-20T13:30:25+01:00" }, "custom_meta_data": { "type": "array", "description": "If the user has entered any custom meta data against this property in the Street UI, the key value pairs will be contained in this object.", "items": { "x-stoplight": { "id": "sgrcaucyhd15f" }, "type": "object", "properties": { "meta_name": { "type": "string", "x-stoplight": { "id": "agkpfrbg46zwq" }, "example": "meta value" } } } }, "property_urls": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUrl" } } } }, "relationships": { "type": "object", "properties": { "address": { "description": "The address of the property. The `type` will be `address`.", "$ref": "#/components/schemas/toOneRelationship" }, "details": { "description": "Additional property details. The `type` will be `details`.", "$ref": "#/components/schemas/toOneRelationship" }, "features": { "description": "Property features. The `type` will be `feature`.", "$ref": "#/components/schemas/toManyRelationship" }, "rooms": { "description": "Rooms within the property. The `type` will be `room`.", "$ref": "#/components/schemas/toManyRelationship" }, "outsideSpaces": { "description": "Outside spaces that belong to the property. The `type` will be `outsideSpace`.", "$ref": "#/components/schemas/toManyRelationship" }, "parkingSpaces": { "description": "Parking spaces that belong to the property. The `type` will be `parkingSpace`.", "$ref": "#/components/schemas/toManyRelationship" }, "development": { "description": "The larger developmenet the property is a part of. The `type` will be `development`.", "$ref": "#/components/schemas/toOneRelationship" }, "salesListing": { "description": "Associated Sales Listings for the property. The `type` will be `sales_listing`.", "$ref": "#/components/schemas/toOneRelationship" }, "lettingsListing": { "description": "Associated Lettings Listings for the property. The `type` will be `lettings_listing`.", "$ref": "#/components/schemas/toOneRelationship" }, "primaryImage": { "description": "The primary image for the property. The `type` will be `primary_image`.", "$ref": "#/components/schemas/toOneRelationship" }, "images": { "description": "Images of the property. The `type` will be `media`.", "$ref": "#/components/schemas/toManyRelationship" }, "floorplans": { "description": "Floorplans for the property. The `type` will be `floorplan`.", "$ref": "#/components/schemas/toManyRelationship" }, "brochure": { "description": "The PDF property brochure. The `type` will be `brochure`.", "$ref": "#/components/schemas/toOneRelationship" }, "additionalMedia": { "description": "Additional media not covered by images, floorplans, etc. The `type` will be `media`.", "$ref": "#/components/schemas/toManyRelationship" }, "epc": { "description": "The current EPC (Energy Performance Certificate) for the property. The `type` will be `epc`.", "$ref": "#/components/schemas/toOneRelationship" }, "tags": { "description": "Tags associated with the property. The `type` will be `tag`.", "$ref": "#/components/schemas/toManyRelationship" } } } }, "required": [ "type", "attributes", "relationships" ] } ], "x-stoplight": { "id": "lw8lcx30w7uv3" }, "examples": [ { "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": "Terraced House", "property_style": "None", "is_commercial": false, "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" } ] }, "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" } } } } ] }, "PropertyUrl": { "title": "Property Url", "x-stoplight": { "id": "9xhfr1xe87jly" }, "type": "object", "properties": { "media_type": { "type": "string", "enum": [ "audio_tour", "brochure", "epc", "floor_plan", "image", "virtual_tour" ] }, "media_url": { "type": "string" } }, "description": "A single url entity that is associated with a property. This may be an externally hosted file." }, "jsonApiError": { "title": "JSON:API Error Object", "description": "An object representing error information, defined by the JSON:API specification.", "type": "object", "properties": { "errors": { "type": "array", "maxItems": 1, "items": { "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "code": { "type": "string" } }, "required": [ "title", "detail", "code" ] } } }, "required": [ "errors" ], "x-tags": [ "JSON:API Structures" ], "examples": [ { "detail": "Something went wrong", "code": 100 } ] }, "Pagination": { "title": "Pagination", "type": "object", "description": "Pagination object - JSON:API Standard.", "x-tags": [ "JSON:API Structures" ], "properties": { "pagination": { "type": "object", "properties": { "total": { "type": "integer", "example": 226 }, "count": { "type": "integer", "example": 10 }, "per_page": { "type": "integer", "example": 10 }, "current_page": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 23 } } } }, "x-examples": { "example-1": { "pagination": { "total": 226, "count": 10, "per_page": 10, "current_page": 1, "total_pages": 23 } } }, "examples": [ { "pagination": { "total": 226, "count": 10, "per_page": 10, "current_page": 1, "total_pages": 23 } } ] }, "Links": { "title": "Links", "x-stoplight": { "id": "u1dju8abb4hri" }, "type": "object", "description": "Links object - JSON:API Standard.", "x-examples": { "example-1": { "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", "prev": "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]=3", "last": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=9" } }, "x-tags": [ "JSON:API Structures" ], "examples": [ { "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" } ], "properties": { "self": { "type": "string", "example": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=2" }, "first": { "type": "string", "example": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1" }, "next": { "type": "string", "example": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=1" }, "prev": { "type": "string", "example": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=3" }, "last": { "type": "string", "example": "https://street.co.uk/api/property-feed/sales/search?page[number]=2&page[size]=25&page[number]=9" } } }, "BaseModel": { "title": "Base Model", "x-stoplight": { "id": "87gp5ijnjbr1s" }, "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "type": "object" } }, "required": [ "type", "id", "attributes" ], "description": "An inheritable schema used for documentation." }, "Address": { "title": "Address", "x-stoplight": { "id": "ewi5woh721lfp" }, "examples": [ { "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 } } ], "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "address" }, "attributes": { "type": "object", "properties": { "anon_address": { "type": "string", "example": "Beattock, Moffat, DG10" }, "line_1": { "type": "string", "example": "Telford Manor House" }, "line_2": { "type": "string", "example": "Beattock" }, "line_3": { "type": "string", "example": "Moffat" }, "line_4": { "type": [ "string", "null" ], "example": null }, "line_5": { "type": [ "string", "null" ], "example": null }, "town": { "type": "string", "example": "Moffat" }, "country": { "type": "string", "example": "United Kingdom" }, "postcode": { "type": "string", "example": "DG10 9SG" }, "inline": { "type": "string", "example": "Telford Manor House, Beattock, Moffat, DG10 9SG" }, "longitude": { "type": [ "number", "null" ], "example": -3.4548511 }, "latitude": { "type": [ "number", "null" ], "example": 55.3109071 }, "royal_mail": { "type": [ "object", "null" ], "x-stoplight": { "id": "lcfjzyoudub97" }, "properties": { "postcode": { "type": "string", "x-stoplight": { "id": "8s2r9nf8v5xvc" } }, "post_town": { "type": "string", "x-stoplight": { "id": "3hy1oj5qk8ffc" } }, "thoroughfare": { "type": "string", "x-stoplight": { "id": "206yud75nilap" } }, "building_name": { "type": [ "string", "null" ], "x-stoplight": { "id": "dx8yg9ahnmuae" } }, "building_number": { "type": [ "string", "null" ], "x-stoplight": { "id": "zbljstl7um1fy" } }, "department_name": { "type": [ "string", "null" ], "x-stoplight": { "id": "r03wlldqa7hke" } }, "organisation_name": { "type": [ "string", "null" ], "x-stoplight": { "id": "0jwfeoilegq6w" } }, "sub_building_name": { "type": [ "string", "null" ], "x-stoplight": { "id": "75b61kp6ochm1" } }, "dependent_locality": { "type": [ "string", "null" ], "x-stoplight": { "id": "bafx9rkp2veku" } }, "dependent_thoroughfare": { "type": [ "string", "null" ], "x-stoplight": { "id": "ynpsrgroh80om" } }, "double_dependent_locality": { "type": [ "string", "null" ], "x-stoplight": { "id": "bpf4bkpnkbt7s" } } } } } } } } ], "description": "A single Property entity and related relationships." }, "Epc": { "title": "EPC", "x-stoplight": { "id": "ifvsqbhglib3k" }, "examples": [ { "type": "epc", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "rating": "D", "report_url": null, "energy_efficiency_current": "65.0", "energy_efficiency_potential": "85.0", "environment_impact_current": "63.00", "environment_impact_potential": "86.00", "created_at": "2022-02-28T11:44:40+00:00", "updated_at": "2022-02-28T11:44:40+00:00" } } ], "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "epc" }, "attributes": { "type": "object", "properties": { "rating": { "type": "string" }, "report_url": { "type": [ "string", "null" ] }, "energy_efficiency_current": { "type": "string" }, "energy_efficiency_potential": { "type": "string" }, "environment_impact_current": { "type": "string" }, "environment_impact_potential": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } ] }, "Details": { "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "details" }, "attributes": { "type": "object", "properties": { "display_property_style": { "type": [ "null", "string" ], "enum": [ "None", "Other", "Mid-Terraced", "End of Terrace", "Town House", "Mews", "Barn Conversion", "Cottage", "Farm House", "Maisonette", "Studio", "Bungalow", "Chalet Bungalow", "Link Detached", "Ground Floor Flat", "Castle", "Park Home", "Hotel", "Guest House", "Dormer", "Equestrian", "Penthouse" ], "example": "Maisonette" }, "work_required": { "type": [ "null", "boolean" ], "example": true }, "heating_system": { "type": [ "null", "string" ], "enum": [ "Electric Boiler", "Gas Boiler", "Storage Heaters", "Oil", "Gas Tank", "Air Source", "Electric Heating", "Other" ], "example": "Gas Boiler" }, "council_tax_band": { "type": [ "null", "string" ], "example": "E" }, "council_tax_cost": { "type": [ "null", "integer" ], "example": 1616 }, "local_authority": { "type": [ "null", "string" ], "example": "Harrogate Borough Council" }, "service_charge": { "type": [ "integer", "null" ], "example": 2183 }, "service_charge_period": { "type": [ "null", "string" ], "enum": [ "Month", "Year" ], "example": "Year" }, "service_charge_notes": { "type": [ "null", "string" ] }, "ground_rent": { "type": [ "integer", "null" ], "example": 250 }, "ground_rent_period": { "type": [ "null", "string" ], "enum": [ "Month", "Year" ], "example": "Year" }, "ground_rent_review_period_years": { "type": [ "integer", "null" ], "example": 25 }, "ground_rent_uplift": { "type": [ "integer", "null" ], "example": 65, "description": "Value is a percentage", "minimum": 0, "maximum": 100 }, "ground_rent_expiry": { "type": [ "null", "string" ], "example": "2035-12-23" }, "full_description": { "type": [ "null", "string" ], "example": "

A delightful 3 bedroom end town house standing in cottage style private gardens with the advantage of a single garage situated in the heart of the idyllic village of Follifoot. <\\/b><\\/p>" }, "full_description_lettings": { "type": [ "null", "string" ], "example": "

A delightful 3 bedroom end town house standing in cottage style private gardens with the advantage of a single garage situated in the heart of the idyllic village of Follifoot. <\\/b><\\/p>", "x-stoplight": { "id": "p7zqgh21p932y" } }, "short_description": { "type": [ "null", "string" ], "example": "A delightful 3 bedroom end town house standing in cottage style private gardens with the advantage of a single garage situated in the heart of the idyllic village of Follifoot." }, "short_description_lettings": { "type": [ "null", "string" ], "example": "A delightful 3 bedroom end town house standing in cottage style private gardens with the advantage of a single garage situated in the heart of the idyllic village of Follifoot.", "x-stoplight": { "id": "kii42tvwhwo5c" } }, "location_summary": { "type": [ "null", "string" ], "example": "Follifoot is a highly regarded and pretty village just a couple of miles South of Harrogate's town centre." }, "has_parking": { "type": [ "null", "boolean" ], "deprecated": true }, "has_outdoor_space": { "type": [ "null", "boolean" ] }, "virtual_tour": { "type": [ "null", "string" ] }, "shared_ownership": { "type": "boolean", "default": false }, "shared_ownership_notes": { "type": [ "null", "string" ] }, "shared_ownership_rent": { "type": [ "integer", "null" ], "example": 366 }, "shared_ownership_rent_frequency": { "type": [ "null", "string" ], "example": "Month", "enum": [ "Month", "Year" ] }, "shared_ownership_percentage_sold": { "type": [ "integer", "null" ], "example": 60 }, "material_information": { "type": "object", "x-stoplight": { "id": "z0hhyiasfu93m" }, "properties": { "council_tax_band": { "type": [ "string", "null" ], "example": "D", "maxLength": 1 }, "lease_expiry_date": { "type": [ "string", "null" ], "format": "date" }, "ground_rent_pence": { "type": [ "integer", "null" ] }, "ground_rent_period": { "type": [ "string", "null" ] }, "ground_rent_expiry": { "type": [ "string", "null" ], "format": "date" }, "ground_rent_review_period_years": { "type": [ "integer", "null" ] }, "ground_rent_uplift": { "type": [ "integer", "null" ], "description": "Value is a percentage" }, "service_charge_pence": { "type": [ "integer", "null" ] }, "service_charge_period": { "type": [ "string", "null" ] }, "service_charge_notes": { "type": [ "string", "null" ] }, "water_supply": { "type": [ "array", "null" ], "uniqueItems": true, "items": { "type": "string", "enum": [ "Direct mains water", "Wells", "Boreholes", "Springs", "Other" ] } }, "water_supply_other": { "type": [ "string", "null" ] }, "electricity_supply": { "type": [ "array", "null" ], "uniqueItems": true, "items": { "type": "string", "enum": [ "National grid", "Wind turbine(s)", "Solar PV (Photovoltaic) panels", "Generator/private supply", "Other" ] } }, "electricity_supply_other": { "type": [ "string", "null" ] }, "sewerage": { "type": [ "array", "null" ], "uniqueItems": true, "items": { "type": "string", "enum": [ "Standard UK domestic", "Septic tank", "Domestic/small sewage treatment plants", "Cesspit", "Cesspool", "Other" ] } }, "sewerage_other": { "type": [ "string", "null" ] }, "heating_supply": { "type": [ "array", "null" ], "uniqueItems": true, "items": { "type": "string", "enum": [ "Central heating (electric)", "Central heating (gas)", "Other gas heating system", "Communal heating system", "LPG/oil central heating", "LPG central heating", "Oil central heating", "Wood burner/open fire", "Biomass boiler", "Solar panels and related technology", "Ground source heat pump", "Air source heat pump", "Other" ] } }, "heating_supply_other": { "type": [ "string", "null" ] }, "heating_system": { "type": [ "string", "null" ], "enum": [ "Electric Boiler", "Gas Boiler", "Storage Heaters", "Oil", "Gas Tank", "Air Source", "Electric Heating", "Other" ] }, "broadband": { "type": [ "string", "null" ] }, "has_restrictions": { "type": [ "boolean", "null" ] }, "has_required_access": { "type": [ "boolean", "null" ] }, "public_right_of_way": { "type": [ "boolean", "null" ] }, "sources_of_flooding": { "type": [ "array", "null" ], "items": {} }, "sources_of_flooding_other": { "type": [ "string", "null" ] }, "has_flood_defences": { "type": [ "boolean", "null" ] }, "has_flooded_in_last_five_years": { "type": [ "boolean", "null" ] }, "adaptations_list": { "type": [ "array", "null" ], "items": {} }, "adaptations_other": { "type": [ "string", "null" ] } } }, "created_at": { "type": "string", "example": "2022-02-28T11:46:44+00:00" }, "updated_at": { "type": "string", "example": "2022-07-29T15:12:13+01:00" } } } } } ] }, "SalesListing": { "title": "Sales Listing", "x-stoplight": { "id": "md05bn7s0gboa" }, "examples": [ { "type": "sales_listing", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "": "string", "status": "For Sale", "price": 0, "price_qualifier": "None", "display_price": true, "archived": true, "is_low_profile": true, "publish_after": "2022-02-28T11:46:44+00:00", "new_home": true, "retirement": true, "occupancy_status": 1, "created_at": "2022-02-28T11:46:44+00:00", "updated_at": "2022-07-29T15:12:13+01:00" } } ], "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "sales_listing" }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "For Sale", "Sold STC", "Withdrawn", "Under Offer" ], "default": "For Sale", "example": "For Sale", "deprecated": true }, "price": { "type": "integer" }, "price_qualifier": { "type": [ "null", "string" ], "enum": [ "None", "In Excess of", "Prices From", "Guide Price", "Offers Over", "Offers in Region of", "Fixed Price", "Price On Application", "Part Buy, Part Rent" ] }, "display_price": { "type": "boolean" }, "archived": { "type": "boolean" }, "is_low_profile": { "type": "boolean" }, "publish_after": { "type": "string", "format": "date-time", "example": "2022-07-29T15:12:13+01:00" }, "new_home": { "type": "boolean" }, "retirement": { "type": "boolean" }, "occupancy_status": { "type": "integer", "enum": [ 1, 2, 3 ], "default": 1, "example": 1 }, "created_at": { "type": "string", "example": "2022-02-28T11:46:44+00:00" }, "updated_at": { "type": "string", "example": "2022-07-29T15:12:13+01:00" } } } } } ] }, "Media": { "title": "Media", "x-stoplight": { "id": "powfu030rgifn" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "media" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "p045126_01" }, "order": { "type": "integer", "example": 1 }, "is_featured": { "type": "boolean", "default": false }, "feature_index": { "type": [ "null", "integer" ] }, "title": { "type": [ "null", "string" ] }, "media_type": { "type": [ "null", "string" ], "description": "A user defined type to enable categorizing generic media items", "example": "brochure" }, "is_image": { "type": "boolean", "default": true }, "url": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110\\/p045126_01.jpg" }, "urls": { "type": "object", "properties": { "thumbnail": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_thumb" }, "small": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_small_fill_crop" }, "medium": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_medium_fill_crop" }, "large": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_large_fill_crop" }, "hero": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_hero" }, "full": { "type": "string", "example": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg" } } } } } } } ], "examples": [ { "type": "media", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "name": "p045126_01", "order": 1, "is_featured": false, "feature_index": null, "title": null, "media_type": null, "is_image": true, "url": "https://ik.imagekit.io/street/street-live/properties/general/787110\\/p045126_01.jpg", "urls": { "thumbnail": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_thumb", "small": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_small_fill_crop", "medium": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_medium_fill_crop", "large": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_large_fill_crop", "hero": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_hero", "full": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg" } } } ] }, "Floorplan": { "title": "Floorplan", "x-stoplight": { "id": "c04czz0vhw61e" }, "examples": [ { "type": "floorplan", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "": "string", "name": "p045126_01", "order": 1, "is_featured": false, "feature_index": null, "title": null, "is_image": true, "url": "https://ik.imagekit.io/street/street-live/properties/general/787110\\/p045126_01.jpg", "urls": { "thumbnail": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_thumb", "small": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_small_fill_crop", "medium": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_medium_fill_crop", "large": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_large_fill_crop", "hero": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_hero", "full": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg" } } } ], "allOf": [ { "$ref": "#/components/schemas/Media" }, { "type": "object", "properties": { "type": { "type": "string", "default": "floorplan" } } } ] }, "LettingsListing": { "title": "Lettings Listing", "x-stoplight": { "id": "0206kq45gvmpa" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "lettings_listing" }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "To Let", "Let Agreed", "Let", "Withdrawn" ], "example": "To Let", "deprecated": true }, "price_pcm": { "type": [ "null", "integer" ], "example": 850 }, "deposit": { "type": [ "null", "integer" ], "example": 1000 }, "display_price": { "type": "boolean", "default": true }, "archived": { "type": "boolean", "default": false }, "furnished": { "type": "string", "enum": [ "Unfurnished", "Fully Furnished", "Part Furnished" ], "example": "Unfurnished" }, "allows_pets": { "type": [ "null", "boolean" ] }, "is_low_profile": { "type": "boolean", "default": false }, "publish_after": { "type": "string", "format": "date-time", "example": "2022-09-14T16:26:36+01:00" }, "new_home": { "type": "boolean", "default": false }, "retirement": { "type": "boolean", "default": false }, "student_rental": { "type": "boolean", "default": false }, "min_tenancy_period": { "type": [ "null", "number" ], "example": 12 }, "available_from": { "type": [ "string", "null" ], "example": "2022-09-14T16:26:36+01:00" }, "created_at": { "type": "string", "example": "2022-09-14T16:26:36+01:00" }, "updated_at": { "type": "string", "example": "2022-09-14T17:05:26+01:00" } } } } } ], "examples": [ { "type": "lettings_listing", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "": "string", "status": "To Let", "price_pcm": 850, "deposit": 1000, "display_price": true, "archived": false, "furnished": "Unfurnished", "is_low_profile": false, "publish_after": "2022-02-28T11:46:44+00:00", "new_home": false, "retirement": false, "student_rental": false, "min_tenancy_period": 12, "created_at": "2022-09-14T16:26:36+01:00", "updated_at": "2022-09-14T17:05:26+01:00" } } ] }, "Room": { "title": "Room", "x-stoplight": { "id": "bm7pfyvg2wbf4" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "room" }, "attributes": { "type": "object", "properties": { "room_type": { "type": "string", "example": "bedroom", "enum": [ "bedroom", "bathroom", "kitchen", "dining room", "lounge", "garage", "utility room", "wc", "en-suite", "reception", "landing", "lounge / diner", "conservatory", "hallway", "basement", "dressing room", "office", "attic / loft space", "other" ] }, "name": { "type": "string", "example": "Bedroom One" }, "width": { "type": [ "null", "integer" ], "example": 381 }, "length": { "type": [ "null", "integer" ], "example": 361 }, "formatted_dimensions": { "type": [ "null", "string" ], "example": "11′ 10″ x 12′ 6″ (3.61m x 3.81m)" }, "description": { "type": [ "null", "string" ], "example": "Front facing double glazed window, radiator, fitted wardrobe, double room, access to the en-suite." }, "order": { "type": "string", "example": "2" }, "created_at": { "type": "string", "example": "2022-06-29T21:18:10+01:00" }, "updated_at": { "type": "string", "example": "2022-06-29T21:18:10+01:00" } } } } } ] }, "Feature": { "title": "Feature", "x-stoplight": { "id": "5iiuyfhyt5ng5" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "feature" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "Four Double Bedrooms" } } } } } ] }, "OutsideSpace": { "title": "Outside Space", "x-stoplight": { "id": "2wzgskms9axtj" }, "examples": [ { "type": "outside_space", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "type": "Yard", "description": "Pavement fronted, gated rear yard with secure alley gates.", "width": null, "length": null, "area": null, "orientation": "S", "created_at": "2022-06-29T21:36:02+01:00", "updated_at": "2022-06-29T21:36:02+01:00" } } ], "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "outside_space" }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "example": "Yard", "enum": [ "Garden", "Front Garden", "Rear Garden", "Communal Garden", "Yard", "Roof Terrace", "Balcony" ] }, "description": { "type": "string", "example": "Pavement fronted, gated rear yard with secure alley gates." }, "width": { "type": [ "null", "integer" ] }, "length": { "type": [ "null", "integer" ] }, "area": { "type": [ "null", "integer" ] }, "orientation": { "type": [ "null", "string" ], "enum": [ "N", "NE", "E", "SE", "S", "SW", "W", "NW" ], "example": "S" }, "created_at": { "type": "string", "example": "2022-06-29T21:36:02+01:00" }, "updated_at": { "type": "string", "example": "2022-06-29T21:36:02+01:00" } } } } } ] }, "ParkingSpace": { "title": "Parking Space", "x-stoplight": { "id": "svcv9g2irh50c" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "parking_space" }, "attributes": { "type": "object", "properties": { "parking_space_type": { "type": "string", "example": "On Drive", "enum": [ "Garage", "Car Port", "Off Road", "On Road", "Permit", "Secure Gated", "Allocated Parking", "On Drive" ] }, "capacity": { "type": [ "null", "integer" ], "example": 2 }, "description": { "type": "string", "example": "Driveway parking." }, "created_at": { "type": "string", "example": "2022-02-21T12:38:04+00:00" }, "updated_at": { "type": "string", "example": "2022-02-21T12:38:04+00:00" } } } } } ] }, "Tag": { "title": "Tag", "x-stoplight": { "id": "30o1gasqafpvx" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "tag" }, "attributes": { "type": "object", "properties": { "tag": { "type": "string", "example": "promoted" } } } } } ] }, "AdditionalMedia": { "title": "Additional Media", "x-stoplight": { "id": "qhsbijocfk753" }, "allOf": [ { "$ref": "#/components/schemas/Media" }, { "type": "object", "properties": { "type": { "type": "string", "default": "generic" } } } ], "examples": [ { "type": "generic", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "name": "p045126_01", "order": 1, "is_featured": false, "feature_index": null, "title": null, "is_image": true, "url": "https://ik.imagekit.io/street/street-live/properties/general/787110\\/p045126_01.jpg", "urls": { "thumbnail": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_thumb", "small": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_small_fill_crop", "medium": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_medium_fill_crop", "large": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_large_fill_crop", "hero": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg?tr=pr-true,n-property_hero", "full": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg" } } } ] }, "Brochure": { "title": "Brochure", "x-stoplight": { "id": "i3t46fe66p18x" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "brochure" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "Brochure-Telford-Manor-House" }, "order": { "type": "integer", "example": 1 }, "is_featured": { "type": "boolean", "default": false }, "feature_index": { "type": [ "null", "integer" ] }, "title": { "type": [ "null", "string" ], "example": "Brochure Telford Manor House" }, "is_image": { "type": "boolean", "default": false }, "url": { "type": "string", "example": "https://app-street-live-public.s3.eu-west-1.amazonaws.com/properties/attachments/1003212/Brochure-Telford-Manor-House.pdf" } } } } } ], "examples": [ { "type": "brochure", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "name": "Brochure-Telford-Manor-House", "order": 1, "is_featured": false, "feature_index": null, "title": "Brochure Telford Manor House", "is_image": false, "url": "https://app-street-live-public.s3.eu-west-1.amazonaws.com/properties/attachments/1003212/Brochure-Telford-Manor-House.pdf" } } ] }, "Development": { "title": "Development", "x-stoplight": { "id": "9ocn585rcsdyu" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "development" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "171 High Street, Rayleigh" }, "description": { "type": "string", "example": "A development of 3 apartments. 2 x 1 beds and 1 x 2 bed." }, "created_at": { "type": "string", "example": "2022-04-27T10:21:56+01:00" }, "updated_at": { "type": "string", "example": "2022-04-27T10:21:56+01:00" } } } } } ] }, "PropertyIncludes": { "title": "PropertyIncludes", "x-stoplight": { "id": "8le7wfmax282s" }, "type": "array", "items": { "x-stoplight": { "id": "wpxy50nmt60du" }, "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "$ref": "#/components/schemas/Details" }, { "$ref": "#/components/schemas/SalesListing" }, { "$ref": "#/components/schemas/LettingsListing" }, { "$ref": "#/components/schemas/Room" }, { "$ref": "#/components/schemas/Media" }, { "$ref": "#/components/schemas/Floorplan" }, { "$ref": "#/components/schemas/Feature" }, { "$ref": "#/components/schemas/OutsideSpace" }, { "$ref": "#/components/schemas/ParkingSpace" }, { "$ref": "#/components/schemas/Epc" }, { "$ref": "#/components/schemas/AdditionalMedia" }, { "$ref": "#/components/schemas/Tag" }, { "$ref": "#/components/schemas/Brochure" }, { "$ref": "#/components/schemas/Development", "x-stoplight": { "id": "tn6986ih8pa6x" } } ] } }, "Area": { "title": "Area", "x-stoplight": { "id": "ozr077zsdck7a" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "area" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "Dumfries & Galloway" }, "property_count": { "type": "integer", "example": 172 }, "polygon": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number", "example": -3.0588741 } } } } } } } ], "examples": [ { "type": "area", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "name": "Dumfries & Galloway", "property_count": 172, "polygon": [ [ -3.0325611, 55.0388624 ] ] } } ] }, "Branch": { "title": "Branch", "x-stoplight": { "id": "eov7lvbtse648" }, "allOf": [ { "$ref": "#/components/schemas/BaseModel" }, { "type": "object", "properties": { "type": { "type": "string", "default": "branch" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "example": "Worsley" }, "public_name": { "type": "string", "x-stoplight": { "id": "t56a78i2jafe3" }, "example": "Briscombe" }, "email_address": { "type": "string", "x-stoplight": { "id": "jopfvbih3mi46" }, "format": "email" }, "telephone": { "type": "string", "x-stoplight": { "id": "jg4zn7hm0qqf4" } }, "website": { "type": "string", "x-stoplight": { "id": "kz73y897pyald" }, "format": "uri" }, "about_branch_copy": { "type": "string", "x-stoplight": { "id": "supi769ccfnum" } }, "disclaimer": { "type": [ "string", "null" ] }, "address": { "$ref": "#/components/schemas/Address" } } } } } ], "examples": [ { "type": "branch", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "name": "Worsley", "public_name": "Briscombe", "email_address": "user@example.com", "telephone": "string", "website": "http://example.com", "about_branch_copy": "string" } } ] } }, "securitySchemes": { "your_api_token": { "type": "http", "scheme": "bearer" } }, "responses": { "unauthorized": { "description": "The HTTP 401 Unauthorized response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Unauthorized", "detail": "The request was made by an unauthenticated user.", "code": "401" } ] } } } } } }, "forbidden": { "description": "The HTTP 403 Forbidden response status code indicates that the server understands the request but refuses to authorize it.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Forbidden", "detail": "The user is forbidden from accessing this resource.", "code": "403" } ] } } } } } }, "notFound": { "description": "The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Not Found", "detail": "The resource was not found.", "code": "404" } ] } } } } } }, "notAcceptable": { "description": "The HTTP 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Not Acceptable", "detail": "The request could not be accepted.", "code": "406" } ] } } } } } }, "unsupportedMediaType": { "description": "The HTTP 415 Unsupported Media Type client error response code indicates that the server refuses to accept the request because the payload format is in an unsupported format.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Unsupported Media Type", "detail": "The request media type is not supported.", "code": "415" } ] } } } } } }, "unprocessableEntity": { "description": "The HTTP 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Unprocessable Entity", "detail": "The request could not be processed.", "code": "422" } ] } } } } } }, "serverError": { "description": "The HTTP 500 Internal Server Error server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonApiError" }, "examples": { "example-1": { "value": { "errors": [ { "title": "Internal Server Error", "detail": "There was an internal server error.", "code": "500" } ] } } } } } } }, "requestBodies": {}, "parameters": { "filter_features": { "name": "filter[features]", "description": "Features are entered by the agent as part of the Property description - these could be things such as \"Garden\" or \"Off Road Parking\".\n\nThese features should be passed to the API in lowercase and urlencoded.\n\nYou can also enter a semi-colon seperated list to return all properties with any of those features.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_tags": { "name": "filter[tags]", "description": "Tags are entered by the agent in the Street UI and enable you to filter properties according to custom criteria. This can be used to power featured properties, carousels, hot property lists etc.These tags should be passed to the API in lowercase and urlencoded.You can also enter a comma seperated list to return all properties with any of those tags.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_postcode": { "name": "filter[postcode]", "description": "This filter will narrow your search results by first or partial postcode.\n\nA value of `M` will return all properties who's postcode begins with M, including `M1 1JU` & `M28 2PD`.\n\nEntering in `M28 2` will return all active properties in that postcode sector.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_areas": { "name": "filter[areas]", "description": "Areas are entered by the agent in the Street UI and enable you to filter properties according to custom areas. This can be used to power user friendly searches using familiar geographic areas.\n\nThese areas should be passed to the API in lowercase and urlencoded.\n\nYou can also enter a comma seperated list to return all properties within any of those areas.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_bedrooms": { "name": "filter[bedrooms]", "description": "The exact number of bedrooms for search results.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_min_bedrooms": { "name": "filter[min_bedrooms]", "description": "Minimum number of bedrooms for search results.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_min_price": { "name": "filter[min_price]", "description": "Minimum listing price for search results.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_max_price": { "name": "filter[max_price]", "description": "Maximum listing price for search results.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_sales_status": { "name": "filter[status]", "description": "Filter by property status. You can use a comma separated list for multiple statuses.", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "for_sale", "for_sale_and_to_let", "under_offer", "sold_stc", "completed", "exchanged" ] }, "uniqueItems": true, "minItems": 1, "maxItems": 6 }, "explode": false, "style": "form" }, "filter_lettings_status": { "name": "filter[status]", "description": "Filter by property status. You can use a comma separated list for multiple statuses.", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "to_let", "for_sale_and_to_let", "let", "let_agreed" ] }, "uniqueItems": true, "minItems": 1, "maxItems": 4 }, "explode": false, "style": "form" }, "filter_branch": { "name": "filter[branch]", "description": "Filter by network branch. Provide the UUID of a branch to filter properties by a specific branch.", "in": "query", "required": false, "schema": { "type": "string" } }, "filter_include_land": { "name": "filter[include_land]", "description": "Filter by property type. Defaults to false. By setting this to true, the feed will also include land-only properties.", "in": "query", "required": false, "schema": { "type": "string" } }, "sort": { "name": "sort", "description": "A field by which to sort. Prefixing with a minus symbol denotes a DESC order.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "price", "-price", "created_at", "-created_at" ] } }, "include": { "name": "include", "description": "Optional related entities to include in the results.", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "branch", "rooms", "images", "floorplans", "featuresForPortals", "outsideSpaces", "parkingSpaces", "epc", "epc.pdf", "additionalMedia", "tags", "brochure", "development", "rooms.media" ] }, "uniqueItems": true, "minItems": 1, "maxItems": 12 }, "explode": false, "style": "form" }, "page_size": { "name": "page[size]", "description": "Set the number of results per page.", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 250, "example": 25 } }, "page_number": { "name": "page[number]", "description": "Set the page number.", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "example": 3 } } } }, "tags": [ { "name": "Properties", "description": "These are the API Endpoints for Properties." }, { "name": "Lettings", "description": "These are the lettings specific API Endpoints." }, { "name": "Meta", "description": "These are specific API Endpoints for retrieving meta information such as Areas or Features." }, { "name": "Sales", "description": "These are the sales specific API Endpoints." } ], "security": [ { "your_api_token": [] } ], "x-ext-urls": {} }