{ "openapi": "3.0.1", "info": { "title": "๐Ÿš€ Yelp Scraper ยท 5,000 Free Businesses/Month", "description": "Yelp Scraper gets you Yelp businesses โšก fast, ๐ŸŽฏ 100% accurate and ๐Ÿ” ridiculously detailed โ€” ratings, review counts, prices, phones, websites & addresses. ๐Ÿ’ฐ $1 per 1,000 businesses, no start fee. Scrape your first 5,000 businesses free every month ๐Ÿš€", "version": "0.0", "x-build-id": "C0l0HotqETPkFlTU7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omkar-cloud~yelp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omkar-cloud-yelp-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/omkar-cloud~yelp-scraper/runs": { "post": { "operationId": "runs-sync-omkar-cloud-yelp-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/omkar-cloud~yelp-scraper/run-sync": { "post": { "operationId": "run-sync-omkar-cloud-yelp-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": [ "locations" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "What to search for, e.g. pizza, plumbers, coffee. Leave empty to search by category only.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "City, neighborhood, address or ZIP code to search in, e.g. San Francisco, CA or 10001.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Optional Yelp category alias or name (pizza, italian, Coffee & Tea), or a yelp.com search link with cflt=." }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "highest_rated", "most_reviewed" ], "type": "string", "description": "Result order.", "default": "recommended" }, "price": { "title": "Price levels", "type": "array", "description": "Keep only these price levels. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "$", "$$", "$$$", "$$$$" ] } }, "features": { "title": "Features", "type": "array", "description": "Keep only businesses with these features, e.g. open_now, outdoor_seating, free_wifi, offers_delivery, takes_reservations, good_for_kids, dogs_allowed.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max businesses per search", "minimum": 1, "maximum": 240, "type": "integer", "description": "Stop each search after this many businesses (Yelp shows at most 240 per search).", "default": 50 }, "scrapeFullDetails": { "title": "Add full business details", "type": "boolean", "description": "One extra lookup per business for its full profile.", "default": false }, "maxResults": { "title": "Max businesses", "minimum": 1, "type": "integer", "description": "Stop after this many businesses in total โ€” caps the cost of a run.", "default": 1000 } } }, "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 } } } } } } } } } }