AreaMarketResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lettance-com/json-schema/lettance-com-area-market-response-schema.json",
  "title": "AreaMarketResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lettance-com-openapi.json#/components/schemas/AreaMarketResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/AreaMarket"
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "$defs": {
    "AreaMarket": {
      "type": "object",
      "properties": {
        "postcode": {
          "type": "string"
        },
        "council": {
          "type": [
            "string",
            "null"
          ]
        },
        "councilCode": {
          "type": "string",
          "description": "ONS local authority code"
        },
        "rent": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "area": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "code",
                    "name"
                  ]
                },
                "period": {
                  "type": "string",
                  "description": "The month the figure describes, YYYY-MM."
                },
                "averageMonthlyRentGbp": {
                  "type": "number"
                },
                "annualChangePct": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "byBedrooms": {
                  "type": "object",
                  "properties": {
                    "one": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "two": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "three": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "fourPlus": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "one",
                    "two",
                    "three",
                    "fourPlus"
                  ]
                },
                "england": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "averageMonthlyRentGbp": {
                          "type": "number"
                        },
                        "annualChangePct": {
                          "type": [
                            "number",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "averageMonthlyRentGbp",
                        "annualChangePct"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "source": {
                  "$ref": "#/$defs/MarketSource"
                }
              },
              "required": [
                "status",
                "area",
                "period",
                "averageMonthlyRentGbp",
                "annualChangePct",
                "byBedrooms",
                "england",
                "source"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "unavailable"
                },
                "reason": {
                  "type": "string"
                },
                "source": {
                  "$ref": "#/$defs/MarketSource"
                }
              },
              "required": [
                "status",
                "reason",
                "source"
              ]
            }
          ]
        },
        "sales": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "district": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "description": "Postcode district, e.g. SE15."
                    },
                    "medianPriceGbp": {
                      "type": "number"
                    },
                    "sales": {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    }
                  },
                  "required": [
                    "code",
                    "medianPriceGbp",
                    "sales"
                  ]
                },
                "window": {
                  "type": "object",
                  "properties": {
                    "from": {
                      "type": "string",
                      "description": "ISO date, YYYY-MM-DD"
                    },
                    "to": {
                      "type": "string",
                      "description": "ISO date, YYYY-MM-DD"
                    }
                  },
                  "required": [
                    "from",
                    "to"
                  ]
                },
                "source": {
                  "$ref": "#/$defs/MarketSource"
                }
              },
              "required": [
                "status",
                "district",
                "window",
                "source"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "unavailable"
                },
                "reason": {
                  "type": "string"
                },
                "window": {
                  "type": "object",
                  "properties": {
                    "from": {
                      "type": "string",
                      "description": "ISO date, YYYY-MM-DD"
                    },
                    "to": {
                      "type": "string",
                      "description": "ISO date, YYYY-MM-DD"
                    }
                  },
                  "required": [
                    "from",
                    "to"
                  ]
                },
                "source": {
                  "$ref": "#/$defs/MarketSource"
                }
              },
              "required": [
                "status",
                "reason",
                "window",
                "source"
              ]
            }
          ]
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "postcode",
        "council",
        "councilCode",
        "rent",
        "sales",
        "limitations"
      ],
      "description": "ONS private rents for the local authority and HM Land Registry sale prices for the postcode district, from a dated snapshot. Area figures, not a valuation."
    },
    "MarketSource": {
      "type": "object",
      "properties": {
        "dataset": {
          "type": "string"
        },
        "publisher": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "description": "The dataset's page."
        },
        "files": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Absolute URL"
          },
          "description": "The files the snapshot was compiled from."
        },
        "released": {
          "type": "string",
          "description": "When the publisher released the files used."
        },
        "obtained": {
          "type": "string",
          "description": "When Lettance downloaded them."
        },
        "measure": {
          "type": "string"
        },
        "licence": {
          "type": "string"
        },
        "licenceUrl": {
          "type": "string",
          "description": "Absolute URL"
        },
        "attribution": {
          "type": "string",
          "description": "The attribution statement to show with the figure."
        }
      },
      "required": [
        "dataset",
        "publisher",
        "url",
        "files",
        "released",
        "obtained",
        "measure",
        "licence",
        "licenceUrl",
        "attribution"
      ],
      "description": "Where an area market figure comes from. Show the attribution with the figure."
    },
    "Meta": {
      "type": "object",
      "properties": {
        "sources": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Absolute URL"
          },
          "description": "Distinct upstream sources this response draws on: legislation, GOV.UK guidance, council pages and data services."
        },
        "coverage": {
          "type": "string",
          "description": "How much of England the council licensing research covers today."
        },
        "notice": {
          "type": "string",
          "description": "How to use this answer. It is information, not legal advice."
        },
        "catalogueDate": {
          "type": "string",
          "description": "The catalogue edition this response was built from."
        },
        "links": {
          "type": "object",
          "properties": {
            "documentation": {
              "type": "string",
              "description": "Absolute URL"
            },
            "openapi": {
              "type": "string",
              "description": "Absolute URL"
            },
            "html": {
              "description": "The human page for this answer.",
              "type": "string"
            },
            "markdown": {
              "description": "The same page as Markdown, for agents.",
              "type": "string"
            }
          },
          "required": [
            "documentation",
            "openapi"
          ]
        }
      },
      "required": [
        "sources",
        "coverage",
        "notice",
        "catalogueDate",
        "links"
      ],
      "description": "Sources, coverage and links. Present on every response, including errors."
    }
  }
}