{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Maps Reviews Scraper & Google Reviews Scraper API",
    "description": "Scrape Google Maps reviews by place URL, place ID, search or reviewer profile: text and translation, stars, exact date, reviewer name and link, photos, owner reply, sub-ratings. Sort, date window, star and keyword filters. No login, no API key. Export to CSV, JSON or Excel. Misses free.",
    "version": "0.1",
    "x-build-id": "N6hnmlF8vsjRURc0l"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hyperbach~google-maps-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hyperbach-google-maps-reviews-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/hyperbach~google-maps-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-hyperbach-google-maps-reviews-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/hyperbach~google-maps-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-hyperbach-google-maps-reviews-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": "Google Maps place URLs",
            "maxItems": 5000,
            "type": "array",
            "description": "Any link to a place: a Maps place link, a maps.app.goo.gl, g.page or share.google link, a search link (/maps/search/…: its places are read), a shared list, or a contributor link (/maps/contrib/…). A link that names no place gets a free row that says why.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "placeIds": {
            "title": "Place IDs",
            "maxItems": 5000,
            "type": "array",
            "description": "Google place ids (ChIJ…), CIDs (the number in ?cid=) or fids (0x…:0x…).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchStringsArray": {
            "title": "Search terms",
            "maxItems": 500,
            "type": "array",
            "description": "Words Google Maps searches for, with the place in them or in Location (\"hotel\" + \"Paris\"). Each search's first places (Max places per search) are read.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "locationQuery": {
            "title": "Location",
            "type": "string",
            "description": "A city, region or country added to every search term (\"Paris, France\"). Leave empty when the terms name their place.",
            "default": ""
          },
          "maxPlacesPerSearch": {
            "title": "Max places per search",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many of a search's places are read, in Google's order.",
            "default": 5
          },
          "contributorUrls": {
            "title": "Contributor URLs",
            "maxItems": 500,
            "type": "array",
            "description": "A reviewer's public profile link (…/maps/contrib/<number>) or number: that person's own reviews, up to 200 (Google's limit signed out), each with the place it is about.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxReviews": {
            "title": "Max reviews per place",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "The most reviews read for each place (and each contributor). 0 = every review the place has.",
            "default": 0
          },
          "reviewsSort": {
            "title": "Sort reviews by",
            "enum": [
              "newest",
              "mostRelevant",
              "highestRanking",
              "lowestRanking",
              "oldest"
            ],
            "type": "string",
            "description": "Newest and most relevant read to the list's end. Highest and lowest end at 188 reviews per star level (Google's own limit): the place row then says TRUNCATED; turn on the full star order to read the whole list. Oldest reads the whole list, then delivers it oldest first.",
            "default": "newest"
          },
          "starSortFullList": {
            "title": "Full star order (highest / lowest)",
            "type": "boolean",
            "description": "With Highest or Lowest rating: read the whole newest list and sort it here, so no star level stops at 188. Slower; the reviews come once the list is read.",
            "default": false
          },
          "reviewsStartDate": {
            "title": "Only reviews newer than",
            "type": "string",
            "description": "A date (2024-05-03) or a span (3 hours, 8 days, 3 months, 1 year). With Newest the walk stops there; with another order the older reviews are left out.",
            "default": ""
          },
          "reviewsEndDate": {
            "title": "Only reviews older than",
            "type": "string",
            "description": "A date (2024-12-31) or a span (1 month). Newer reviews are read and left out, free.",
            "default": ""
          },
          "minStars": {
            "title": "Min stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Leave out reviews under this many stars (free).",
            "default": 1
          },
          "maxStars": {
            "title": "Max stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Leave out reviews over this many stars (free).",
            "default": 5
          },
          "reviewsFilterString": {
            "title": "Filter reviews by keywords",
            "type": "string",
            "description": "Keep only reviews whose text (or its translation) holds one of these words or phrases, split by commas. Google has no keyword filter, so the Actor reads each review: a filtered walk reads up to 1,200 reviews plus 600 for each kept one.",
            "default": ""
          },
          "onlyWithText": {
            "title": "Only reviews with text",
            "type": "boolean",
            "description": "Leave out star-only reviews (free).",
            "default": false
          },
          "onlyWithOwnerReply": {
            "title": "Only reviews with an owner reply",
            "type": "boolean",
            "description": "Keep only the reviews the owner answered.",
            "default": false
          },
          "onlyWithPhotos": {
            "title": "Only reviews with photos",
            "type": "boolean",
            "description": "Keep only reviews with the reviewer's photos.",
            "default": false
          },
          "reviewLanguages": {
            "title": "Review languages",
            "type": "array",
            "description": "Keep only reviews written in these languages (codes: en, de, es …). Empty = every language.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "af",
              "az",
              "id",
              "ms",
              "bs",
              "ca",
              "cs",
              "da",
              "de",
              "et",
              "es",
              "es-419",
              "eu",
              "fil",
              "fr",
              "gl",
              "hr",
              "zu",
              "is",
              "it",
              "sw",
              "lv",
              "lt",
              "hu",
              "nl",
              "no",
              "uz",
              "pl",
              "pt-BR",
              "pt-PT",
              "ro",
              "sq",
              "sk",
              "sl",
              "fi",
              "sv",
              "vi",
              "tr",
              "el",
              "bg",
              "ky",
              "kk",
              "mk",
              "mn",
              "ru",
              "sr",
              "uk",
              "ka",
              "hy",
              "iw",
              "ur",
              "ar",
              "fa",
              "am",
              "ne",
              "hi",
              "mr",
              "bn",
              "pa",
              "gu",
              "ta",
              "te",
              "kn",
              "ml",
              "si",
              "th",
              "lo",
              "my",
              "km",
              "ko",
              "ja",
              "zh-CN",
              "zh-TW"
            ],
            "type": "string",
            "description": "The language Google answers in: the translation of each review not written in it, the dates' words and the labels. Every call asks for it, and the Actor checks the answer is in it.",
            "default": "en"
          },
          "personalData": {
            "title": "Reviewer's name, photo and link",
            "type": "boolean",
            "description": "The reviewer's public name, photo, profile link and id on each row. Off: those four are left empty.",
            "default": true
          },
          "maxItems": {
            "title": "Max reviews (whole run)",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "The most charged reviews of the whole run; 0 = no cap beyond your charge limit.",
            "default": 0
          },
          "feedback": {
            "title": "Feedback to the maintainers",
            "maxLength": 2000,
            "type": "string",
            "description": "A note to the people who maintain this Actor: what you needed and did not get. For example a missing field, a wrong or empty result, or the Actor you switch from or to, and why. The run does not read it: the rows and the charges stay the same. A person reads every note."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}