{ "openapi": "3.0.1", "info": { "title": "Booksy Scraper — Beauty & Wellness Provider Leads", "description": "Scrape Booksy salons, barbers, nail & lash techs, spas & massage by city. Get ratings, reviews, services & prices, staff, Instagram/Facebook, website & leads, with optional website email enrichment and monitoring. No login, no key, no browser.", "version": "0.1", "x-build-id": "MhEUyYtKE7Ai9dxNk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~booksy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~booksy-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-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/scrapesage~booksy-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-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": { "searchCategories": { "title": "Categories", "type": "array", "description": "Beauty & wellness categories to scrape in each location. Each category is fetched on Booksy's public city pages. You can also type any raw Booksy treatment slug (e.g. `balayage`, `highlights`, `crochet-braids`).", "items": { "type": "string", "enum": [ "Hair Salon", "Barber Shop", "Nail Salon", "Brows & Lashes", "Skin Care", "Day Spa", "Massage", "Makeup", "Aesthetic Medicine", "Hair Removal", "Tattoo Shop", "Piercing", "Braids & Locs", "Health & Fitness", "Pet Services" ] }, "default": [ "Hair Salon", "Barber Shop", "Nail Salon" ] }, "locations": { "title": "Locations (City, ST)", "type": "array", "description": "US locations as `City, ST` (e.g. `Austin, TX`, `Miami, FL`, `Brooklyn, NY`). Each location is scraped for every selected category. Required unless you use Start URLs.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (Booksy pages)", "type": "array", "description": "Optional. Paste Booksy city-category pages (`booksy.com/en-us/s/hair-salon/134608_austin`) or business profile pages (`booksy.com/en-us/1303645_justin-coleman_barber-shop_134608_austin`). Processed in addition to the locations above.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max businesses per category/location", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap the number of businesses collected per category, per location.", "default": 100 }, "maxResults": { "title": "Max businesses (whole run)", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Global cap on the total number of business records emitted in this run.", "default": 200 }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only businesses with at least this average star rating (1–5). Leave empty for no filter." }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Keep only businesses with at least this many reviews. Leave empty for no filter." }, "includeBusinessDetails": { "title": "Include full business details", "type": "boolean", "description": "Fetch each business's full profile (services & prices, staff, opening hours, website, Instagram/Facebook, amenities, booking policy, photos). Turn off for a faster, listing-only run (name, rating, address, geo, price range).", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also pull each business's customer reviews (rating, text, author, date, owner reply, services & staff mentioned).", "default": false }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many recent reviews to fetch per business when reviews are enabled.", "default": 20 }, "enrichContactEmails": { "title": "Enrich contacts (crawl website for emails, phones, socials)", "type": "boolean", "description": "Opt-in lead enrichment: when a business links its own website, crawl it (home + contact/about) for emails, phone numbers and social links. Booksy routes bookings in-app, so this is the main way to get a direct email.", "default": false }, "deduplicateBusinesses": { "title": "Deduplicate businesses", "type": "boolean", "description": "Emit each business only once per run (keyed by Booksy business id), even across categories and locations.", "default": true }, "monitorMode": { "title": "Monitoring mode — only new businesses", "type": "boolean", "description": "Remember businesses already returned and emit ONLY businesses not seen in previous runs (newly listed providers for a market). Pairs with Apify Schedules to track new providers over time.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that holds the 'already seen' business ids for monitoring mode. Use a different name per tracked market to keep histories separate.", "default": "booksy-monitor" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum parallel requests. Lower it if you hit rate limits on very large runs.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Booksy serves clean pages to US IPs, so the default Apify proxy is enough; switch to residential for very large or high-frequency runs.", "default": { "useApifyProxy": true, "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }