{
  "openapi": "3.0.1",
  "info": {
    "title": "Yelp Reviews Scraper: Yelp Reviews API, Every Review, No Key",
    "description": "Scrape every Yelp review of a business by URL, ID or search: text, rating, date, photos, owner reply, reviewer stats, plus Yelp business data: address, phone, website, hours. Every language, sort, star, keyword and date filter, and Yelp's not-recommended reviews. A Yelp Fusion API alternative.",
    "version": "0.1",
    "x-build-id": "M0XnSWqtfZxwNG28N"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hyperbach~yelp-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hyperbach-yelp-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~yelp-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-hyperbach-yelp-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~yelp-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-hyperbach-yelp-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": {
          "businessUrls": {
            "title": "Businesses (Yelp URLs, business ids or aliases)",
            "maxItems": 500,
            "type": "array",
            "description": "One value per business: a Yelp business page URL on any Yelp site (`https://www.yelp.com/biz/gary-danko-san-francisco`, `yelp.de/biz/…`, `m.yelp.com/biz/…`; its `?osq=` or `?hrid=` part is ignored), a 22-character business id (`WavvLdfdP6g8aZTtbBQHTw`), a bare alias (`gary-danko-san-francisco`), or a Yelp search URL with `find_desc` and `find_loc` (read as a search). Up to 500 values a run. A value that names no business gets a free `invalid` row; a business given twice is read once (a free `duplicate` row).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchTerms": {
            "title": "Search terms",
            "maxItems": 20,
            "type": "array",
            "description": "What you would type into Yelp's search box (`pizza`, `dentist`, a business name): each term is searched in `searchLocation`, and the businesses it finds are read like the ones above. Needs `searchLocation`. Up to 20 terms.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchLocation": {
            "title": "Search location",
            "maxLength": 200,
            "type": "string",
            "description": "Where the search terms are searched: a city (`Chicago, IL`), a postcode, a neighbourhood or an address. The search row says how Yelp read it.",
            "default": ""
          },
          "maxBusinessesPerSearch": {
            "title": "Businesses per search",
            "minimum": 1,
            "maximum": 240,
            "type": "integer",
            "description": "How many businesses each search term (or search URL) takes, in Yelp's order: 1 to 240 (Yelp lists 240 businesses a search at most).",
            "default": 10
          },
          "maxReviewsPerBusiness": {
            "title": "Reviews per business",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop each business after this many review rows. 0 = every review Yelp lists in the asked view (the business row then says COMPLETE when the walk reached Yelp's own end).",
            "default": 0
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "newest",
              "oldest",
              "highest",
              "lowest",
              "recommended",
              "elites"
            ],
            "type": "string",
            "description": "Yelp's own review order: newest first (the default), oldest first, highest or lowest rated first, Yelp's recommended order, or Elite reviewers first.",
            "default": "newest"
          },
          "language": {
            "title": "Language",
            "pattern": "^(all|[a-z]{2}(_[A-Z]{2})?)$",
            "maxLength": 5,
            "type": "string",
            "description": "The reviews' language as Yelp's two-letter code (`en`, the default; `fr`, `de`, `es`…), or `all` for every language the business has reviews in (one walk per language). Yelp shows one language at a time; without a language it shows English.",
            "default": "en"
          },
          "stars": {
            "title": "Stars",
            "pattern": "^([1-5](\\s*,\\s*[1-5]){0,4})?$",
            "maxLength": 20,
            "type": "string",
            "description": "Keep reviews of these star ratings only, comma-separated (`1`, `1,2`, `4,5`). Empty = every rating.",
            "default": ""
          },
          "keywords": {
            "title": "Keywords in the review",
            "maxItems": 20,
            "type": "array",
            "description": "Keep reviews that Yelp's own review search matches for these words or phrases (one search per keyword, a review found by two keywords delivered once; each row says its `keyword`). Yelp's review search has no order of its own: with a sort other than `recommended` each business's matches are read whole, then sorted. Up to 20.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "Reviews from (date)",
            "pattern": "^([0-9]{4}-[0-9]{2}-[0-9]{2}|[0-9]{1,5} ?[Dd]ays?)?$",
            "maxLength": 12,
            "type": "string",
            "description": "Keep reviews written on or after this day in the business's own time (`2026-01-31`), or within the last N days (`30 days`). With the newest-first sort the walk stops at the first older review: nothing older is read or charged.",
            "default": ""
          },
          "dateTo": {
            "title": "Reviews to (date)",
            "pattern": "^([0-9]{4}-[0-9]{2}-[0-9]{2})?$",
            "maxLength": 10,
            "type": "string",
            "description": "Keep reviews written on or before this day in the business's own time (`2026-06-30`). With the oldest-first sort the walk stops at the first newer review.",
            "default": ""
          },
          "translateTo": {
            "title": "Translate to",
            "pattern": "^([a-z]{2})?$",
            "maxLength": 2,
            "type": "string",
            "description": "A two-letter language code (`en`): Yelp's own translation of each review into it, in `text_translated`, beside the original text. Empty = no translation.",
            "default": ""
          },
          "includeNotRecommended": {
            "title": "Include Yelp's not-recommended and removed reviews",
            "type": "boolean",
            "description": "Also read the reviews Yelp's filter keeps off the business page (its not-recommended list) and the ones Yelp removed for a content violation, each row marked by `review_status`. They are review rows like the others (charged, counted by the limits). The business row always carries both counts.",
            "default": false
          },
          "includePersonalData": {
            "title": "Include reviewers' names, photos and profile links",
            "type": "boolean",
            "description": "Off (the default): the reviewer's name, photo and profile link and the replier's name stay empty; the reviewer's public counts, elite year and city are on every row. On: you take the responsibility for processing personal data under the laws that apply to you.",
            "default": false
          },
          "onlyNewReviews": {
            "title": "Only reviews not delivered before",
            "type": "boolean",
            "description": "Skip the reviews an earlier run with the same memory delivered (free), so a scheduled run delivers only what is new. With the newest-first sort a business's walk stops at its first review delivered before.",
            "default": false
          },
          "stateStoreName": {
            "title": "Memory name",
            "pattern": "^[A-Za-z0-9._~-]{0,100}$",
            "maxLength": 100,
            "type": "string",
            "description": "The name of the memory `onlyNewReviews` keeps (letters, digits, `.`, `_`, `~`, `-`). Empty = a name made from the inputs.",
            "default": ""
          },
          "maxItems": {
            "title": "Max review rows (the whole run)",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "Stop the run after this many review rows across every business (0 = no limit). Business and search rows are free and not counted. A business left unread at the limit gets a free `not_read` row.",
            "default": 0
          },
          "proxyUrl": {
            "title": "Proxy URL",
            "type": "string",
            "description": "Empty (recommended): Yelp is read through the Actor's own connections at no extra cost to you. Your own proxy URL (scheme://user:pass@host:port) carries every call instead. The word none runs without any proxy, from the Apify worker's own IP (for tests)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}