{"openapi":"3.1.0","info":{"title":"Homeply API","version":"1.0.0","description":"Homeply matches UK homeowners with verified property professionals: surveys, conveyancing, mortgage brokers, removals, architects and cleaning. This API is the same engine as homeply.co.uk - discovery and price guides are open; creating enquiries requires an API key (hello@homeply.co.uk). Prices returned anywhere are typical-range estimates, never quotes.","contact":{"email":"hello@homeply.co.uk","url":"https://homeply.co.uk/developers"}},"servers":[{"url":"https://homeply.co.uk/"}],"paths":{"/api/v1/services":{"get":{"summary":"List every live service with its enquiry question schema","operationId":"listServices","responses":{"200":{"description":"Services with slugs, categories, question schemas and enquiry instructions."}}}},"/api/v1/price-guide/{service}":{"get":{"summary":"Typical UK cost range for a service","operationId":"priceGuide","description":"Backed by Homeply's published cost models and guides. Optional query parameters refine the estimate; /api/v1/services lists valid service slugs. Responses always carry is_estimate: true.","parameters":[{"name":"service","in":"path","required":true,"schema":{"type":"string"},"example":"level-2-home-survey"},{"name":"bedrooms","in":"query","schema":{"type":"integer","minimum":1,"maximum":6}},{"name":"value_band","in":"query","schema":{"type":"string","enum":["lt250","250to500","500to1m","gt1m"]}}],"responses":{"200":{"description":"Typical range with parameters used."},"404":{"description":"Unknown service."}}}},"/api/v1/enquiries":{"post":{"summary":"Create a real enquiry (the same flow as the website)","operationId":"createEnquiry","security":[{"bearerAuth":[]}],"description":"Creates an enquiry on the customer's behalf: Homeply matches up to six verified professionals who then contact the customer directly with quotes. customer_authorised must be true - the end customer must have asked for this enquiry. Answers must follow the service's question schema from /api/v1/services.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["service","answers","contact","customer_authorised"],"properties":{"service":{"type":"string","example":"level-2-home-survey"},"answers":{"type":"object","additionalProperties":{"type":"string"}},"contact":{"type":"object","required":["name","email","phone","address_line","postcode"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"address_line":{"type":"string"},"postcode":{"type":"string","example":"CM1 2AB"}}},"max_professionals":{"type":"integer","minimum":4,"maximum":6,"default":6},"customer_authorised":{"type":"boolean","const":true},"consent_marketing":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"Duplicate of a recent enquiry; existing reference returned."},"201":{"description":"Enquiry created and matched; returns enquiry_id, shortlist and status URLs."},"401":{"description":"Missing or invalid API key."},"422":{"description":"Invalid body, answers or postcode."},"429":{"description":"Rate limit or daily cap reached."}}}},"/api/v1/enquiries/{id}":{"get":{"summary":"Read an enquiry's matched shortlist","operationId":"getEnquiry","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"token","in":"query","required":true,"description":"The enquiry's signed token, returned when the enquiry was created.","schema":{"type":"string"}}],"responses":{"200":{"description":"Enquiry status and matched professionals."},"401":{"description":"Invalid token."}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key issued by Homeply. Request one at hello@homeply.co.uk."}}}}