{ "openapi": "3.0.1", "info": { "title": "The Knot Scraper [$1/1K💰] | Wedding Vendor Leads & Reviews", "description": "Pull US wedding vendor leads from The Knot - name, category, city, rating, review count, starting price, phone, email, website, awards and gallery, plus optional vendor reviews.", "version": "0.0", "x-build-id": "1dCx46ZilBPEvXgKn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~theknot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-theknot-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/ahmed_jasarevic~theknot-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-theknot-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/ahmed_jasarevic~theknot-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-theknot-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "The Knot category listing URLs or vendor profile URLs to scrape, e.g. https://www.theknot.com/marketplace/wedding-photographers-new-york-ny. Profile URLs are detected automatically. Enable 'Fetch full profiles' to enrich listing vendors with contact details.", "items": { "type": "string" } }, "maxListings": { "title": "Maximum listings per category", "type": "integer", "description": "Maximum number of vendor listings to pull from each category page before paging. The Knot returns 30 vendors per page.", "default": 30 }, "maxPages": { "title": "Maximum pages per category", "type": "integer", "description": "Maximum number of paginated category pages to fetch per start URL.", "default": 1 }, "maxItems": { "title": "Maximum total vendors", "type": "integer", "description": "Hard cap on total vendor records pushed to the dataset.", "default": 200 }, "fetchProfiles": { "title": "Fetch full profiles", "type": "boolean", "description": "Fetch each vendor's full profile page to collect phone, email, website and social links, and to attach the complete description and gallery. Those fields are not present on the category listing page. Roughly one extra request per vendor. Each profile fetch is billed as a 'profile-detail' event.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Call the public The Knot reviews GraphQL API and store up to 'maxReviewsPerVendor' recent reviews per vendor in a separate 'reviews' dataset. Each review is billed as a 'review' event.", "default": false }, "maxReviewsPerVendor": { "title": "Max reviews per vendor", "type": "integer", "description": "Number of recent reviews to attach per vendor when 'Include review details' is enabled.", "default": 5 }, "maxRequestsPerCrawl": { "title": "Maximum total requests", "type": "integer", "description": "Hard safety cap on the number of HTTP requests made by this run.", "default": 250 }, "maxConcurrency": { "title": "Parallel requests", "type": "integer", "description": "Number of simultaneous HTTP requests. Profile pages are independent, so higher values finish much faster. Lower this if The Knot starts returning 403 (DataDome).", "default": 12 }, "minConcurrency": { "title": "Minimum parallel requests", "type": "integer", "description": "Floor for the autoscaled pool. Leave at the default so the run starts at full speed instead of ramping up.", "default": 12 }, "requestDelayMs": { "title": "Delay between requests (ms)", "type": "integer", "description": "Politeness delay inserted before each request. Set 0 for maximum speed, raise it if requests start failing.", "default": 200 }, "requestHandlerTimeoutSecs": { "title": "Request timeout (seconds)", "type": "integer", "description": "Per-request timeout.", "default": 60 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "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 } } } } } } } } } }