{ "openapi": "3.0.1", "info": { "title": "Booksy Business Data Scraper", "description": "Extract Booksy business listings and detailed profiles across 16 countries plus New York. Discover active categories, paginate large result sets by regional facets, and export structured data such as ratings, reviews, services, prices, opening hours, locations and photos when available.", "version": "0.10", "x-build-id": "SHHysTOKt322eJmyJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascraperes~booksy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascraperes-booksy-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/datascraperes~booksy-scraper/runs": { "post": { "operationId": "runs-sync-datascraperes-booksy-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/datascraperes~booksy-scraper/run-sync": { "post": { "operationId": "run-sync-datascraperes-booksy-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": { "countryCodes": { "title": "Country and regional profiles", "type": "array", "description": "Profiles to scrape. The default covers all 16 supported countries; use ny explicitly for the optional New York regional profile.", "items": { "type": "string" }, "default": [ "es", "us", "gb", "pl", "fr", "br", "ar", "au", "ca", "cl", "co", "ie", "mx", "nl", "pt", "za" ] }, "mode": { "title": "Scrape mode", "enum": [ "listings", "details" ], "type": "string", "description": "Listings returns search records. Details first discovers listings and then fetches each business profile.", "default": "listings" }, "categories": { "title": "Categories", "type": "array", "description": "Optional category names from the selected profiles. Leave empty to use all configured categories.", "items": { "type": "string" }, "default": [] }, "maxBusinessesPerCategory": { "title": "Maximum businesses per category and profile", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Optional safety limit per category and profile. When set, the Actor can use the first national result page; omit it to collect all available pages and automatically split categories at the live 10,000-result boundary." }, "requestDelayMs": { "title": "Minimum request spacing", "minimum": 100, "maximum": 2000, "type": "integer", "description": "Minimum delay between Booksy requests in milliseconds.", "default": 100 }, "regionSplitThreshold": { "title": "Regional split threshold", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Regions at or above this result count are subdivided before scraping.", "default": 9000 }, "maxPagesPerRegion": { "title": "Maximum pages per region", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety ceiling for pagination in a single region.", "default": 1000 }, "datasetBatchSize": { "title": "Dataset batch size", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of items buffered before pushing to the Dataset.", "default": 25 }, "includeErrors": { "title": "Write error items", "type": "boolean", "description": "Writes an error item for failed pages or business details instead of hiding partial failures.", "default": true }, "resume": { "title": "Resume completed units", "type": "boolean", "description": "Uses Actor Key-Value Store checkpoints to skip units completed before a restart.", "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 } } }, "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 } } } } } } } } } }