{ "openapi": "3.0.1", "info": { "title": "Real Estate Listings API", "description": "Real estate listings API for 38 marketplaces across 23 countries. Return 40 normalized fields through one country-aware input contract without separate portal keys.", "version": "1.0", "x-build-id": "4U1skYg8ba01U6Qiw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/truefetch~real-estate-listings-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-truefetch-real-estate-listings-api", "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/truefetch~real-estate-listings-api/runs": { "post": { "operationId": "runs-sync-truefetch-real-estate-listings-api", "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/truefetch~real-estate-listings-api/run-sync": { "post": { "operationId": "run-sync-truefetch-real-estate-listings-api", "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": [ "max_results", "country", "location", "listing_type" ], "properties": { "max_results": { "title": "Max Results", "minimum": 1, "type": "integer", "description": "Maximum number of property listings to return per selected platform" }, "country": { "title": "Country", "enum": [ "Australia", "Botswana", "Brazil", "Canada", "France", "Germany", "India", "Italy", "Japan", "Kenya", "Mauritius", "Mozambique", "Namibia", "Netherlands", "Nigeria", "Poland", "South Africa", "Spain", "Sweden", "United Kingdom", "United States", "Zambia", "Zimbabwe" ], "type": "string", "description": "Country selector with 23 supported markets. Country routing uses only marketplaces mapped to the requested market." }, "location": { "title": "Location", "type": "string", "description": "City, region, neighborhood, postal code, or address to search across 38 supported property marketplaces" }, "listing_type": { "title": "Listing Type", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Transaction type. The multi-source route supports for_sale, for_rent, and sold where the selected marketplace supports them." }, "property_type": { "title": "Property Type", "enum": [ "residential", "house", "apartment", "condo", "townhouse", "land", "commercial", "new_development", "room", "auction", "ready_to_build" ], "type": "string", "description": "Optional property-type filter with 11 normalized values and source-specific support. Leave empty for no property-type restriction." }, "posted_since": { "title": "Posted Since", "type": "string", "description": "Optional listing-age filter; it applies only to routes that expose a posted-date filter. Leave empty to avoid date filtering." }, "platforms": { "title": "Platforms", "type": "array", "description": "Optional marketplaces to search from 38 supported sources. Leave empty to use every supported marketplace mapped to the selected country.", "items": { "type": "string", "enum": [ "Zillow", "Craigslist Housing", "Leboncoin Immobilier", "Realtor.com", "Redfin", "Trulia", "LoopNet", "Movoto", "RentCafe", "Rightmove", "Homes.com", "Domain", "Realtor.ca", "Immowelt", "ImmobilienScout24", "Immobiliare.it", "Zoopla", "ZAP Imóveis", "Fotocasa", "Hemnet", "Apartment List", "AtHome Japan", "Casa.it", "Centris", "Chaves na Mão", "Funda", "Homes/LIFULL", "MagicBricks", "NoBroker", "99acres", "OnTheMarket", "Otodom", "Property24", "QuintoAndar", "Rent.com", "SUUMO", "VivaReal", "Vrbo" ] } } } }, "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 } } } } } } } } } }