{ "openapi": "3.0.1", "info": { "title": "Firmy.cz Scraper", "description": "Scrape Firmy.cz, the Czech business directory: names, addresses, GPS, phones, emails, websites, IČO, ratings, opening hours, and amenities. Search by keyword, city, or category, or paste URLs. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "1EyppxP06kyF3vVwp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~firmy-cz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-firmy-cz-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/parsebird~firmy-cz-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-firmy-cz-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/parsebird~firmy-cz-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-firmy-cz-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 keyword", "type": "string", "description": "Enter a Czech keyword, as you would type it on firmy.cz (for example 'zubař', 'autoservis', 'kavárna'). Leave it empty to browse a category instead." }, "location": { "title": "Location", "type": "string", "description": "Enter a Czech city, city district, okres, or kraj to limit results (for example 'Praha', 'Brno', 'Praha 5', 'Jihomoravský kraj'). It's matched with the firmy.cz location search. Leave it empty to search the whole Czech Republic." }, "category": { "title": "Category", "enum": [ "all", "restauracni-sluzby", "auto-moto", "elektro-mobily-pocitace", "obchody", "sluzby-a-remesla", "dum-byt-zahrada", "zdravotnictvi", "banky-finance", "cestovni-sluzby", "instituce-urady", "vse-pro-firmy", "velkoobchod-vyroba" ], "type": "string", "description": "Browse one of the 12 main firmy.cz categories, including all of its subcategories. Use it instead of a keyword: if you set both, the keyword is used and the category is skipped. For a specific subcategory, paste its firmy.cz URL into Firmy.cz URLs.", "default": "all" }, "searchUrls": { "title": "Firmy.cz URLs", "type": "array", "description": "Paste firmy.cz search, category, or business detail URLs, one per row, to reproduce exactly what the site shows (for example 'https://www.firmy.cz/?q=lékárna&x=17.250879&y=49.594540&rt=mesto' or 'https://www.firmy.cz/Auto-moto/Auto-moto-sluzby/Autoservisy'). When you add URLs, the keyword, location, and category fields are ignored.", "items": { "type": "string" } }, "includeDetails": { "title": "Include business details", "type": "boolean", "description": "Turn on to open each business profile and add emails, all phone numbers, DIČ, data box ID (datová schránka), social links, the verbal rating, the full category path, and photos. Slower, same price.", "default": false }, "maxResults": { "title": "Maximum businesses", "minimum": 0, "type": "integer", "description": "Limit the number of businesses saved (and charged) in this run. Set 0 to get everything (up to 50,000 per run).", "default": 200 } } }, "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 } } } } } } } } } }