{
  "openapi": "3.0.1",
  "info": {
    "title": "Hot Pepper Gourmet Scraper - Restaurants, Bars & Reviews",
    "description": "Scrape Hot Pepper Gourmet (hotpepper.jp) restaurants and bars across Japan by prefecture, area, genre or URL. Extract names, addresses, phone numbers, GPS, ratings, reviews, budgets, opening hours, seating, facilities, coupons and reservation links.",
    "version": "0.1",
    "x-build-id": "RbSywLRKtxClfxuVx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abotapi~hotpepper-jp-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abotapi-hotpepper-jp-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/abotapi~hotpepper-jp-scraper/runs": {
      "post": {
        "operationId": "runs-sync-abotapi-hotpepper-jp-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/abotapi~hotpepper-jp-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-abotapi-hotpepper-jp-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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What do you want to scrape?",
            "enum": [
              "search",
              "url"
            ],
            "type": "string",
            "description": "Search builds restaurant lists from locations and genres. URL mode takes restaurant pages or area list pages you paste. Fields in the other mode's section are ignored.",
            "default": "search"
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Prefecture names such as 東京 or Tokyo, prefecture codes such as SA11, a code with an area such as SA11/Y055 or SA11/Y005/X020, or Prefecture/Area names such as 東京/新宿. One list is walked per entry.",
            "default": [
              "東京"
            ],
            "items": {
              "type": "string"
            }
          },
          "genres": {
            "title": "Genres",
            "type": "array",
            "description": "Keep only these genres. Leave empty to walk every genre in turn.",
            "items": {
              "type": "string",
              "enum": [
                "G001",
                "G002",
                "G003",
                "G004",
                "G005",
                "G006",
                "G007",
                "G008",
                "G009",
                "G010",
                "G011",
                "G012",
                "G013",
                "G014",
                "G015",
                "G016",
                "G017"
              ],
              "enumTitles": [
                "居酒屋 (G001)",
                "ダイニングバー・バル (G002)",
                "創作料理 (G003)",
                "和食 (G004)",
                "洋食 (G005)",
                "イタリアン・フレンチ (G006)",
                "中華 (G007)",
                "焼肉・ホルモン (G008)",
                "アジア・エスニック料理 (G009)",
                "各国料理 (G010)",
                "カラオケ・パーティ (G011)",
                "バー・カクテル (G012)",
                "ラーメン (G013)",
                "カフェ・スイーツ (G014)",
                "その他グルメ (G015)",
                "お好み焼き・もんじゃ (G016)",
                "韓国料理 (G017)"
              ]
            }
          },
          "netReservationOnly": {
            "title": "Online reservation only",
            "type": "boolean",
            "description": "Only restaurants that take online reservations.",
            "default": false
          },
          "sortBy": {
            "title": "Order",
            "enum": [
              "default",
              "ranking"
            ],
            "type": "string",
            "description": "Default is the site's own list order. Ranking returns the popularity ranking of each location and genre, which is a single page of about 20 restaurants; online reservation filter and Max list pages do not apply to it.",
            "default": "default"
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Skip restaurants whose average review score is below this value (0 to 5). Setting it turns on restaurant detail pages because the score comes from there."
          },
          "minReviewCount": {
            "title": "Minimum reviews",
            "minimum": 0,
            "type": "integer",
            "description": "Skip restaurants with fewer reviews than this. Setting it turns on restaurant detail pages because the review count comes from there."
          },
          "urls": {
            "title": "Restaurant or list URLs",
            "type": "array",
            "description": "Paste any of these links: a prefecture or area page, a genre list in a prefecture, middle area or small area (including page-2 forms), an online-reservation list, a ranking page, or a restaurant page with its map, reviews or menu sub-pages. Lists are walked page by page; each restaurant link returns one record. Keyword search pages and other pages are skipped with a warning. Filter fields are ignored in URL mode.",
            "default": [
              "https://www.hotpepper.jp/SA11/",
              "https://www.hotpepper.jp/SA11/G001/",
              "https://www.hotpepper.jp/SA11/G001/bgn2/",
              "https://www.hotpepper.jp/SA11/Y055/G001/",
              "https://www.hotpepper.jp/SA11/Y005/X020/G001/",
              "https://www.hotpepper.jp/SA11/net1/",
              "https://www.hotpepper.jp/SA11/rank/",
              "https://www.hotpepper.jp/strJ000239981/",
              "https://www.hotpepper.jp/strJ000239981/map/",
              "https://www.hotpepper.jp/strJ000239981/report/",
              "https://www.hotpepper.jp/strJ000239981/food/",
              "https://www.hotpepper.jp/strJ000239981/?vos=nhppvccp99002"
            ],
            "items": {
              "type": "string"
            }
          },
          "fetchDetails": {
            "title": "Fetch restaurant detail pages",
            "type": "boolean",
            "description": "Open every restaurant page for full data: address, phone, rating, review count, opening hours, closing days, payment methods, seats and facilities, policies and the latest reviews. Off returns only the list-page summary.",
            "default": true
          },
          "includeReviews": {
            "title": "Add more customer reviews to each restaurant",
            "type": "boolean",
            "description": "Adds the restaurant's customer reviews to each row as a list, newest first: date, score, text, visit details and photos. Without this switch each detailed row carries the latest few reviews from its page. Needs 'Fetch restaurant detail pages' switched on. Each extra review is a separate paid event.",
            "default": false
          },
          "maxReviewsPerShop": {
            "title": "Max reviews per restaurant",
            "minimum": 1,
            "maximum": 300,
            "type": "integer",
            "description": "How many reviews to collect for each restaurant when extra reviews are on (5 reviews per page of the site). Reviews are billed per review returned, so this is also the most each restaurant can add to the bill.",
            "default": 20
          },
          "maxPages": {
            "title": "Max list pages per list",
            "minimum": 0,
            "type": "integer",
            "description": "Optional limit on list pages walked per list. Empty or 0 means unlimited. This does NOT cap the output and has no finite default: it defers to Max items (default 20), which is the only cap."
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum restaurants to return in total. 0 means unlimited.",
            "default": 20
          },
          "proxy": {
            "title": "Proxy",
            "type": "object",
            "description": "Proxy settings. The default datacenter connection works on every plan. Residential is recommended for the most reliable results, especially on large or frequent runs. If the selected connection is unavailable to your plan or is refused, the run moves on to a backup connection automatically; residential traffic from that automatic step is billed to your Apify plan.",
            "default": {
              "useApifyProxy": true
            }
          },
          "resumeFromRunId": {
            "title": "Resume from run ID",
            "type": "string",
            "description": "Run ID (or dataset ID) of a previous run of this Actor. Restaurants already collected there are skipped, so this run returns only new ones. Leave empty for a normal run."
          },
          "incrementalMode": {
            "title": "Incremental changes for scheduled runs",
            "type": "boolean",
            "description": "Turn this on for daily or recurring monitoring. A restaurant is UPDATED when any returned detail changes, including rating and review count; add fields you consider noise to Ignore fields below. The first run returns all matching restaurants as NEW; later runs return only NEW, UPDATED and REAPPEARED restaurants, and unchanged ones are neither returned nor billed unless Emit unchanged is on. State is kept separately for each search setup (locations, genres, links, order, online reservation filter, detail pages, minimum reviews and rating); use State key to name or share one monitoring campaign.",
            "default": false
          },
          "stateKey": {
            "title": "State key",
            "type": "string",
            "description": "Optional name for an incremental monitoring campaign. Leave empty to derive it from the search setup."
          },
          "emitUnchanged": {
            "title": "Emit unchanged restaurants (incremental mode only)",
            "type": "boolean",
            "description": "Off by default. Turn on to also return restaurants that have not changed since the last run, marked UNCHANGED. This returns, and bills, rows you already have, so leave it off unless you want the full snapshot every run.",
            "default": false
          },
          "emitExpired": {
            "title": "Emit expired restaurants (incremental mode only)",
            "type": "boolean",
            "description": "On by default. Also returns restaurants that were present in an earlier run but are no longer listed, marked EXPIRED. Only produced after a run that walked every tracked list to its last page, so never when Max items or Max list pages cut the run short, when Resume was used, in URL mode with single restaurant links, or for ranking lists. Turn it off if you do not need expiry tracking: each EXPIRED row is a returned (and billed) row.",
            "default": true
          },
          "ignoreFieldsForChanges": {
            "title": "Ignore fields when detecting changes (incremental mode only)",
            "type": "array",
            "description": "Field names that must never make a restaurant UPDATED, for example rating, reviewCount or badges. They are still returned in every row. Nothing is ignored by default except run bookkeeping (scrapedAt, position, page, listUrl, totalResults, rank, isPromoted) and the nested customer reviews, so a new review alone does not make a restaurant UPDATED; it still does when the review count or rating changes. Used only in incremental mode.",
            "items": {
              "type": "string"
            }
          },
          "mcpConnectors": {
            "title": "Pipe results into your apps (optional)",
            "type": "array",
            "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON, the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)."
          },
          "notionParentPageUrl": {
            "title": "Notion parent page (Notion connector only)",
            "type": "string",
            "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors."
          },
          "maxNotifyListings": {
            "title": "Max items to export per connector",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap on items written to each connector per run. Does not affect the dataset.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}