{ "openapi": "3.0.1", "info": { "title": "Israel Registered Contractors (פנקס הקבלנים) – lookup & changes", "description": "Registered contractors from Israel's Registrar of Contractors (פנקס הקבלנים) via the official data.gov.il open-data API: licence branches, classifications (ג1-ג5), scope limits, status, city; companies only by default; lookup, search and change monitoring. Open licence, attribution included.", "version": "0.1", "x-build-id": "alRUhH0XKN7eQfmEX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalrows~israel-contractors-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalrows-israel-contractors-registry", "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/signalrows~israel-contractors-registry/runs": { "post": { "operationId": "runs-sync-signalrows-israel-contractors-registry", "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/signalrows~israel-contractors-registry/run-sync": { "post": { "operationId": "run-sync-signalrows-israel-contractors-registry", "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": { "mode": { "title": "Mode", "enum": [ "search", "lookup", "monitor" ], "type": "string", "description": "search = contractors matching the filters, newest registrations first · lookup = the contractors listed in `ids` · monitor = only contractors that are new, changed classification/status or were removed since the previous run with the same filters (state kept in a named key-value store; the first run saves a baseline and returns nothing).", "default": "search" }, "query": { "title": "Name contains", "type": "string", "description": "Substring of the registered name (Hebrew, quotes/dots ignored), e.g. \"דמרי\". All digits = exact contractor number or company number (ח.פ.)." }, "branches": { "title": "Branches (ענפים)", "type": "array", "description": "Branch codes or Hebrew name substrings: 100 בניה · 131 שיפוצים · 130 בטונים ובניית שלדים · 200 כבישים תשתית ופיתוח · 260 קווי מים ביוב וניקוז · 160 חשמלאות ותקשורת במבנים · 170 מיזוג אוויר · 190 אינסטלציה · 300 גשרים ... Empty = all.", "items": { "type": "string" } }, "classifications": { "title": "Classifications (סיווג)", "type": "array", "description": "Group + level, e.g. \"ג5\", \"ג-4\", \"5\" (any group), \"א-ק\". Combined with `branches`, both must hold for the same branch (\"ג5 in בניה\"). Empty = all.", "items": { "type": "string" } }, "cities": { "title": "Cities (יישובים)", "type": "array", "description": "City name substrings as registered (Hebrew), e.g. \"ירושלים\", \"תל אביב\", \"באר שבע\". Empty = all.", "items": { "type": "string" } }, "includeIndividuals": { "title": "Include licensed individuals", "type": "boolean", "description": "Off (default): the output contains registered companies only (legal entities with a company number, ח.פ.); contractors registered as individuals are skipped entirely. On: individuals are returned with their registered name and licence facts; their phone, e-mail and address are never returned (`maskedFields` lists what was withheld).", "default": false }, "legalTypes": { "title": "Legal type", "type": "array", "description": "company = legal entities with a company number (ח.פ.) · individual = licensed individuals (only returned when `includeIndividuals` is on). Empty = both.", "items": { "type": "string", "enum": [ "company", "individual" ], "enumTitles": [ "Companies", "Individuals" ] } }, "ids": { "title": "Contractor / company numbers (lookup mode)", "type": "array", "description": "Contractor licence numbers (מספר קבלן, e.g. 6866) or 9-digit company numbers (ח.פ.). Used only when mode = lookup. Numbers not found are listed in the run's RUN_SUMMARY.", "items": { "type": "string" } }, "maxItems": { "title": "Max contractors", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many contractor records. You are charged per record returned (per change in monitor mode).", "default": 200 }, "maskPersonalIds": { "title": "Mask personal IDs", "type": "boolean", "description": "Keep on unless you have a lawful basis to process personal data: entity numbers of individuals that look like a personal ID are withheld and free text is redacted. Individuals' phone, e-mail, address and staff names are never returned regardless of this setting.", "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 }, "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 } } } } } } } } } }