{ "openapi": "3.0.1", "info": { "title": "Israel Real Estate Index | Official Prices, Rent & Yield", "description": "Official Israeli government housing price and rent indices for all 357 settlements and 1,336 neighbourhoods. Quarterly series 2021-2026 by room count, with rental yield, YoY change and a built-in national benchmark.", "version": "1.0", "x-build-id": "B5zhTywzHWIJf4laB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alinz~israel-real-estate-index/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alinz-israel-real-estate-index", "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/alinz~israel-real-estate-index/runs": { "post": { "operationId": "runs-sync-alinz-israel-real-estate-index", "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/alinz~israel-real-estate-index/run-sync": { "post": { "operationId": "run-sync-alinz-israel-real-estate-index", "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": [ "placeTypes", "dealTypes" ], "properties": { "placeTypes": { "title": "Geographic level", "type": "array", "description": "Which level to pull. 'settlement' = 357 cities and towns. 'neighborhood' = 1,336 neighbourhoods inside them.", "items": { "type": "string", "enum": [ "settlement", "neighborhood" ], "enumTitles": [ "Settlements (cities/towns)", "Neighbourhoods" ] }, "default": [ "settlement" ] }, "dealTypes": { "title": "Market", "type": "array", "description": "Sale prices, rent prices, or both. Pull both to compare purchase price against rent in the same place.", "items": { "type": "string", "enum": [ "buy", "rent" ], "enumTitles": [ "Buy (sale prices)", "Rent" ] }, "default": [ "buy", "rent" ] }, "outputFormat": { "title": "Output shape", "enum": [ "summary", "timeseries" ], "type": "string", "description": "'summary' = one row per place with current prices, YoY and yield — best for screening and spreadsheets. 'timeseries' = one row per quarter per room count — best for charting and modelling.", "default": "summary" }, "settlementNames": { "title": "Filter by city name (Hebrew)", "type": "array", "description": "Optional. Hebrew city names, partial match is fine - 'תל אביב' matches 'תל אביב -יפו'. Three cities are pre-filled as a cheap sample run. CLEAR THIS FIELD to pull all 357 settlements in the country.", "items": { "type": "string" } }, "settlementIds": { "title": "Filter by settlement code", "type": "array", "description": "Optional. Official settlement codes (e.g. 5000 = Tel Aviv-Yafo, 3000 = Jerusalem). Takes precedence over names when both are given.", "items": { "type": "string" } }, "neighborhoodIds": { "title": "Filter by neighbourhood ID", "type": "array", "description": "Optional. Specific neighbourhood IDs. Only applies when 'neighborhood' is selected above.", "items": { "type": "string" } }, "minYieldPct": { "title": "Minimum rental yield %", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional screen. Only return places whose published gross rental yield is at or above this value. Places with no yield figure are excluded when this is set." }, "fromYear": { "title": "History from year", "minimum": 2021, "maximum": 2026, "type": "integer", "description": "Optional. Trim the time series to this year onward. Data starts in 2021. Applies to 'timeseries' output only." }, "maxResults": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Optional cap on rows returned. Useful for a cheap trial run before a full pull." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Parallel requests to the source. 10 is a good default and completes the whole country in well under a minute.", "default": 10 } } }, "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 } } } } } } } } } }