{ "openapi": "3.0.1", "info": { "title": "HotPepper Beauty Japan Salon Scraper", "description": "Scrape hair, nail, eyelash, esthetic and relaxation salons from HotPepper Beauty (beauty.hotpepper.jp) by genre, region and area. Get phone, address, GPS, rating, reviews, hours, payment methods, staff and seat counts, prices, coupons and customer demographics. No browser, no login.", "version": "0.0", "x-build-id": "j6CALSpv26wkekw94" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piquno~hotpepper-beauty-japan-salon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piquno-hotpepper-beauty-japan-salon-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/piquno~hotpepper-beauty-japan-salon-scraper/runs": { "post": { "operationId": "runs-sync-piquno-hotpepper-beauty-japan-salon-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/piquno~hotpepper-beauty-japan-salon-scraper/run-sync": { "post": { "operationId": "run-sync-piquno-hotpepper-beauty-japan-salon-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": { "genre": { "title": "Genre", "enum": [ "hair", "nail", "esthe", "relax" ], "type": "string", "description": "Which HotPepper Beauty vertical to crawl.", "default": "hair" }, "region": { "title": "Region", "enum": [ "kanto", "kansai", "tokai", "hokkaido", "tohoku", "chugoku", "kyushu", "hokushinetsu", "shikoku" ], "type": "string", "description": "HotPepper Beauty region. Combine with Area to narrow down.", "default": "kanto" }, "area": { "title": "Area filter", "type": "string", "description": "Optional. Area inside the region, by Japanese name (partial matches are fine: 新宿, 渋谷, 横浜, 梅田, 名駅) or by code (macAA). Several areas may match a short name. Leave empty to crawl the whole region area by area. The README lists every area." }, "subArea": { "title": "Sub-area filter", "type": "string", "description": "Optional. Sub-area inside the matched area(s), by Japanese name (e.g. 高田馬場, 西口) or code (sacX001). Sub-areas are listed on each area page." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Your own HotPepper Beauty listing URLs, e.g. https://beauty.hotpepper.jp/svcSA/macAA/salon/ (hair, Shinjuku), https://beauty.hotpepper.jp/nail/svcSB/macBA/salon/ (nail, Umeda) or a sub-area / PNn.html page. Each is paginated automatically. Overrides the fields above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max salons", "minimum": 1, "type": "integer", "description": "Stop after this many unique salons. Each salon is one dataset item and one billable result.", "default": 100 }, "includeDetails": { "title": "Scrape salon pages", "type": "boolean", "description": "Also open every salon page for phone number, GPS coordinates, rating, opening hours, closed days, payment methods, website, feature tags, all coupons, average spend and customer demographics. One extra request per salon, same price per result.", "default": false }, "requestDelaySecs": { "title": "Delay between requests (s)", "minimum": 0, "maximum": 30, "type": "number", "description": "Pause after each successful request.", "default": 0.5 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default. Switch to residential (country JP) only if the log reports many blocked requests.", "default": { "useApifyProxy": 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 } } } } } } } } } }