{
"openapi": "3.0.1",
"info": {
"title": "2GIS Places Scraper",
"description": "Scrape 2GIS places and businesses in Russia, Kazakhstan, Kyrgyzstan, Uzbekistan and Dubai by search query and city, or from any 2GIS search, category, company or place link: name, categories, address, district, coordinates, rating, reviews, opening hours, website, photos, branches. Pay per place.",
"version": "1.0",
"x-build-id": "AAuXTuvnNoZnP6K5g"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/brii3343~2gis-places-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-brii3343-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/brii3343~2gis-places-scraper/runs": {
"post": {
"operationId": "runs-sync-brii3343-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/brii3343~2gis-places-scraper/run-sync": {
"post": {
"operationId": "run-sync-brii3343-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": {
"searchQueries": {
"title": "Search queries",
"type": "array",
"description": "What to search on 2GIS, one per line, as you would type it in the 2GIS search bar: a type of place (кафе, стоматология, автосервис) or a name (Шоколадница). Write in the language of the city (Russian for Russia, Kazakhstan, Kyrgyzstan, Uzbekistan; English for Dubai). Each query is searched in the city below; to search another city on one line write кафе @ Almaty.",
"items": {
"type": "string"
}
},
"city": {
"title": "City",
"type": "string",
"description": "City for the search queries, in English or as on 2GIS: Moscow, Saint Petersburg, Novosibirsk, Kazan, Almaty, Astana, Bishkek, Tashkent, Dubai, Abu Dhabi, or a smaller town such as Мытищи. Searches stay inside this city. Empty = Moscow."
},
"wholeRegion": {
"title": "Search the whole 2GIS region",
"type": "boolean",
"description": "For search queries: also the suburbs and nearby towns of the 2GIS region, like the 2gis.ru search does (Moscow with its oblast, all of the UAE for Dubai, all of Kyrgyzstan for Bishkek). Off = only the city. Links always return what 2GIS shows for the link.",
"default": false
},
"startUrls": {
"title": "2GIS URLs",
"type": "array",
"description": "2GIS links copied from the address bar: a search (https://2gis.ru/moscow/search/кафе), a category (https://2gis.kz/almaty/search/Рестораны/rubricId/164), all branches of a company (https://2gis.ru/moscow/branches/70000001042709619) or one place (https://2gis.ru/moscow/firm/70000001041081959). Any 2GIS domain works (2gis.ru, 2gis.kz, 2gis.kg, 2gis.uz, 2gis.ae).",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxItemsPerSource": {
"title": "Max places per search or URL",
"minimum": 0,
"type": "integer",
"description": "Places to save for each search query and each URL. 0 = everything 2GIS finds (big cities have thousands of places for common searches).",
"default": 50
},
"maxItems": {
"title": "Max places in total",
"minimum": 0,
"type": "integer",
"description": "Stop after this many places in the whole run. 0 = no limit.",
"default": 0
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed: the scraper uses Apify Proxy (datacenter) and switches to residential proxies by itself only when 2GIS does not answer. Set a proxy here only to force one.",
"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
}
}
}
}
}
}
}
}
}
}