{ "openapi": "3.0.1", "info": { "title": "Website Builder Phone Number Scraper", "description": "Website Builder Phone Number Scraper returns phone number, international format, national format, country code, line type, mobile flag, WhatsApp flag, store name, site builder platform, business domain, country, city, carrier, source url, timestamp for every row.", "version": "2.0", "x-build-id": "esWsLbyNvnt5BRPUR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/premiumscraper~website-builder-phone-number-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-premiumscraper-website-builder-phone-number-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/premiumscraper~website-builder-phone-number-scraper/runs": { "post": { "operationId": "runs-sync-premiumscraper-website-builder-phone-number-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/premiumscraper~website-builder-phone-number-scraper/run-sync": { "post": { "operationId": "run-sync-premiumscraper-website-builder-phone-number-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords (what business do you want?)", "minItems": 1, "type": "array", "description": "Type the business category, store type, or craft service - boutique clothing, artisan coffee, wedding photographer, pottery studio. One line per keyword. Related keywords are searched automatically, so keep each line short. Examples: boutique clothing, artisan coffee, interior designer, handmade jewelry. TIP: give SEVERAL keywords, one per line - each one finds a different set of companies, so three keywords return far more contacts than one.", "items": { "type": "string" } }, "locations": { "title": "Location (one only)", "type": "string", "description": "One town, city, area or postcode. Leave empty to search the whole country. SPELLING MATTERS: the location is searched exactly as written, so a misspelt place returns nothing at all rather than fewer results - there is no place list behind this box, so nothing will correct it for you. Use the spelling local businesses use on their own pages. ⚠️ Country, number code and location must all be the SAME country. They are combined in one search, not offered as alternatives - a location or a number code from a different country than the one selected returns few results or none, and there is no guarantee of any. ⚠️ ONE PLACE OR ONE POSTCODE — NEVER BOTH. This box is searched exactly as you type it, as a single phrase. \"Dhaka 1207\" is not searched as \"Dhaka\" and as \"1207\"; it is searched as the words \"Dhaka 1207\", and almost no page prints a town and its postcode side by side, so you will get very little. To cover both, run the actor twice — the town on one run, the postcode on the other.", "default": "" }, "countries": { "title": "Countries", "type": "array", "description": "Which countries the phone numbers must belong to. Leave empty to search WORLDWIDE with no country restriction (the default). Pick one or more to scope the search region, the phone number format we look for, and the country check on every number we keep, to just those countries. ⚠️ When you DO pick countries, number code and location must all be the SAME country. They are combined in one search, not offered as alternatives - a location or a number code from a different country than the one(s) selected returns few results or none, and there is no guarantee of any.", "items": { "type": "string", "enum": [ "Afghanistan (+93)", "Albania (+355)", "Algeria (+213)", "Andorra (+376)", "Angola (+244)", "Antigua And Barbuda (+1-268)", "Argentina (+54)", "Armenia (+374)", "Australia (+61)", "Austria (+43)", "Azerbaijan (+994)", "Bahamas (+1-242)", "Bahrain (+973)", "Bangladesh (+880)", "Belarus (+375)", "Belgium (+32)", "Belize (+501)", "Benin (+229)", "Bhutan (+975)", "Bolivia (+591)", "Bosnia And Herzegovina (+387)", "Botswana (+267)", "Brazil (+55)", "Brunei (+673)", "Bulgaria (+359)", "Burkina Faso (+226)", "Burundi (+257)", "Cambodia (+855)", "Cameroon (+237)", "Canada (+1)", "Cape Verde (+238)", "Central African Republic (+236)", "Chad (+235)", "Chile (+56)", "China (+86)", "Colombia (+57)", "Congo (Democratic Republic) (+243)", "Congo (Republic) (+242)", "Costa Rica (+506)", "Croatia (+385)", "Cuba (+53)", "Cyprus (+357)", "Czech Republic (+420)", "Denmark (+45)", "Djibouti (+253)", "Dominica (+1-767)", "Dominican Republic (+1-809)", "East Timor (+670)", "Ecuador (+593)", "Egypt (+20)", "El Salvador (+503)", "Estonia (+372)", "Ethiopia (+251)", "Fiji (+679)", "Finland (+358)", "France (+33)", "Gabon (+241)", "Gambia (+220)", "Georgia (+995)", "Germany (+49)", "Ghana (+233)", "Greece (+30)", "Guatemala (+502)", "Guyana (+592)", "Haiti (+509)", "Honduras (+504)", "Hungary (+36)", "Iceland (+354)", "India (+91)", "Indonesia (+62)", "Iraq (+964)", "Ireland (+353)", "Israel (+972)", "Italy (+39)", "Jamaica (+1-876)", "Japan (+81)", "Jordan (+962)", "Kazakhstan (+7)", "Kenya (+254)", "Kiribati (+686)", "Korea, South (+82)", "Kuwait (+965)", "Kyrgyzstan (+996)", "Laos (+856)", "Latvia (+371)", "Lebanon (+961)", "Lesotho (+266)", "Libya (+218)", "Liechtenstein (+423)", "Lithuania (+370)", "Luxembourg (+352)", "Madagascar (+261)", "Malawi (+265)", "Malaysia (+60)", "Maldives (+960)", "Mali (+223)", "Malta (+356)", "Mauritius (+230)", "Mexico (+52)", "Micronesia (+691)", "Moldova (+373)", "Mongolia (+976)", "Montenegro (+382)", "Morocco (+212)", "Mozambique (+258)", "Myanmar (+95)", "Namibia (+264)", "Nauru (+674)", "Nepal (+977)", "Netherlands (+31)", "New Zealand (+64)", "Nicaragua (+505)", "Niger (+227)", "Nigeria (+234)", "North Macedonia (+389)", "Norway (+47)", "Oman (+968)", "Pakistan (+92)", "Panama (+507)", "Papua New Guinea (+675)", "Paraguay (+595)", "Peru (+51)", "Philippines (+63)", "Poland (+48)", "Portugal (+351)", "Qatar (+974)", "Romania (+40)", "Russia (+7)", "Rwanda (+250)", "Saint Vincent And The Grenadines (+1-784)", "Samoa (+685)", "San Marino (+378)", "Sao Tome And Principe (+239)", "Saudi Arabia (+966)", "Senegal (+221)", "Serbia (+381)", "Seychelles (+248)", "Sierra Leone (+232)", "Singapore (+65)", "Slovakia (+421)", "Slovenia (+386)", "Solomon Islands (+677)", "Somalia (+252)", "South Africa (+27)", "Spain (+34)", "Sri Lanka (+94)", "Suriname (+597)", "Sweden (+46)", "Switzerland (+41)", "Taiwan (+886)", "Tajikistan (+992)", "Tanzania (+255)", "Thailand (+66)", "Togo (+228)", "Tonga (+676)", "Trinidad And Tobago (+1-868)", "Tunisia (+216)", "Turkey (+90)", "Turkmenistan (+993)", "Uganda (+256)", "Ukraine (+380)", "United Arab Emirates (+971)", "United Kingdom (+44)", "United States (+1)", "Uruguay (+598)", "Uzbekistan (+998)", "Vanuatu (+678)", "Venezuela (+58)", "Vietnam (+84)", "Zambia (+260)", "Zimbabwe (+263)" ], "enumTitles": [ "Afghanistan", "Albania", "Algeria", "Andorra", "Angola", "Antigua And Barbuda", "Argentina", "Armenia", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Belarus", "Belgium", "Belize", "Benin", "Bhutan", "Bolivia", "Bosnia And Herzegovina", "Botswana", "Brazil", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Central African Republic", "Chad", "Chile", "China", "Colombia", "Congo (Democratic Republic)", "Congo (Republic)", "Costa Rica", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "East Timor", "Ecuador", "Egypt", "El Salvador", "Estonia", "Ethiopia", "Fiji", "Finland", "France", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Greece", "Guatemala", "Guyana", "Haiti", "Honduras", "Hungary", "Iceland", "India", "Indonesia", "Iraq", "Ireland", "Israel", "Italy", "Jamaica", "Japan", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Korea, South", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Mauritius", "Mexico", "Micronesia", "Moldova", "Mongolia", "Montenegro", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "New Zealand", "Nicaragua", "Niger", "Nigeria", "North Macedonia", "Norway", "Oman", "Pakistan", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Poland", "Portugal", "Qatar", "Romania", "Russia", "Rwanda", "Saint Vincent And The Grenadines", "Samoa", "San Marino", "Sao Tome And Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "Spain", "Sri Lanka", "Suriname", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Togo", "Tonga", "Trinidad And Tobago", "Tunisia", "Turkey", "Turkmenistan", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Zambia", "Zimbabwe" ] }, "default": [] }, "dialCodes": { "title": "📞 Number codes to search for (optional)", "type": "array", "description": "Dialling codes, area codes or mobile prefixes to hunt for, written the way pages in your market print them - \"+39\", \"02\", \"347\", \"0161\". Each one you add is searched alongside the contact words, so the more you give the more numbers come back. ⚠️ THEY MUST BELONG TO THE COUNTRY YOU SELECTED ABOVE. A US area code on an Italian search finds nothing at all - the two are combined, not offered as alternatives. Country, number code and location must all be the same country. Leave this empty and the search runs on the contact words alone, which is how it works for every country. Adding codes narrows it; it never widens it.", "items": { "type": "string" } }, "maxResults": { "title": "How many phone numbers per keyword?", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many to collect FOR EACH KEYWORD you typed - not for the whole run. Two keywords at 20 gives you up to 40. Start small to see what a site returns, then raise it. TO GET MORE, ADD MORE KEYWORDS - vary them (plumber, emergency plumber, boiler repair). Each one reaches a different set of companies, so three keywords at 50 beats one keyword at 150.", "default": 5 }, "visitPages": { "title": "Open the result pages for more numbers", "type": "boolean", "description": "Slower and more expensive, but it reads the whole page instead of just the search's short text, so it finds far more numbers and it is the only way WhatsApp links can be found. Turn this on when quality matters more than speed. **Slowest setting in the actor.** Leaving it off keeps a run to minutes; turning it on opens each result's own pages and can multiply the run time several times over. Worth it only when you need contacts that are not visible in the listing itself.", "default": 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 } } } } } } } } } }