{ "openapi": "3.0.1", "info": { "title": "Booksy Scraper", "description": "Scrape Booksy - the world's leading beauty appointment booking platform. Search salons, barbers, nail studios, spas, and more by keyword or location. Get ratings, reviews, services, staff, contact info, and booking availability.", "version": "1.0", "x-build-id": "GxEig4dtmKU431uoF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~booksy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~booksy-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~booksy-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "byBusinessId" ], "type": "string", "description": "What to scrape.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keyword to search (mode=search). Examples: 'hair salon', 'barber', 'nail salon', 'massage', 'eyebrows'.", "default": "hair salon" }, "location": { "title": "Location (city name)", "type": "string", "description": "City name to search near (e.g. 'New York', 'Los Angeles', 'Chicago'). Used when latitude/longitude are not provided.", "default": "New York" }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "GPS latitude for location-based search. Overrides the Location field if provided." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "GPS longitude for location-based search. Overrides the Location field if provided." }, "radiusKm": { "title": "Search radius (km)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Radius in kilometres around the location to search (default: 10 km). This is a hint to Booksy's search, not a hard filter — Booksy may still include businesses outside this radius when local matches are limited (the same happens on booksy.com). Use the returned distanceKm field to filter strictly by distance if needed.", "default": 10 }, "category": { "title": "Category (mode=byCategory)", "enum": [ "hair", "barber", "nails", "skin-care", "brows-and-lashes", "massage", "makeup", "wellness-and-spa", "braids-and-locs", "tattoos", "medical-aesthetics", "hair-removal", "home-services", "piercing", "pet-services", "dental", "health-and-fitness", "professional-services", "other" ], "type": "string", "description": "Service category to browse (mode=byCategory).", "default": "hair" }, "businessIds": { "title": "Business IDs (mode=byBusinessId)", "type": "array", "description": "Booksy business IDs to fetch details for (mode=byBusinessId). Find them in the Booksy URL, e.g. 688238 from https://booksy.com/en-us/688238_name", "default": [], "items": { "type": "string" } }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only include businesses with a rating at or above this value (0–5 scale)." }, "maxRating": { "title": "Maximum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only include businesses with a rating at or below this value (0–5 scale)." }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only include businesses with at least this many reviews." }, "filterCategory": { "title": "Filter by category", "type": "string", "description": "Filter results to a specific category slug (e.g. 'hair', 'nails'). Useful in search mode to narrow results." }, "isRecommended": { "title": "Recommended businesses only", "type": "boolean", "description": "If enabled, only return businesses marked as recommended by Booksy.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of businesses to return.", "default": 50 } } }, "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 } } } } } } } } } }