{ "openapi": "3.0.1", "info": { "title": "2GIS Places Scraper", "description": "Scrapes businesses from 2GIS (Russia, Kazakhstan, UAE, Uzbekistan, Kyrgyzstan, Azerbaijan, Cyprus, Chile and more) by search query and city or by link: name, categories, address, coordinates, phones, website, e-mails, social links, opening hours, rating and optional reviews.", "version": "0.0", "x-build-id": "DE5pbHvkcUHM6Nxkx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mina_safwat~2gis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mina_safwat-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/mina_safwat~2gis-scraper/runs": { "post": { "operationId": "runs-sync-mina_safwat-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/mina_safwat~2gis-scraper/run-sync": { "post": { "operationId": "run-sync-mina_safwat-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", "properties": { "searchQueries": { "title": "Search queries", "type": "array", "description": "What to search for, one per line, just as you would type it into 2GIS: a category (cafe, dentist, car service), a brand (Starbucks) or any words. Each query is searched in the city below.", "default": [], "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "The city to search in, in English or the local language, such as Dubai, Abu Dhabi, Moscow, Москва, Almaty, Tashkent, Riyadh or Limassol. Needed for search queries; links carry their own city.", "default": "" }, "startUrls": { "title": "2GIS links", "type": "array", "description": "2GIS links, one per line, from any 2GIS site (2gis.ru, 2gis.ae, 2gis.kz, 2gis.uz…): a place (https://2gis.ae/dubai/firm/70000001006365610), a search (https://2gis.ru/moscow/search/кафе), a category (…/search/Кафе/rubricId/161), or all branches of a company (https://2gis.ru/moscow/branches/70000001034739764). A bare place ID works too. Links pasted without https:// are fine.", "default": [], "items": { "type": "string" } }, "maxPlacesPerSearch": { "title": "Max places per search or link", "minimum": 0, "type": "integer", "description": "Stops after this many places for each search query or search link, in 2GIS's own order. Set 0 for every place 2GIS lists (a big city can have several thousand cafes).", "default": 100 }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Adds the newest reviews with a star rating to each place, in a reviews list. Each review is billed as one review event on top of the place.", "default": false }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "How many of the newest reviews to add to each place when reviews are on. Set 0 for all of them.", "default": 20 }, "language": { "title": "Language", "enum": [ "", "en", "ru", "ar", "kk", "uz", "ky", "az", "es", "cs", "it", "hy", "ka", "tg", "uk", "zh" ], "type": "string", "description": "Language for names, categories and addresses. 2GIS translates each country into a few languages only (for example English or Arabic in the UAE, Russian or English in Russia); when a country has no such version, its default language is used and the log says so. Review texts are always as their authors wrote them.", "default": "" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave this empty: the Actor uses Apify's datacenter proxy, and retries through residential proxy on its own if 2GIS ever refuses.", "default": { "useApifyProxy": 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 } } } } } } } } } }