{ "openapi": "3.0.1", "info": { "title": "VietnamYello Business Directory Scraper", "description": "[💰 $0.4 / 1K] Extract Vietnam business listings from VietnamYello — company name, phone, website, full address, GPS coordinates, categories, opening hours, registration & VAT numbers, and employee count. Browse by category and city, or search by keyword. Clean data for lead generation.", "version": "1.0", "x-build-id": "goJ8SMjXKcIcefPAv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~vietnamyello-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-vietnamyello-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/solidcode~vietnamyello-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-vietnamyello-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/solidcode~vietnamyello-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-vietnamyello-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": { "categories": { "title": "Categories", "type": "array", "description": "Business categories to collect, taken from a VietnamYello category page URL (e.g. 'restaurants', 'lawyers', 'estate-agents', 'doctors-and-clinics', 'construction-services'). Use the slug that appears after /category/ in the address bar. Each category is combined with every city below, so you can cover many categories in one run. Leave empty to browse cities only.", "items": { "type": "string" } }, "locations": { "title": "Cities", "type": "array", "description": "Vietnamese cities or provinces to browse, using the slug from a VietnamYello location page (e.g. 'hanoi', 'ho-chi-minh-city', 'danang', 'haiphong', 'bien-hoa', 'dong-nai', 'thanh-hoa'). Each city is combined with every category above. Leave empty to search across all of Vietnam.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "Free-text terms to search across the whole directory (e.g. 'seafood export', 'software company', 'coffee'). Use this when a business type has no dedicated category page. Keyword searches cover all of Vietnam and are not narrowed by the cities above.", "items": { "type": "string" } }, "startUrls": { "title": "VietnamYello URLs", "type": "array", "description": "Paste VietnamYello links directly from your browser — category pages (e.g. https://www.vietnamyello.com/category/restaurants), city pages (e.g. https://www.vietnamyello.com/location/hanoi), search result pages, or individual company profiles (e.g. https://www.vietnamyello.com/company/367879/...). When provided, the Categories, Cities, and Search Keywords above are ignored.", "items": { "type": "string" } }, "includeDetails": { "title": "Include full business details", "type": "boolean", "description": "When enabled, the actor opens each company profile to add the complete record — website, fax, full opening hours, business description, year established, employee count, registration code, VAT number, products, and review summary. Turn this off for a faster, lighter run that returns just the core fields visible on the results list (name, profile URL, phone, GPS coordinates, categories, and partial address).", "default": true }, "maxResults": { "title": "Maximum Results", "minimum": 0, "type": "integer", "description": "Hard cap on the total number of business listings collected across all categories, cities, keywords, and URLs. Default 100 — increase for bigger runs. A built-in safety ceiling of 50,000 results applies to every run: any higher value (including 0, which means 'collect as much as possible') is capped at 50,000. Each listing is billed at the per-result rate.", "default": 100 } } }, "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 } } } } } } } } } }