{
  "openapi": "3.0.1",
  "info": {
    "title": "Maps Scraper Fast",
    "description": "Scrape Google Maps fast: names, phones, websites, addresses, ratings, reviews count, opening hours and coordinates of every place in any city or country. Optional emails and social profiles. Export to Excel, CSV or JSON.",
    "version": "2.0",
    "x-build-id": "jGMmQmvJ87r4TVirD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/knowten~maps-scraper-fast/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-knowten-maps-scraper-fast",
        "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/knowten~maps-scraper-fast/runs": {
      "post": {
        "operationId": "runs-sync-knowten-maps-scraper-fast",
        "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/knowten~maps-scraper-fast/run-sync": {
      "post": {
        "operationId": "run-sync-knowten-maps-scraper-fast",
        "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": {
          "searchStringsArray": {
            "title": "🔍 Search terms",
            "type": "array",
            "description": "What you would type into the Google Maps search bar, e.g. <code>restaurant</code>, <code>dentist</code> or <code>coffee shop</code>. Each term is searched separately. Tip: keep the location in the Location field below, not here, to cover the whole area.",
            "items": {
              "type": "string"
            }
          },
          "locationQuery": {
            "title": "📍 Location (use only one location per run)",
            "type": "string",
            "description": "City, region or country, e.g. <code>New York, USA</code> or <code>Bogotá, Colombia</code>. The whole area is covered automatically, so you get far more than the ~120 results Google Maps shows per search."
          },
          "maxCrawledPlacesPerSearch": {
            "title": "💯 Number of places to extract (per search term or URL)",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of places per search term or URL. Leave empty to get every place in the area."
          },
          "language": {
            "title": "🌍 Language",
            "enum": [
              "en",
              "es",
              "pt-BR",
              "pt-PT",
              "fr",
              "de",
              "it",
              "nl",
              "pl",
              "ru",
              "tr",
              "ar",
              "ja",
              "ko",
              "zh-CN",
              "zh-TW",
              "id",
              "vi",
              "th",
              "hi",
              "sv",
              "da",
              "no",
              "fi",
              "cs",
              "hu",
              "ro",
              "el",
              "uk",
              "he"
            ],
            "type": "string",
            "description": "Language of the results (categories, opening hours, attributes).",
            "default": "en"
          },
          "categoryFilterWords": {
            "title": "🎢 Place categories",
            "type": "array",
            "description": "Keep only places whose Google category contains one of these words (e.g. <code>dentist</code>). If you leave Search terms empty, these categories are searched instead.",
            "items": {
              "type": "string"
            }
          },
          "searchMatching": {
            "title": "Get exact name matches",
            "enum": [
              "all",
              "only_includes",
              "only_exact"
            ],
            "type": "string",
            "description": "Keep only places whose name matches the search term.",
            "default": "all"
          },
          "placeMinimumStars": {
            "title": "Set a minimum star rating",
            "enum": [
              "",
              "two",
              "twoAndHalf",
              "three",
              "threeAndHalf",
              "four",
              "fourAndHalf"
            ],
            "type": "string",
            "description": "Skip places rated below this.",
            "default": ""
          },
          "website": {
            "title": "Scrape places with/without a website",
            "enum": [
              "allPlaces",
              "withWebsite",
              "withoutWebsite"
            ],
            "type": "string",
            "description": "Great for lead generation: keep only places with a website, or only those without one.",
            "default": "allPlaces"
          },
          "skipClosedPlaces": {
            "title": "⏩ Skip closed places",
            "type": "boolean",
            "description": "Skip places marked as temporarily or permanently closed.",
            "default": false
          },
          "scrapePlaceDetailPage": {
            "title": "🔎 Scrape place detail page",
            "type": "boolean",
            "description": "Get extra information for each place: owner's description, plus code, 'located in', 'people also search for', review keywords, reservation links and a sample of reviews and photos. Takes a bit longer.",
            "default": false
          },
          "scrapeTableReservationProvider": {
            "title": "Scrape table reservation provider data",
            "type": "boolean",
            "description": "Add table reservation providers (OpenTable, Resy...) to the output.",
            "default": false
          },
          "maxReviews": {
            "title": "Number of reviews to include",
            "minimum": 0,
            "type": "integer",
            "description": "Number of latest reviews to include per place (a short sample). For the complete review history of any place, use our Maps Reviews Fast actor.",
            "default": 0
          },
          "reviewsStartDate": {
            "title": "Only reviews newer than",
            "type": "string",
            "description": "Only include reviews newer than this date."
          },
          "reviewsSort": {
            "title": "Sort reviews by",
            "enum": [
              "newest",
              "mostRelevant",
              "highestRanking",
              "lowestRanking"
            ],
            "type": "string",
            "description": "Order of the included reviews.",
            "default": "newest"
          },
          "reviewsFilterString": {
            "title": "Filter reviews by keyword",
            "type": "string",
            "description": "Only include reviews containing this text."
          },
          "reviewsOrigin": {
            "title": "Reviews origin",
            "enum": [
              "all",
              "google"
            ],
            "type": "string",
            "description": "Source of the included reviews.",
            "default": "all"
          },
          "scrapeReviewsPersonalData": {
            "title": "Include reviewers' personal data",
            "type": "boolean",
            "description": "Include the reviewer's name, ID, profile URL and photo. Personal data is protected by GDPR and similar laws; only enable it if you have a legitimate reason.",
            "default": true
          },
          "maxImages": {
            "title": "Number of additional images to extract",
            "minimum": 0,
            "type": "integer",
            "description": "Number of image URLs per place.",
            "default": 0
          },
          "scrapeImageAuthors": {
            "title": "Scrape image authors",
            "type": "boolean",
            "description": "Include the author of each image when available.",
            "default": false
          },
          "scrapeContacts": {
            "title": "📧 Add-on: Company contacts enrichment (emails & social profiles)",
            "type": "boolean",
            "description": "Visit each business website and collect emails, extra phone numbers and social media profiles (Facebook, Instagram, LinkedIn, X, YouTube, TikTok, Pinterest, Discord). Perfect for outreach. Costs +$0.25 per 1,000 places, charged only when contacts are found.",
            "default": false
          },
          "countryCode": {
            "title": "🗺 Country",
            "type": "string",
            "description": "Two-letter country code (e.g. <code>us</code>). Used when Location is empty, together with the fields below."
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "City name, e.g. <code>Pittsburgh</code>."
          },
          "state": {
            "title": "State",
            "type": "string",
            "description": "State or region, e.g. <code>Texas</code>."
          },
          "county": {
            "title": "County",
            "type": "string",
            "description": "County, e.g. <code>Madison</code>."
          },
          "postalCode": {
            "title": "Postal code",
            "type": "string",
            "description": "Postal code, e.g. <code>10001</code>."
          },
          "customGeolocation": {
            "title": "🛰 Custom search area",
            "type": "object",
            "description": "Draw your own search area: GeoJSON <code>Polygon</code>, <code>MultiPolygon</code> or <code>Point</code> with <code>radiusKm</code> for a circle. Coordinates are [longitude, latitude]. See the README for examples."
          },
          "startUrls": {
            "title": "Google Maps URLs",
            "type": "array",
            "description": "Already have the places or searches? Paste Google Maps place URLs, search URLs or short links (maps.app.goo.gl).",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "placeIds": {
            "title": "🗃 Place IDs",
            "type": "array",
            "description": "Google Place IDs (e.g. <code>ChIJjaFpo0ZawokRBcOFUZ13CaE</code>).",
            "items": {
              "type": "string"
            }
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many requests run in parallel. The default is the best balance of speed and reliability.",
            "default": 20
          },
          "fullViewRetries": {
            "title": "Retries for incomplete place details",
            "minimum": 0,
            "maximum": 15,
            "type": "integer",
            "description": "With the place detail page on, how many times to retry a place when Google returns incomplete details (missing price, menu or popular times). Higher = more complete data, slightly slower.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify Proxy is recommended and used by default.",
            "default": {
              "useApifyProxy": true
            }
          },
          "scrapeSocialMediaProfiles": {
            "title": "Social media profiles (compat)",
            "type": "object",
            "description": "Accepted for input compatibility. Social links come from scrapeContacts."
          },
          "includeWebResults": {
            "title": "Web results (compat)",
            "type": "boolean",
            "description": "Accepted for input compatibility; not supported."
          },
          "scrapeDirectories": {
            "title": "Directories (compat)",
            "type": "boolean",
            "description": "Accepted for input compatibility; not supported."
          },
          "maxQuestions": {
            "title": "Questions (compat)",
            "type": "integer",
            "description": "Accepted for input compatibility; not supported."
          },
          "maximumLeadsEnrichmentRecords": {
            "title": "Leads (compat)",
            "type": "integer",
            "description": "Accepted for input compatibility; not supported."
          },
          "verifyLeadsEnrichmentEmails": {
            "title": "Verify leads (compat)",
            "type": "boolean",
            "description": "Accepted for input compatibility; not supported."
          },
          "enableCompetitorAnalysis": {
            "title": "Competitor analysis (compat)",
            "type": "boolean",
            "description": "Accepted for input compatibility; not supported."
          },
          "maxCompetitorsToAnalyze": {
            "title": "Competitors (compat)",
            "type": "integer",
            "description": "Accepted for input compatibility; not supported."
          },
          "scrapeOrderOnline": {
            "title": "Order online (compat)",
            "type": "boolean",
            "description": "Accepted for input compatibility; googleFoodUrl is always included when available."
          },
          "allPlacesNoSearchAction": {
            "title": "All places (compat)",
            "type": "string",
            "description": "Accepted for input compatibility; not supported."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}