{
  "openapi": "3.1.0",
  "info": {
    "title": "Rightmove UK Property Listings",
    "version": "1.0",
    "description": "UK homes for sale from Rightmove as JSON: price, bedrooms, address, type, agent\n\nCalled through the ApiClay gateway with an ApiClay token or API key (https://apiclay.com/dashboard/keys). Pricing, trial, fees and full parameter notes: https://apiclay.com/api/rightmoveproperties/llms.txt",
    "x-apiclay-vendor": "rightmoveproperties",
    "x-apiclay-pricing": "0.0018 credits/request, 10 trial requests"
  },
  "externalDocs": {
    "description": "Full documentation for AI agents (Markdown)",
    "url": "https://apiclay.com/api/rightmoveproperties/llms.txt"
  },
  "servers": [
    {
      "url": "https://api.apiclay.com/v1/api/rightmoveproperties"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    },
    {
      "tokenHeader": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "ApiClay API key (apiclay_…) or session token"
      },
      "tokenHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "token",
        "description": "ApiClay API key (apiclay_…) or session token"
      }
    }
  },
  "paths": {
    "/properties": {
      "get": {
        "operationId": "get_properties",
        "summary": "Homes for sale by area",
        "responses": {
          "200": {
            "description": "The upstream response (JSON unless the route or `X-ApiClay-Html` chooses another output)"
          },
          "default": {
            "description": "Gateway error, JSON: SOURCE_UNAVAILABLE = upstream or datasource failed, unknown path, or malformed request; POLICY_LIMIT_EXCEEDED = rate limit, daily cap, or the vendor's request policy was hit; SERVER_BUSY = gateway at capacity; retry with backoff; INSUFFICIENT_BALANCE = no credits left once trial and plan requests are used up; AUTH_FAILED = missing or invalid token",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "locationIdentifier",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Rightmove area code, e.g. REGION^87490 (London) or OUTCODE^1682"
            },
            "description": "Rightmove area code, e.g. REGION^87490 (London) or OUTCODE^1682"
          },
          {
            "name": "index",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Paging offset: 0, 24, 48 ..."
            },
            "description": "Paging offset: 0, 24, 48 ..."
          },
          {
            "name": "minPrice",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Minimum price in GBP"
            },
            "description": "Minimum price in GBP"
          },
          {
            "name": "maxPrice",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Maximum price in GBP"
            },
            "description": "Maximum price in GBP"
          },
          {
            "name": "minBedrooms",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Minimum bedrooms"
            },
            "description": "Minimum bedrooms"
          },
          {
            "name": "maxBedrooms",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Maximum bedrooms"
            },
            "description": "Maximum bedrooms"
          },
          {
            "name": "sortType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Sort: 2 highest price, 1 lowest price, 6 newest"
            },
            "description": "Sort: 2 highest price, 1 lowest price, 6 newest"
          }
        ]
      }
    }
  }
}
