Raw schema
{
"type": "object",
"properties": {
"category": {
"description": "sales or lettings.",
"type": "string",
"enum": [
"sales",
"lettings"
]
},
"address": {
"description": "Fuzzy match on the full address text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"postcode": {
"description": "First or partial postcode: M, M1 1JU or the sector M28 2.",
"type": "string",
"minLength": 1,
"maxLength": 8
},
"bedrooms": {
"description": "Exact number of bedrooms.",
"type": "integer",
"minimum": 0,
"maximum": 30
},
"min_bedrooms": {
"description": "Minimum number of bedrooms.",
"type": "integer",
"minimum": 0,
"maximum": 30
},
"branch": {
"description": "Only properties of this branch (branch UUID, see street_list_branches).",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"description": "Property statuses to include.",
"minItems": 1,
"maxItems": 21,
"type": "array",
"items": {
"type": "string",
"enum": [
"not_on_the_market",
"valuation_lost",
"valuation_booked",
"valuation_pending",
"valuation_cancelled",
"provisional_valuation_booked",
"valuation_completed",
"instructed",
"for_sale",
"under_offer",
"sold_stc",
"exchanged",
"let",
"to_let",
"let_agreed",
"for_sale_and_to_let",
"withdrawn_sales",
"withdrawn_lettings",
"withdrawn_sales_and_lettings",
"completed",
"auction_completed"
]
}
},
"min_price_sales": {
"description": "Minimum sales listing price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"max_price_sales": {
"description": "Maximum sales listing price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"min_price_lettings": {
"description": "Minimum lettings listing price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"max_price_lettings": {
"description": "Maximum lettings listing price.",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"tags": {
"description": "Agent-entered tag in lowercase; separate several with a semicolon for any of them.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"include_archived": {
"description": "Include archived properties.",
"type": "boolean"
},
"created_from": {
"description": "Only records created after this date-time.",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"created_to": {
"description": "Only records created before this date-time.",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_from": {
"description": "Only records updated after this date-time (use it to sync changes).",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updated_to": {
"description": "Only records updated before this date-time.",
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"trashed": {
"description": "with = include deleted records, only = only deleted ones (default: not deleted).",
"type": "string",
"enum": [
"with",
"only"
]
},
"include": {
"description": "Related records to embed in \"included\". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, sales, salesListing, salesOffers, tenancies, valuations, viewings.",
"minItems": 1,
"maxItems": 28,
"type": "array",
"items": {
"type": "string",
"enum": [
"activeTenancy",
"branch",
"brochure",
"epc",
"floorplans",
"followUp",
"interestedApplicants",
"invoices",
"lettingsApplications",
"lettingsListing",
"lettingsOffers",
"media",
"negotiator",
"notes",
"outsideSpaces",
"owner",
"owner.company",
"owner.people",
"parking",
"propertyKeys",
"rooms",
"rooms.media",
"sales",
"salesListing",
"salesOffers",
"tenancies",
"valuations",
"viewings"
]
}
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}