{ "openapi": "3.0.1", "info": { "title": "2GIS Scraper - Places, Ratings & Review Count Monitor", "description": "Scrape 2GIS (2ГИС) places by city and search term or search URL: name, category, address, coordinates, rating, number of ratings and reviews, hours, business phone, website and 2GIS ID. Monitor mode returns only new places and places whose rating or review count moved, with old and new values.", "version": "0.1", "x-build-id": "v5MXxACBf6msgZ6jd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~2gis-rating-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-2gis-rating-change-monitor", "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/neverempty~2gis-rating-change-monitor/runs": { "post": { "operationId": "runs-sync-neverempty-2gis-rating-change-monitor", "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/neverempty~2gis-rating-change-monitor/run-sync": { "post": { "operationId": "run-sync-neverempty-2gis-rating-change-monitor", "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 terms", "type": "array", "description": "What you would type into the 2GIS search box, for example cafe, dentist, кафе, стоматология. Each term is searched in the city below. Leave empty to use only search URLs or place URLs; if everything is empty, the run searches cafe in dubai as an example.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "The 2GIS city name as it appears in 2GIS links (2gis.ae/dubai, 2gis.ru/moscow), for example dubai, sharjah, moscow, spb, novosibirsk, almaty, astana, tashkent. Required with search terms; 2GIS picks the country site (2gis.ae, 2gis.ru, 2gis.kz) by itself." }, "searchUrls": { "title": "2GIS search URLs", "type": "array", "description": "Optional. 2GIS search pages copied from your browser, for example https://2gis.ae/dubai/search/cafe or https://2gis.ru/moscow/search/кафе/rubricId/161. Place pages pasted here are read as places. Leave empty to use only search terms.", "items": { "type": "string" } }, "placeUrls": { "title": "2GIS place URLs or IDs", "type": "array", "description": "Optional. 2GIS place pages or place IDs, for example https://2gis.ae/dubai/firm/70000001006365610 or 70000001006365610 (up to 100). Use this to watch the rating of your own branches or of named competitors. Leave empty to use only searches.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max places per search", "minimum": 1, "maximum": 60, "type": "integer", "description": "How many places to return for each search term or search URL, from 1 to 60 (2GIS shows 12 places a page and 5 pages). In watch mode this is how many places of each search are watched. Empty means 24." }, "includeContacts": { "title": "Add business phone, website and social links", "type": "boolean", "description": "On (default): open each returned place's own 2GIS page and add the business's public phone numbers, website and social links (the search page does not show them). Off: faster, without phone and website.", "default": true }, "includeSponsored": { "title": "Include advertised places", "type": "boolean", "description": "On (default): also return places shown in 2GIS advertising slots, marked sponsored true. Off: leave them out (they are counted in a free row).", "default": true }, "onlyNew": { "title": "Watch mode: only new places and rating changes", "type": "boolean", "description": "Off (default): return every place. On: the first run only remembers the places and their rating, rating count and review count (no rows, no charge). Later runs return only places that appear in the results for the first time and places whose rating, rating count or review count changed, with the old values. A search with no change costs one small check fee.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Optional, watch mode only. Keeps separate memories for separate schedules of the same search, for example client-a. Letters, digits, dot, dash and underscore, up to 40. Empty means one shared memory." }, "resetMonitoringState": { "title": "Start the watch again", "type": "boolean", "description": "Watch mode only. On: forget what this watch remembered for these searches and places, so this run becomes a new first run. Off (default): keep the memory.", "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 } } } } } } } } } }