{ "openapi": "3.0.1", "info": { "title": "Israel Building Permits - Tel Aviv, TAMA 38 & Status", "description": "Building permits and permit requests from Israeli municipal planning systems: permit number and date, address, housing units, TAMA 38 urban-renewal flags, request type, construction start, occupancy and the official document link.", "version": "1.0", "x-build-id": "Q1AIQPTlg7RsNLcwp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swerve~israel-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swerve-israel-building-permits", "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/swerve~israel-building-permits/runs": { "post": { "operationId": "runs-sync-swerve-israel-building-permits", "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/swerve~israel-building-permits/run-sync": { "post": { "operationId": "run-sync-swerve-israel-building-permits", "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", "properties": { "addresses": { "title": "Addresses", "type": "array", "description": "Hebrew addresses or place names in Tel Aviv-Yafo. Each one is geocoded and searched within the radius below. Example: \"רוטשילד 15 תל אביב\", \"שינקין 20 תל אביב\". Leave empty to sweep the whole city.", "items": { "type": "string" } }, "radiusMeters": { "title": "Search radius (metres)", "minimum": 50, "type": "integer", "description": "How far around each address to look. 300 m covers a block; 1000 m covers a neighbourhood.", "default": 300 }, "onlyTama38": { "title": "Only TAMA 38 / urban renewal", "type": "boolean", "description": "Return only permits flagged as TAMA 38 (earthquake-retrofit and urban-renewal projects). About 1 in 5 Tel Aviv permits qualify.", "default": false }, "permitFrom": { "title": "Permit granted from", "type": "string", "description": "Only permits granted on or after this date. Format YYYY-MM-DD, e.g. 2023-01-01." }, "permitTo": { "title": "Permit granted until", "type": "string", "description": "Only permits granted on or before this date. Format YYYY-MM-DD, e.g. 2026-12-31." }, "minHousingUnits": { "title": "Minimum housing units", "minimum": 0, "type": "integer", "description": "Only permits adding at least this many housing units. Use 1 to skip permits that add none (signage, use changes)." }, "includeBuildingStatus": { "title": "Add preservation & dangerous-building status", "type": "boolean", "description": "For each permit, check whether its parcel is on the preservation list (which restricts what may be built) and whether it has a dangerous-building order (a prime urban-renewal target). Adds a few requests per run.", "default": false }, "requestTypeContains": { "title": "Request type contains", "type": "string", "description": "Hebrew text matched against the request type. Examples: \"תוספת\" (addition), \"שימוש חורג\" (non-conforming use), \"הריסה\" (demolition)." }, "addressContains": { "title": "Address contains", "type": "string", "description": "Hebrew street name matched against the permit address, e.g. \"דיזנגוף\". Searches the whole city, no geocoding needed." }, "bbox": { "title": "Map rectangle", "type": "string", "description": "Search a rectangle instead of an address, as minLng,minLat,maxLng,maxLat. Example: 34.770,32.062,34.782,32.070" }, "includeGeometry": { "title": "Include map coordinates", "type": "boolean", "description": "Adds latitude and longitude for each permit, taken from the centre of its parcel. Turning this off makes runs slightly faster.", "default": true }, "maxItems": { "title": "Maximum permits", "minimum": 1, "type": "integer", "description": "Optional cap on how many permits to return, to limit cost. Leave blank to get every permit that matches." }, "proxyConfig": { "title": "Proxy", "type": "object", "description": "Israeli residential proxy is used by default. The municipal GIS is reachable without one, so this rarely needs changing.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }