{ "openapi": "3.0.1", "info": { "title": "2GIS Scraper — Phones, Emails & Reviews | Парсер 2ГИС", "description": "2GIS scraper & API: export places with phones, emails, websites, VK/Telegram/WhatsApp links, address, rating, hours and reviews for any city and search query. No login.", "version": "0.2", "x-build-id": "fA1uzCg7B0wtrsqzo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/innolabs~2gis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-innolabs-2gis-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/innolabs~2gis-scraper/runs": { "post": { "operationId": "runs-sync-innolabs-2gis-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/innolabs~2gis-scraper/run-sync": { "post": { "operationId": "run-sync-innolabs-2gis-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": [ "cities", "queries" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "2GIS city slugs or city URLs, e.g. moscow, spb, novosibirsk, kazan, almaty, https://2gis.ru/ekaterinburg. Each city is searched separately.", "items": { "type": "string" } }, "queries": { "title": "Search queries", "type": "array", "description": "What you would type into 2GIS search, e.g. кофе, стоматология, автосервис, салон красоты. Every city × query pair is searched.", "items": { "type": "string" } }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also save the reviews of every place found, one dataset item per review, newest first.", "default": false }, "maxResultsPerQuery": { "title": "Max places per city/query", "minimum": 1, "maximum": 100000, "type": "integer", "description": "How many places to keep from each city × query search. A single 2GIS search returns at most 10,000 places; turn on Deep search to go beyond that.", "default": 30 }, "deepSearch": { "title": "Deep search (beyond 10,000 places)", "type": "boolean", "description": "When a search stops before 2GIS's own result count (2GIS serves at most 10,000 places per search), repeat it district by district and merge the results without duplicates. Raise 'Max places per city/query' above 10,000 to use it.", "default": false }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "maximum": 500, "type": "integer", "description": "Review cap for every place when Include reviews is on.", "default": 20 }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on dataset items (places + reviews) for the whole run. The run stops cleanly when reached, so this also caps the cost.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. 2GIS geo-filters some networks and rate-limits busy IPs; a proxy is recommended for large runs.", "default": { "useApifyProxy": true } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log every search page and any contact/review fetch that failed.", "default": false } } }, "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 } } } } } } } } } }