STstreet
Sales

Search for Sales Properties

Changed on

This endpoint returns all active sales properties in your Street account.

By 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.

It 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.

get/sales/search

Request

Query parameters

filter[areas]string

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.

These areas should be passed to the API in lowercase and urlencoded.

You can also enter a comma seperated list to return all properties within any of those areas.

filter[bedrooms]string

The exact number of bedrooms for search results.

filter[min_bedrooms]string

Minimum number of bedrooms for search results.

filter[branch]string

Filter by network branch. Provide the UUID of a branch to filter properties by a specific branch.

filter[features]string

Features are entered by the agent as part of the Property description - these could be things such as "Garden" or "Off Road Parking".

These features should be passed to the API in lowercase and urlencoded.

You can also enter a semi-colon seperated list to return all properties with any of those features.

filter[include_land]string

Filter by property type. Defaults to false. By setting this to true, the feed will also include land-only properties.

filter[max_price]string

Maximum listing price for search results.

filter[min_price]string

Minimum listing price for search results.

filter[postcode]string

This filter will narrow your search results by first or partial postcode.

A value of M will return all properties who's postcode begins with M, including M1 1JU & M28 2PD.

Entering in M28 2 will return all active properties in that postcode sector.

You can also enter a comma separated list to return all properties matching any of those postcodes. This is not supported alongside filter[postcode_radius], which resolves a single centre point and requires one full postcode.

filter[status]string[]

Filter by property status. You can use a comma separated list for multiple statuses.

filter[tags]string

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.

includestring[]

Optional related entities to include in the results.

page[number]number
Example:3

Set the page number.

page[size]number
Example:25

Set the number of results per page.

sortstring[]

A field by which to sort. Prefixing with a minus symbol denotes a DESC order.

filter[include_archived]string

Include archived properties within the result set

Response

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.

Example response

{
  "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": "Terraced House",
        "property_style": "None",
        "is_commercial": false,
        "property_age_bracket": "1970 - 1990",
        "construction_year": null,
        "status": "Sold STC",
        "sale_status": "Sold STC",
        "lettings_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"
          }
        }
      }
    }
  ],
  "included": [
    {
      "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"
      }
    }
  ],
  "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"
  }
}

Changes

  • 079a8d7e088eRevision changes
    • warning

      added the new Instructed enum value to the //// response property for the response status

    • warning

      added the new Instructed enum value to the //// response property for the response status

    • warning

      added the new Instructed enum value to the //// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Valuation Booked enum value to the //// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the //// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the //// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the //// response property for the response status

    • warning

      added the new Valuation Completed enum value to the //// response property for the response status

    • warning

      added the new Valuation Completed enum value to the //// response property for the response status

    • warning

      added the new Valuation Completed enum value to the //// response property for the response status

    • warning

      added the new Valuation Lost enum value to the //// response property for the response status

    • warning

      added the new Valuation Lost enum value to the //// response property for the response status

    • warning

      added the new Valuation Lost enum value to the //// response property for the response status

    • warning

      added the new Valuation Pending enum value to the //// response property for the response status

    • warning

      added the new Valuation Pending enum value to the //// response property for the response status

    • warning

      added the new Valuation Pending enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Lettings enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Lettings enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Sales enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Sales enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the //// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the //// response property for the response status

    • info

      for the query request parameter filter[status], the maxItems was increased from 6 to 21

    • info

      for the query request parameter include, the maxItems was increased from 12 to 15

    • info

      added the enum value auction_completed to the property items/ of the query request parameter filter[status]

    • info

      added the enum value epc.image to the property items/ of the query request parameter include

    • info

      added the enum value instructed to the property items/ of the query request parameter filter[status]

    • info

      added the enum value let to the property items/ of the query request parameter filter[status]

    • info

      added the enum value let_agreed to the property items/ of the query request parameter filter[status]

    • info

      added the enum value not_on_the_market to the property items/ of the query request parameter filter[status]

    • info

      added the enum value provisional_valuation_booked to the property items/ of the query request parameter filter[status]

    • info

      added the enum value to_let to the property items/ of the query request parameter filter[status]

    • info

      added the enum value valuation_booked to the property items/ of the query request parameter filter[status]

    • info

      added the enum value valuation_cancelled to the property items/ of the query request parameter filter[status]

    • info

      added the enum value valuation_completed to the property items/ of the query request parameter filter[status]

    • info

      added the enum value valuation_lost to the property items/ of the query request parameter filter[status]

    • info

      added the enum value valuation_pending to the property items/ of the query request parameter filter[status]

    • info

      added the enum value withdrawn_lettings to the property items/ of the query request parameter filter[status]

    • info

      added the enum value withdrawn_sales to the property items/ of the query request parameter filter[status]

    • info

      added the enum value withdrawn_sales_and_lettings to the property items/ of the query request parameter filter[status]

    • info

      added the optional property //// to the response with the status

  • 84de2fa11dd7Revision changes
    • breaking

      removed the enum value -created_at from the query request parameter sort

    • breaking

      removed the enum value -price from the query request parameter sort

    • breaking

      removed the enum value created_at from the query request parameter sort

    • breaking

      removed the enum value price from the query request parameter sort

    • breaking

      for the query request parameter sort, the minItems was increased from 0 to 1

    • breaking

      for the query request parameter sort, the type changed from string to array

    • info

      removed subschema #1 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status