{
  "openapi": "3.0.1",
  "info": {
    "title": "Booksy Beauty & Wellness Business Profile Scraper",
    "description": "Find salons, barbers, nail studios, spas, and other Booksy businesses by keyword, category, or business ID, with ratings, reviews, staff, amenities, and contact details per listing.",
    "version": "2.0",
    "x-build-id": "l7TUxPwUg19UFth7m"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nimbryxo-studio~booksy-beauty-and-wellness-business-profile/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nimbryxo-studio-booksy-beauty-and-wellness-business-profile",
        "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/nimbryxo-studio~booksy-beauty-and-wellness-business-profile/runs": {
      "post": {
        "operationId": "runs-sync-nimbryxo-studio-booksy-beauty-and-wellness-business-profile",
        "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/nimbryxo-studio~booksy-beauty-and-wellness-business-profile/run-sync": {
      "post": {
        "operationId": "run-sync-nimbryxo-studio-booksy-beauty-and-wellness-business-profile",
        "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",
              "reviews",
              "byUrl"
            ],
            "type": "string",
            "description": "What to scrape.",
            "default": "search"
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Keyword to search for (mode=search). Required for search mode; an empty or missing value is rejected instead of falling back to a default. Examples: 'hair salon', 'barber', 'nail salon', 'massage', 'eyebrows'. Use the market's language for non-English countries (e.g. 'fryzjer' in Poland, 'peluqueria' in Spain).",
            "default": "hair salon"
          },
          "location": {
            "title": "Location (city or area)",
            "type": "string",
            "description": "City or area to search near (modes search, byCategory). Local-language city names work (e.g. 'Warszawa', 'Kraków'). Leave empty to search the whole country. Latitude/longitude override this field.",
            "default": "New York"
          },
          "country": {
            "title": "Country / Booksy market",
            "enum": [
              "us",
              "gb",
              "ie",
              "au",
              "ca",
              "za",
              "pl",
              "es",
              "mx",
              "ar",
              "cl",
              "co",
              "fr",
              "br",
              "pt",
              "nl",
              "de"
            ],
            "type": "string",
            "description": "Which Booksy marketplace to use. Set the location to a city in the same country.",
            "default": "us"
          },
          "businessIds": {
            "title": "Business IDs or profile URLs",
            "type": "array",
            "description": "Booksy business IDs or full profile URLs (modes byBusinessId and reviews). Examples: '688238' or 'https://booksy.com/en-us/688238_name'. URLs also select their own country.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Booksy URLs",
            "type": "array",
            "description": "Booksy search-result pages and/or business profile pages (mode=byUrl). Search pages are paginated automatically; profile pages return full details.",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "title": "Booksy URL",
                  "description": "A Booksy search-result page or business profile URL.",
                  "type": "string"
                }
              }
            },
            "default": []
          },
          "latitude": {
            "title": "Latitude",
            "minimum": -90,
            "maximum": 90,
            "type": "number",
            "description": "GPS latitude for location-based search (modes search, byCategory). Overrides the Location field when both latitude and longitude are set."
          },
          "longitude": {
            "title": "Longitude",
            "minimum": -180,
            "maximum": 180,
            "type": "number",
            "description": "GPS longitude for location-based search (modes search, byCategory). Overrides the Location field when both latitude and longitude are set."
          },
          "radiusKm": {
            "title": "Search radius (km)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Radius in kilometres around the location (modes search, byCategory). This is a hint to Booksy's search; Booksy may widen it when nearby matches are thin. Use distanceKm on each record to filter strictly.",
            "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). Categories that are not offered in the selected country return an honest 0-result message.",
            "default": "hair"
          },
          "sortBy": {
            "title": "Sort results by",
            "enum": [
              "score",
              "distance",
              "rating",
              "price",
              "name"
            ],
            "type": "string",
            "description": "Result ordering for search, category, and URL search runs.",
            "default": "score"
          },
          "availableOn": {
            "title": "Available on date",
            "type": "string",
            "description": "Optional date in YYYY-MM-DD format. Keeps only businesses with availability on that date. Leave empty for no date filter."
          },
          "openNow": {
            "title": "Open now only",
            "type": "boolean",
            "description": "Keep only businesses that are open at the moment of the run.",
            "default": false
          },
          "hasOnlineServices": {
            "title": "Online services only",
            "type": "boolean",
            "description": "Keep only businesses offering virtual/online services.",
            "default": false
          },
          "hasTravelingServices": {
            "title": "Traveling services only",
            "type": "boolean",
            "description": "Keep only mobile/traveling service businesses.",
            "default": false
          },
          "hasSpecialOffers": {
            "title": "Special offers only",
            "type": "boolean",
            "description": "Keep only businesses with an active special offer or discount.",
            "default": false
          },
          "acceptsGiftCards": {
            "title": "Accepts Booksy gift cards",
            "type": "boolean",
            "description": "Keep only businesses that accept Booksy gift cards.",
            "default": false
          },
          "acceptsBooksyPay": {
            "title": "Accepts Booksy Pay",
            "type": "boolean",
            "description": "Keep only businesses that accept Booksy Pay.",
            "default": false
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Only include businesses rated at or above this value (0-5). Applies to business modes; reviews mode exports reviews unfiltered."
          },
          "maxRating": {
            "title": "Maximum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Only include businesses rated at or below this value (0-5). Applies to business modes."
          },
          "minReviewCount": {
            "title": "Minimum review count",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Only include businesses with at least this many reviews. Applies to business modes."
          },
          "filterCategory": {
            "title": "Only these categories",
            "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": "Keep only business records whose primary category matches this value. Applies to business modes.",
            "default": ""
          },
          "isRecommended": {
            "title": "Recommended businesses only",
            "type": "boolean",
            "description": "Keep only businesses marked as recommended by Booksy. Applies to business modes.",
            "default": false
          },
          "includeDetails": {
            "title": "Fetch full business details",
            "type": "boolean",
            "description": "Fetch the full profile for each result (services with prices and durations, staff, hours, amenities, contacts, booking policy, review sample). Adds one request per business (modes search, byCategory, byUrl). Profile lookups always fetch details.",
            "default": true
          },
          "includeReviews": {
            "title": "Fetch additional reviews",
            "type": "boolean",
            "description": "Fetch more written reviews per business and add them to topReviews (business modes). Adds review requests per business.",
            "default": false
          },
          "maxReviewsPerBusiness": {
            "title": "Max reviews per business",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum written reviews to keep per business when includeReviews is on, or in reviews mode.",
            "default": 20
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum business records to return (or review records in reviews mode). Booksy caps a single query at 10,000 results; narrow the category, location, radius, or filters to reach more.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}