{ "openapi": "3.0.1", "info": { "title": "Israel Address Validator (official street list)", "description": "Validate and normalise Israeli addresses in Hebrew against the official locality and street lists on data.gov.il. Returns locality code, street code, house number, apartment and a clean address, with suggestions for typos.", "version": "0.2", "x-build-id": "4T49nO7bsqP86RufX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lirilabs~israel-address-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lirilabs-israel-address-validator", "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/lirilabs~israel-address-validator/runs": { "post": { "operationId": "runs-sync-lirilabs-israel-address-validator", "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/lirilabs~israel-address-validator/run-sync": { "post": { "operationId": "run-sync-lirilabs-israel-address-validator", "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 (one per line)", "type": "array", "description": "Free-text Israeli addresses. Street names must be in Hebrew; the locality may be in Hebrew, English or a common abbreviation (ת\"א, פ\"ת, ב\"ש). Example: הרצל 12 דירה 4, תל אביב", "items": { "type": "string" } }, "records": { "title": "Structured records (optional)", "type": "array", "description": "Objects with your own id plus either \"address\" (free text) or \"street\", \"houseNumber\" and \"city\". The id is copied to the output so you can join results back to your CRM or orders." }, "defaultCity": { "title": "Default locality", "type": "string", "description": "Used only when an address contains no recognisable locality (for example, a list that is all from one city). Must be an official locality name, e.g. ירושלים." }, "onlyProblems": { "title": "Output only addresses that need attention", "type": "boolean", "description": "Output only rows where needsReview is true (not valid, or corrected by similarity matching). The SUMMARY record still counts every address.", "default": false }, "minStreetSimilarity": { "title": "Minimum street similarity for typo matching", "minimum": 0.5, "maximum": 1, "type": "number", "description": "0.5 to 1. Lower values fix more typos but risk wrong matches. Fuzzy matches are always flagged in \"issues\".", "default": 0.8 }, "minCitySimilarity": { "title": "Minimum locality similarity for typo matching", "minimum": 0.5, "maximum": 1, "type": "number", "description": "0.5 to 1. Used only when no locality name matches exactly or by a known spelling variant.", "default": 0.85 }, "maxSuggestions": { "title": "Maximum suggestions per address", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many candidate streets or localities to return when the match is ambiguous or not found.", "default": 3 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }