{
  "openapi": "3.1.0",
  "info": {
    "title": "Rental Price Estimate for a Property API",
    "description": "Estimates a monthly rent range for a property from its features and nearby comparables. Pre-launch design; endpoints are not live yet.",
    "version": "0.1.0",
    "x-planned-pricing": {
      "model": "free tier for evaluation, paid tiers by volume",
      "status": "planned; nothing charged before launch"
    }
  },
  "servers": [
    {
      "url": "https://openapiregistry.com/api/v1/rental-valuation",
      "description": "Pre-launch: endpoints are not live yet and answer 503."
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/valuations": {
      "get": {
        "summary": "Estimate a rental range",
        "description": "Returns a lower, mid and upper monthly rent estimate for a property from its features.",
        "tags": [
          "property"
        ],
        "operationId": "rental-valuation-get-valuations",
        "parameters": [
          {
            "name": "postcode",
            "in": "query",
            "required": true,
            "description": "Property postcode.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "beds",
            "in": "query",
            "required": true,
            "description": "Number of bedrooms.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sqm",
            "in": "query",
            "required": false,
            "description": "Internal floor area.",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Estimate produced.",
            "content": {
              "application/json": {
                "example": {
                  "lower": 950,
                  "mid": 1050,
                  "upper": 1150,
                  "comparables": 18
                },
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "No comparables for area."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Planned for launch: an API key issued on request. Free tier for evaluation, paid tiers by volume; nothing is charged before launch."
      }
    }
  }
}