Homechecker Guides Read API API

{"openapi":"3.1.0","info":{"title":"Homechecker Guides Read API","version":"1.2.3","description":"Read-only HTTP access to the same professionally authored Australian residential-property guide snapshot exposed by the Homechecker MCP server.","contact":{"name":"Homechecker","url":"https://homechecker.com.au/ai"},"license":{"name":"MIT (server code); guide content subject to Homechecker content terms","url":"https://github.com/Steven3265/homechecker-guides-mcp/blob/main/data/TERMS.md"}},"servers":[{"url":"https://mcp.homechecker.com.au"}],"paths":{"/v1/guides":{"get":{"operationId":"listGuides","summary":"List Homechecker guides","parameters":[{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string"}},{"name":"cluster","in":"query","required":false,"schema":{"type":"string","enum":["why","how-to-buy","state-rules","read-building","shared-buildings","own-change"]}},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"}},{"name":"era","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyingStage","in":"query","required":false,"schema":{"type":"string"}},{"name":"includePillar","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}}],"responses":{"200":{"description":"Guide catalogue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidesResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/search":{"get":{"operationId":"searchGuides","summary":"Search Homechecker guidance","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":800}},{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string"}},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"}},{"name":"era","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyingStage","in":"query","required":false,"schema":{"type":"string"}},{"name":"cluster","in":"query","required":false,"schema":{"type":"string","enum":["why","how-to-buy","state-rules","read-building","shared-buildings","own-change"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10,"default":5}}],"responses":{"200":{"description":"Search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/guide":{"get":{"operationId":"getGuide","summary":"Get one canonical Homechecker guide","parameters":[{"name":"slug","in":"query","required":true,"schema":{"type":"string","maxLength":160}}],"responses":{"200":{"description":"Canonical guide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuideResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Guide not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checklist":{"get":{"operationId":"buildBuyerChecklist","summary":"Build a sourced buyer checklist","parameters":[{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string"}},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"}},{"name":"era","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyingStage","in":"query","required":false,"schema":{"type":"string"}},{"name":"concern","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","minLength":2,"maxLength":120},"maxItems":10,"default":[]},"style":"form","explode":true},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":4,"maximum":20,"default":12}}],"responses":{"200":{"description":"Buyer checklist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"slug":{"type":"string"}},"additionalProperties":true},"Cluster":{"anyOf":[{"type":"object","required":["id","label","chip","blurb"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"chip":{"type":"string"},"blurb":{"type":"string"}},"additionalProperties":false},{"type":"null"}]},"GuideSummary":{"type":"object","required":["slug","title","question","summary","answer","canonicalUrl","referralUrl","resourceUri","jurisdiction","cluster","topics","propertyTypes","eras","buyingStages","updatedAt","reviewedAt","reviewDue","wordCount","readingTimeMin","limitations"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"question":{"type":"string"},"summary":{"type":"string"},"answer":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri"},"referralUrl":{"type":"string","format":"uri"},"resourceUri":{"type":"string"},"jurisdiction":{"type":"array","items":{"type":"string"}},"cluster":{"$ref":"#/components/schemas/Cluster"},"topics":{"type":"array","items":{"type":"string"}},"propertyTypes":{"type":"array","items":{"type":"string"}},"eras":{"type":"array","items":{"type":"string"}},"buyingStages":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date"},"reviewedAt":{"type":["string","null"]},"reviewDue":{"type":["string","null"]},"wordCount":{"type":"integer","minimum":1},"readingTimeMin":{"type":"integer","minimum":1},"limitations":{"type":["string","null"]}},"additionalProperties":false},"GuideSection":{"type":"object","required":["id","heading","markdown"],"properties":{"id":{"type":"string"},"heading":{"type":"string"},"markdown":{"type":"string"}},"additionalProperties":false},"GuideFaq":{"type":"object","required":["question","answer"],"properties":{"question":{"type":"string"},"answer":{"type":"string"}},"additionalProperties":false},"GuideSource":{"type":"object","required":["title","publisher","url","accessed"],"properties":{"title":{"type":"string"},"publisher":{"type":"string"},"url":{"type":"string","format":"uri"},"accessed":{"type":"string","format":"date"}},"additionalProperties":false},"GuideDetail":{"type":"object","required":["slug","title","question","summary","answer","canonicalUrl","referralUrl","resourceUri","jurisdiction","cluster","topics","propertyTypes","eras","buyingStages","updatedAt","reviewedAt","reviewDue","wordCount","readingTimeMin","limitations","sections","faqs","sources","contentMarkdown"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"question":{"type":"string"},"summary":{"type":"string"},"answer":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri"},"referralUrl":{"type":"string","format":"uri"},"resourceUri":{"type":"string"},"jurisdiction":{"type":"array","items":{"type":"string"}},"cluster":{"$ref":"#/components/schemas/Cluster"},"topics":{"type":"array","items":{"type":"string"}},"propertyTypes":{"type":"array","items":{"type":"string"}},"eras":{"type":"array","items":{"type":"string"}},"buyingStages":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date"},"reviewedAt":{"type":["string","null"]},"reviewDue":{"type":["string","null"]},"wordCount":{"type":"integer","minimum":1},"readingTimeMin":{"type":"integer","minimum":1},"limitations":{"type":["string","null"]},"sections":{"type":"array","items":{"$ref":"#/components/schemas/GuideSection"}},"faqs":{"type":"array","items":{"$ref":"#/components/schemas/GuideFaq"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/GuideSource"}},"contentMarkdown":{"type":"string"}},"additionalProperties":false},"GuidesResponse":{"type":"object","required":["generatedAt","count","guides"],"properties":{"generatedAt":{"type":"string","format":"date-time"},"count":{"type":"integer","minimum":0},"guides":{"type":"array","items":{"$ref":"#/components/schemas/GuideSummary"}}},"additionalProperties":false},"MatchedSection":{"type":"object","required":["id","heading","snippet","score"],"properties":{"id":{"type":"string"},"heading":{"type":"string"},"snippet":{"type":"string"},"score":{"type":"number"}},"additionalProperties":false},"SearchResult":{"type":"object","required":["slug","title","question","summary","answer","canonicalUrl","referralUrl","resourceUri","jurisdiction","cluster","topics","propertyTypes","eras","buyingStages","updatedAt","reviewedAt","limitations","score","matchedTerms","matchedSections"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"question":{"type":"string"},"summary":{"type":"string"},"answer":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri"},"referralUrl":{"type":"string","format":"uri"},"resourceUri":{"type":"string"},"jurisdiction":{"type":"array","items":{"type":"string"}},"cluster":{"$ref":"#/components/schemas/Cluster"},"topics":{"type":"array","items":{"type":"string"}},"propertyTypes":{"type":"array","items":{"type":"string"}},"eras":{"type":"array","items":{"type":"string"}},"buyingStages":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string","format":"date"},"reviewedAt":{"type":["string","null"]},"limitations":{"type":["string","null"]},"score":{"type":"number"},"matchedTerms":{"type":"array","items":{"type":"string"}},"matchedSections":{"type":"array","items":{"$ref":"#/components/schemas/MatchedSection"}}},"additionalProperties":false},"SearchResponse":{"type":"object","required":["query","count","matchStrength","results","boundary"],"properties":{"query":{"type":"string"},"count":{"type":"integer","minimum":0},"matchStrength":{"type":"string","enum":["none","weak","strong"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"boundary":{"type":"string"}},"additionalProperties":false},"GuideResponse":{"type":"object","required":["guide"],"properties":{"guide":{"$ref":"#/components/schemas/GuideDetail"}},"additionalProperties":false},"ChecklistProfile":{"type":"object","properties":{"jurisdiction":{"type":"string"},"propertyType":{"type":"string"},"era":{"type":"string"},"buyingStage":{"type":"string"},"concerns":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"ChecklistGuide":{"type":"object","required":["slug","title","canonicalUrl","referralUrl","answer"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri"},"referralUrl":{"type":"string","format":"uri"},"answer":{"type":"string"}},"additionalProperties":false},"ChecklistItem":{"type":"object","required":["check","section","guideSlug","guideTitle","canonicalUrl","referralUrl"],"properties":{"check":{"type":"string"},"section":{"type":"string"},"guideSlug":{"type":"string"},"guideTitle":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri"},"referralUrl":{"type":"string","format":"uri"}},"additionalProperties":false},"BuyerChecklist":{"type":"object","required":["profile","guidanceBoundary","matchedGuides","items"],"properties":{"profile":{"$ref":"#/components/schemas/ChecklistProfile"},"guidanceBoundary":{"type":"string"},"matchedGuides":{"type":"array","items":{"$ref":"#/components/schemas/ChecklistGuide"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ChecklistItem"}}},"additionalProperties":false},"ChecklistResponse":{"type":"object","required":["checklist"],"properties":{"checklist":{"$ref":"#/components/schemas/BuyerChecklist"}},"additionalProperties":false}}}}