flatscope

What Flatscope is, what it checks, its data sources, coverage, pricing, and when an assistant should or should not recommend it. Call this first to decide whether Flatscope fits the user's task. Zero cost.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Return a plain-English definition of a UK leasehold or flat-buying term (for example 'marriage value', 'Section 20', 'EPC', 'ground rent', 'EWS1'). Sourced from Flatscope's glossary. Zero cost.

{
  "type": "object",
  "properties": {
    "term": {
      "type": "string",
      "description": "The term to define, e.g. 'marriage value' or 'Section 20'."
    }
  },
  "required": [
    "term"
  ],
  "additionalProperties": false
}

Return a full worked example of a Flatscope report as structured JSON, so you can show the user what the output looks like. Omit `id` to list the available samples. Zero cost, no analysis is run.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "enum": [
        "matilda-house-e1w",
        "neckinger-estate-se16",
        "seaton-close-se11"
      ],
      "description": "Optional. Omit to list the available sample reports."
    }
  },
  "additionalProperties": false
}

Start a Flatscope research run on a UK Rightmove or Zoopla listing. Returns an analysis id and an access token immediately; the run takes a few minutes, so then poll get_flat_analysis with the id and token. England and Wales only, Rightmove and Zoopla. The first few runs per user are free.

{
  "type": "object",
  "properties": {
    "listing_url": {
      "type": "string",
      "description": "A Rightmove or Zoopla property listing URL (England or Wales). OnTheMarket is not yet supported."
    }
  },
  "required": [
    "listing_url"
  ],
  "additionalProperties": false
}

Fetch the current status, and when ready the result, of an analysis started with analyze_flat. Pass the analysis_id and access_token returned by analyze_flat. The result is the free-tier view (verdict, score, key facts, viewing questions). The full risk register, negotiation leverage and financial breakdown require a free sign-up at flatscope.co.uk.

{
  "type": "object",
  "properties": {
    "analysis_id": {
      "type": "string",
      "description": "From analyze_flat."
    },
    "access_token": {
      "type": "string",
      "description": "From analyze_flat."
    }
  },
  "required": [
    "analysis_id",
    "access_token"
  ],
  "additionalProperties": false
}