{ "openapi": "3.0.1", "info": { "title": "Firmy.cz Crane Scraper", "description": "Scrape company listings and profile details from Firmy.cz by search query and Czech location. Extract names, addresses, phones, emails, websites, ICO, descriptions, categories, GPS coordinates, ratings, and optional ARES establishment dates.", "version": "0.0", "x-build-id": "CgsgigiqdVi9tlqPw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magistercrane~Firmy-cz-Crane-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magistercrane-Firmy-cz-Crane-Scraper", "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/magistercrane~Firmy-cz-Crane-Scraper/runs": { "post": { "operationId": "runs-sync-magistercrane-Firmy-cz-Crane-Scraper", "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/magistercrane~Firmy-cz-Crane-Scraper/run-sync": { "post": { "operationId": "run-sync-magistercrane-Firmy-cz-Crane-Scraper", "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": { "searchQuery": { "title": "Search query", "type": "string", "description": "Single search query. Use searchQueries below for multiple queries. Czech characters are supported." }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional list of search queries to run in one Actor session. When filled, this is used instead of Search query.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Single city or municipality name, for example Kladno. Use Locations below for multiple locations. Leave empty to search the whole Czech Republic." }, "locations": { "title": "Locations", "type": "array", "description": "Optional list of city or municipality names to run in one Actor session. When filled, this is used instead of Location.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Maximum results per query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of companies to collect for each search query and location before deduplication.", "default": 20 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Backward-compatible alias for Maximum results per query." }, "includeDetails": { "title": "Include company details", "type": "boolean", "description": "Open each company profile and enrich the output with detailed fields.", "default": true }, "strictLocationMatch": { "title": "Strict location match", "type": "boolean", "description": "Keep only companies whose real locality matches one of the requested municipalities.", "default": false }, "enrichAres": { "title": "Enrich from ARES", "type": "boolean", "description": "Look up scraped ICO values in ARES and add established_at to the output.", "default": false }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 250, "type": "integer", "description": "Safety limit for listing pagination.", "default": 10 }, "delayMinSeconds": { "title": "Minimum delay", "minimum": 0, "type": "number", "description": "Minimum delay between requests in seconds.", "default": 1.5 }, "delayMaxSeconds": { "title": "Maximum delay", "minimum": 0, "type": "number", "description": "Maximum delay between requests in seconds.", "default": 3 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route Firmy.cz and ARES requests through Apify Proxy when proxy credentials are available.", "default": false }, "listingSource": { "title": "Listing source", "enum": [ "api", "html" ], "type": "string", "description": "Choose the listing source. API uses Firmy.cz frontend FastRPC and falls back to HTML if it fails.", "default": "api" } } }, "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 } } } } } } } } } }