{ "openapi": "3.0.1", "info": { "title": "Rightmove Market Comps Analyzer", "description": "Aggregate buyer-authorized normalized UK asking-price observations into privacy-bounded comparable-market reports without contacting Rightmove or another source.", "version": "0.1", "x-build-id": "r4R1TPza8PH3mMZYu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~rightmove-market-comps-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-rightmove-market-comps-analyzer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/zinin~rightmove-market-comps-analyzer/runs": { "post": { "operationId": "runs-sync-zinin-rightmove-market-comps-analyzer", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/zinin~rightmove-market-comps-analyzer/run-sync": { "post": { "operationId": "run-sync-zinin-rightmove-market-comps-analyzer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "observations", "minimumSegmentSize", "acknowledgeBuyerAuthority" ], "properties": { "observations": { "title": "Normalized asking-price observations", "minItems": 3, "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Three to 500 strict factual rows you are authorized to process. Rent prices must already be normalized per calendar month.", "items": { "type": "object", "additionalProperties": false, "required": [ "location_identifier", "deal_type", "found", "price", "currency", "property_type", "posted_date", "partial", "source_portal" ], "properties": { "location_identifier": { "title": "Location identifier", "description": "Stable uppercase UK search-area identifier, for example REGION^87490; it is a grouping key, not an address.", "type": "string", "minLength": 3, "maxLength": 64, "pattern": "^[A-Z][A-Z0-9_]*\\^[1-9][0-9]{0,15}$" }, "deal_type": { "title": "Deal type", "description": "Sale asking price or rent already normalized to a calendar-month asking price.", "type": "string", "enum": [ "sale", "rent" ], "enumTitles": [ "Sale asking price", "Monthly rent asking price" ] }, "found": { "title": "Found observation", "description": "Must remain true. Only successfully observed rows are accepted; false is rejected by the runtime.", "type": "boolean" }, "price": { "title": "Asking price in GBP", "description": "Integer GBP asking price; for rent this must be the normalized monthly amount.", "type": "integer", "minimum": 1, "maximum": 1000000000 }, "currency": { "title": "Currency", "description": "Fixed to GBP so unlike units cannot be combined.", "type": "string", "enum": [ "GBP" ], "enumTitles": [ "GBP" ] }, "property_type": { "title": "Property type", "description": "Short normalized factual property category, without an address, title or description.", "type": "string", "minLength": 1, "maxLength": 80 }, "rooms": { "title": "Room count", "description": "Optional normalized room count; use null when it was not supplied.", "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 }, "area_sqm": { "title": "Area in square metres", "description": "Optional factual area with no more than three decimal places; use null when unavailable. Decimal precision is enforced by the runtime because Apify Input Schema does not expose multipleOf.", "type": "number", "nullable": true, "minimum": 1, "maximum": 100000 }, "posted_date": { "title": "Source posting timestamp", "description": "Canonical UTC RFC3339 seconds.", "type": "string", "pattern": "^(?!0000)[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$" }, "partial": { "title": "Bounded or partial source sample", "description": "Set true if the supplying process was bounded, capped or otherwise incomplete.", "type": "boolean" }, "source_portal": { "title": "Source portal label", "description": "Lowercase nominative provenance only; it does not grant collection or reuse rights.", "type": "string", "minLength": 1, "maxLength": 40, "pattern": "^[a-z][a-z0-9_-]*$" } } } }, "reportLabel": { "title": "Private correlation label", "minLength": 0, "maxLength": 80, "type": "string", "description": "Optional non-sensitive buyer label used only in the input identity; it is not returned in the report.", "default": "" }, "minimumSegmentSize": { "title": "Minimum publishable group size", "minimum": 3, "maximum": 3, "type": "integer", "description": "Fixed at three observations in V1 so smaller market and subsegment groups remain suppressed.", "default": 3 }, "acknowledgeBuyerAuthority": { "title": "Confirm authority and analytical scope", "type": "boolean", "description": "Required and must remain true: you are authorized to process every supplied observation and understand that output is derived asking-price research, not a valuation or complete market. False is rejected by the runtime.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }