{ "openapi": "3.0.1", "info": { "title": "2GIS Places Scraper", "description": "Scrape 2GIS business listings by keyword, category, city or map area: name, address, phones, e-mails, website, socials, opening hours, rating, reviews and photos. Russia, Kazakhstan, UAE, Gulf and 20 countries. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "qicx0ZH6ty3wuJpEY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nice_dev~2gis-places-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nice_dev-2gis-places-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/nice_dev~2gis-places-scraper/runs": { "post": { "operationId": "runs-sync-nice_dev-2gis-places-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/nice_dev~2gis-places-scraper/run-sync": { "post": { "operationId": "run-sync-nice_dev-2gis-places-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": { "startUrls": { "title": "Start URLs", "maxItems": 1000, "type": "array", "description": "2GIS URLs on any 2GIS domain: search results (`https://2gis.ru/moscow/search/кафе`; a category or filters after the text are kept: `https://2gis.ru/moscow/search/кафе/rubricId/161`), place pages (`https://2gis.ru/moscow/firm/70000001063551091`), lists of all the branches of a company (`https://2gis.ru/moscow/branches/4504136498310300`), area pages (`https://2gis.ae/dubai/geo/13933647002593361`) or short links (`https://go.2gis.com/abc123`). When this list or **Place IDs** is not empty, the search fields below (keywords, locations, map area) are ignored; filters, caps, reviews and monitoring still apply. Paste the URLs themselves: a link to a text file of URLs is not read. Max 1 000 URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "placeIds": { "title": "Place IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "2GIS place (branch) IDs: the number after `/firm/` in a place URL, e.g. `70000001063551091`. Added to **Start URLs**: the search fields below are then ignored. Max 500.", "default": [], "items": { "type": "string" } }, "query": { "title": "Search keyword", "maxLength": 200, "type": "string", "description": "What to look for, as typed on 2GIS, in any language (e.g. `cafe`, `кафе`, `dentist`). Leave empty and give **Category IDs** to list a whole category." }, "searchQueries": { "title": "More search keywords", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several keywords in one run: one search per keyword (times each location below). Added to **Search keyword**; places found by several searches are saved once.", "default": [], "items": { "type": "string" } }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "City or region covered by 2GIS, by name in Russian or English (e.g. `Москва`, `Dubai`, `Almaty`), by URL slug (`moscow`) or by 2GIS region ID (`32`). Empty = the map area below." }, "locations": { "title": "More locations", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several locations in one run: every keyword is searched in every location (3 keywords × 4 locations = 12 searches, max 500). A country counts one search per region. Added to **Location**.", "default": [], "items": { "type": "string" } }, "rubricIds": { "title": "Category IDs", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Only places of these 2GIS categories (rubric IDs, e.g. `161` = cafés; the IDs of each place's categories are in the `rubrics` output field). With no keyword, the whole category is listed in the location.", "default": [], "items": { "type": "string" } }, "coordinates": { "title": "Map center (latitude,longitude)", "pattern": "^\\s*-?\\d{1,2}(\\.\\d+)?\\s*,\\s*-?\\d{1,3}(\\.\\d+)?\\s*$", "maxLength": 60, "type": "string", "description": "Search around this point instead of a named location: `latitude,longitude` in decimal degrees, latitude FIRST (e.g. `55.7558,37.6173` = Moscow center). Used with **Radius**. When a location is also given, the area wins and the location only picks the 2GIS region and language." }, "radiusKm": { "title": "Radius (km)", "minimum": 0.05, "maximum": 40, "type": "number", "description": "Search radius around **Map center**, from 0.05 to 40 km (e.g. `5` = places within 5 km). Default 5.", "default": 5 }, "boundingBox": { "title": "Map rectangle", "pattern": "^\\s*-?\\d{1,2}(\\.\\d+)?\\s*,\\s*-?\\d{1,3}(\\.\\d+)?\\s*,\\s*-?\\d{1,2}(\\.\\d+)?\\s*,\\s*-?\\d{1,3}(\\.\\d+)?\\s*$", "maxLength": 120, "type": "string", "description": "Search this rectangle: `south,west,north,east` in decimal degrees (e.g. `55.57,37.35,55.92,37.85` = Moscow inside the ring road). Wins over Map center. When a location is also given, the area wins and the location only picks the 2GIS region and language." }, "customGeolocation": { "title": "Custom area (GeoJSON)", "type": "object", "description": "Search inside a drawn area: a GeoJSON `Polygon` or `MultiPolygon` (coordinates as `[longitude, latitude]`, as in GeoJSON). Wins over Map rectangle and Map center. When a location is also given, the area wins and the location only picks the 2GIS region and language." }, "maxItems": { "title": "Max places", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of places to save for the whole run (after deduplication and filters). 0 = no limit.", "default": 100 }, "maxItemsPerQuery": { "title": "Max places per search", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap for EACH search (keyword × location, or search URL), so that the first search cannot use up the whole **Max places** budget. 0 = no per-search cap.", "default": 0 }, "language": { "title": "Language", "enum": [ "auto", "uz_RU", "az_RU", "ru_AM", "ar_KW", "ar_IQ", "ru_RU", "kk_KZ", "en_KW", "ru_UZ", "cs_CZ", "en_CY", "en_BH", "ar_QA", "uk_RU", "en_QA", "en_SA", "tg_TJ", "en_AM", "zh_RU", "ky_RU", "hy_AM", "en_RU", "it_RU", "en_OM", "ar_SA", "ru_TH", "it_IT", "ar_BH", "es_RU", "ka_RU", "ar_AE", "ru_TJ", "ru_GE", "ar_OM", "ar_EG", "ru_BY", "ar_RU", "ka_GE", "ru_KG", "ky_KG", "es_CL", "ru_KZ", "en_EG", "en_AE", "tg_RU", "en_IQ", "az_AZ", "cs_RU", "en_TH", "ru_AZ", "hy_RU", "uz_UZ", "kk_RU" ], "type": "string", "description": "Language of names, addresses, categories, opening-hours comments and attribute labels, as a 2GIS locale (language_COUNTRY, e.g. `en_AE`). Automatic = the main language of the region of each search (the first one it offers among the languages of the 2GIS regions: Russian in Moscow, Azerbaijani in Baku, English in Dubai). A language the region of a search does not offer is replaced by the main language of the region, with a warning in the log. Review texts stay as written.", "default": "auto" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "rating", "name", "opened_time", "distance" ], "type": "string", "description": "Order of the 2GIS results. Relevance is the 2GIS default. Distance needs **Map center** (or a Start URL with a point).", "default": "relevance" }, "includeContacts": { "title": "Include contacts", "type": "boolean", "description": "Add phones, e-mails, messengers (WhatsApp, Telegram, Viber) and social networks of each place. Charged as a separate event, see Pricing. Off = those fields are null; the website and the `hasPhone` / `hasEmail` / `hasWebsite` flags are always filled.", "default": false }, "minRating": { "title": "Minimum place rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only places rated at least this (0-5, e.g. `4.5`). Places without a rating are dropped. 0 = no minimum.", "default": 0 }, "minReviewCount": { "title": "Minimum number of reviews", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop the places with fewer reviews than this. 0 = no minimum.", "default": 0 }, "hasWebsite": { "title": "Website", "enum": [ "any", "with", "without" ], "type": "string", "description": "Keep all places, only the places with a website (applied by 2GIS, no extra cost), or only the places without one (checked by the Actor: each place dropped is charged as a Filter check event).", "default": "any" }, "hasPhotos": { "title": "With photos only", "type": "boolean", "description": "Only places that have photos (2GIS filter).", "default": false }, "hasReviews": { "title": "With reviews only", "type": "boolean", "description": "Only places that have reviews (2GIS filter).", "default": false }, "openNow": { "title": "Open now", "type": "boolean", "description": "Only places open at the time of the run (2GIS filter).", "default": false }, "open24h": { "title": "Open 24 hours", "type": "boolean", "description": "Only places open around the clock (2GIS filter).", "default": false }, "requirePhone": { "title": "With phone only", "type": "boolean", "description": "Drop the places without a phone number. Needs **Include contacts**.", "default": false }, "requireEmail": { "title": "With e-mail only", "type": "boolean", "description": "Drop the places without an e-mail address. Needs **Include contacts**.", "default": false }, "requireWebsite": { "title": "With website only", "type": "boolean", "description": "Drop the places without a website.", "default": false }, "attributeTags": { "title": "Attribute tags", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Only places that have all these 2GIS attributes, as tags (e.g. `food_service_food_vegan`, `wifi`). The tag of each attribute of a place is in the `attributes` output field. 2GIS filter.", "default": [], "items": { "type": "string" } }, "metroStationIds": { "title": "Metro station IDs", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "2GIS IDs of metro stations (digits, e.g. `4504385606385704`): filters places near any of these stations. 2GIS filter.", "default": [], "items": { "type": "string" } }, "avgPriceMin": { "title": "Average bill from", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only places whose average bill is at least this, in the local currency (restaurants, cafés and other food places). 0 = no minimum.", "default": 0 }, "avgPriceMax": { "title": "Average bill up to", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only places whose average bill is at most this, in the local currency (restaurants, cafés and other food places). 0 = no maximum.", "default": 0 }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop the places whose name, category or address contains one of these words (case and accents ignored). A city name drops every place of that city.", "default": [], "items": { "type": "string" } }, "excludePlaceIds": { "title": "Exclude place IDs", "maxItems": 10000, "uniqueItems": true, "type": "array", "description": "Never save these places (e.g. your own branches, or places you already have).", "default": [], "items": { "type": "string" } }, "skipAds": { "title": "Skip promoted places", "type": "boolean", "description": "Drop the places 2GIS shows as promoted (advertising).", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add the reviews of each place (50 per request) from 2GIS, Flamp and Booking, with author, rating, date, text, likes, photos and the owner's answer. Charged per review as a separate event, see Pricing.", "default": false }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of reviews per place. 0 = all, up to about 6,000 per place (a row is capped at 6 MB; the run log says when).", "default": 20 }, "reviewSort": { "title": "Review order", "enum": [ "date_created", "date_edited", "friends", "trust" ], "type": "string", "description": "Order in which reviews are read (and cut by Max reviews per place).", "default": "date_created" }, "postedAfter": { "title": "Reviews posted after", "type": "string", "description": "Only reviews written on or after this date: `2026-09-01`, or a period before now such as `7 days`, `2 weeks`, `1 month` (API: `24 hours` and full ISO date-times work too). Places are never dropped by this filter." }, "postedBefore": { "title": "Reviews posted before", "type": "string", "description": "Only reviews written on or before this date (the whole day is included), or older than a period such as `30 days`." }, "minReviewRating": { "title": "Minimum review rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only reviews rated at least this many stars (1-5). 0 = all.", "default": 0 }, "maxReviewRating": { "title": "Maximum review rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only reviews rated at most this many stars (e.g. `2` = complaints only). 0 = all.", "default": 0 }, "onlyWithText": { "title": "Reviews with text only", "type": "boolean", "description": "Drop the ratings without any text.", "default": false }, "onlyWithBusinessReply": { "title": "Reviews with an owner's answer only", "type": "boolean", "description": "Keep only the reviews the business answered.", "default": false }, "reviewKeywords": { "title": "Review keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Keep only the reviews whose text contains one of these words (case and accents ignored).", "default": [], "items": { "type": "string" } }, "reviewSources": { "title": "Review sources", "uniqueItems": true, "type": "array", "description": "Sites the reviews come from. Empty = all of them.", "items": { "type": "string", "enum": [ "2gis", "flamp", "booking" ], "enumTitles": [ "2GIS", "Flamp", "Booking" ] }, "default": [] }, "includeUnratedReviews": { "title": "Include reviews without a star rating", "type": "boolean", "description": "2GIS reviews that carry only text or a comment, with no stars. Off = only rated reviews.", "default": false }, "includePhotos": { "title": "Include photos", "type": "boolean", "description": "Add the photo gallery of each place (full-size URL, size, description), up to **Max photos per place**. Charged as a separate event, see Pricing. The cover photo and the photo count are always in the output.", "default": false }, "maxPhotos": { "title": "Max photos per place", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of photos per place. 0 = all.", "default": 20 }, "photoAlbums": { "title": "Photo albums", "uniqueItems": true, "type": "array", "description": "Albums read when **Include photos** is on: the photos posted for the place, the photos of its building, or its facilities. Empty = the place photos only.", "items": { "type": "string", "enum": [ "common", "view", "facilities" ], "enumTitles": [ "Place photos", "Building photos", "Facilities" ] }, "default": [ "common" ] }, "onlyNew": { "title": "Only new places", "type": "boolean", "description": "Skip the places that a previous run (same **Memory key**) already delivered: they are not saved and not charged. First run = everything is new.", "default": false }, "stateKey": { "title": "Memory key", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "maxLength": 64, "type": "string", "description": "Name of the memory used by **Only new places**. Give each schedule / task its own key (e.g. `moscow-cafes`) so that they do not share their memory. Letters, digits, `-` and `_`.", "default": "default" }, "resetState": { "title": "Reset the memory", "type": "boolean", "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) everything again. Untick it afterwards.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of requests processed in parallel.", "default": 8 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 10, "maximum": 2000, "type": "integer", "description": "Most requests to the site in any 60 seconds, all of them counted: results pages, listing pages and the extra page read for a listing. A budget, not an even pace: up to this many can leave at once when the minute starts (spread them with the minimum delay below). Lower it if the site answers HTTP 429 / 403 in the log.", "default": 120 }, "minRequestIntervalMs": { "title": "Min delay between requests", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.", "default": 0 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries per request before it is marked as failed. Behind a proxy, a request the site turns away is also retried on a new proxy session up to 10 times without using up these retries.", "default": 5 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Include debug messages in the run log.", "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 } } } } } } } } } }