{
  "openapi": "3.0.1",
  "info": {
    "title": "Bridebook Scraper - Wedding Venues, Suppliers & Leads",
    "description": "Scrape wedding venues & suppliers from Bridebook: photographers, caterers, florists, cakes, bands, planners & more. Get direct email, phone, website, Instagram/Facebook, prices, capacity, reviews & owner leads across 11 countries. Filter, monitor mode, export JSON/CSV/Excel.",
    "version": "1.0",
    "x-build-id": "rSn4LydBC0zTTjuSD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~bridebook-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-bridebook-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~bridebook-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-bridebook-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~bridebook-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-bridebook-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": {
          "categories": {
            "title": "Wedding vendor categories",
            "type": "array",
            "description": "Wedding vendor types to scrape (combined with every location). Use <code>venues</code> or any supplier type: <code>photographers</code>, <code>videographers</code>, <code>catering</code>, <code>florists</code>, <code>cakes</code>, <code>music</code> (bands & DJs), <code>planners</code>, <code>beauty</code> (hair & makeup), <code>bridalwear</code>, <code>menswear</code>, <code>jewellery</code>, <code>transport</code>, <code>stationery</code>, <code>marquee</code>, <code>entertainment</code>, <code>decoration</code>.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Towns, cities, regions or counties to search, e.g. <code>london</code>, <code>manchester</code>, <code>edinburgh</code>, <code>kent</code>, <code>yorkshire</code>. Each location is combined with every category above. Match the country to the <b>Market</b> below (e.g. <code>dublin</code> for Ireland, <code>sydney</code> for Australia).",
            "items": {
              "type": "string"
            }
          },
          "market": {
            "title": "Market (country)",
            "enum": [
              "uk",
              "ie",
              "au",
              "ca",
              "nz",
              "za",
              "de",
              "at",
              "ch",
              "fr",
              "pl"
            ],
            "type": "string",
            "description": "Bridebook country site to search. Bridebook covers the UK, Ireland, Australia, Canada, New Zealand, South Africa, Germany, Austria, Switzerland, France & Poland.",
            "default": "uk"
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Direct Bridebook URLs — vendor profile pages (<code>/uk/wedding-venues/...</code>) or search/listing pages (<code>/uk/search/wedding-photographers/london</code>). Used in addition to the searches above.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of vendor records to scrape across all searches.",
            "default": 100
          },
          "minReviews": {
            "title": "Minimum reviews",
            "minimum": 0,
            "type": "integer",
            "description": "Only include vendors with at least this many reviews."
          },
          "minRating": {
            "title": "Minimum rating (0–5)",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only include vendors with at least this average star rating."
          },
          "maxPrice": {
            "title": "Maximum starting price",
            "minimum": 0,
            "type": "integer",
            "description": "Only include vendors whose starting price is at or below this value (in the market's local currency). Vendors that don't publish a price are kept."
          },
          "hasEmailOnly": {
            "title": "Only vendors with an email",
            "type": "boolean",
            "description": "Only keep vendors that expose a contact email (requires Include vendor details).",
            "default": false
          },
          "hasPhoneOnly": {
            "title": "Only vendors with a phone",
            "type": "boolean",
            "description": "Only keep vendors that expose a phone number (requires Include vendor details).",
            "default": false
          },
          "hasWebsiteOnly": {
            "title": "Only vendors with a website",
            "type": "boolean",
            "description": "Only keep vendors that link their own website (requires Include vendor details).",
            "default": false
          },
          "includeVendorDetails": {
            "title": "Include vendor details & contacts",
            "type": "boolean",
            "description": "Fetch the full vendor record for every result: <b>direct email, phone, website</b>, Instagram / Facebook / TikTok / Pinterest / LinkedIn / YouTube, full address & geo, description, exact price range, capacity, team size, manager name, weddings hosted, insurance, inclusivity options and specialties. This is the lead-gen wedge — keep it on.",
            "default": true
          },
          "enrichContactEmails": {
            "title": "Also crawl the vendor's website for extra emails",
            "type": "boolean",
            "description": "On top of the email Bridebook already exposes, crawl the vendor's own website (home + contact/about, max 3 pages) for any additional emails, phone numbers and social links. Only runs for vendors that have a website.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (only new / changed vendors)",
            "type": "boolean",
            "description": "Remember vendors seen on previous runs (by ID) and only output vendors that are <b>new</b> or whose price / reviews / details <b>changed</b> since last run. Perfect with a Schedule for a fresh wedding-lead feed. Each output record is tagged with <code>changeType</code> (new / updated).",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor state store name",
            "type": "string",
            "description": "Named key-value store that holds the 'seen' state for monitor mode. Change it to track several searches independently.",
            "default": "bridebook-monitor"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy used for Bridebook's search pages. The default Apify Proxy (datacenter) is verified clean and fast for Bridebook; switch to residential only if you scrape very aggressively.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}