{ "openapi": "3.0.1", "info": { "title": "2GIS (2ГИС) Scraper - Places, Phones + Public Reviews", "description": "Search 2GIS by keyword and city, or paste place links: public business cards (phones, website, rating, hours) and public reviews. No login.", "version": "0.0", "x-build-id": "itZGwkjoC7Eee7yMU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lanternlab318~2gis/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lanternlab318-2gis", "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/lanternlab318~2gis/runs": { "post": { "operationId": "runs-sync-lanternlab318-2gis", "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/lanternlab318~2gis/run-sync": { "post": { "operationId": "run-sync-lanternlab318-2gis", "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": "One 2GIS search term per line, in the local language where you can - \"кофейня\" returns far more than \"coffee shop\" in Moscow. Each term is searched separately in the City below and its results are labelled with it. A place that matches several of your terms is returned once and charged once.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "The 2GIS city code from the address bar: \"moscow\", \"spb\", \"novosibirsk\", \"ekaterinburg\", \"kazan\", \"almaty\", \"astana\", \"bishkek\", \"dubai\". You can also paste a 2GIS city link such as https://2gis.kz/almaty. Cities outside Russia are served from their own 2GIS site automatically. Defaults to moscow." }, "placeUrls": { "title": "Place links or place IDs", "type": "array", "description": "Collect specific places instead of, or in addition to, searching. Paste the 2GIS place link (https://2gis.ru/moscow/firm/70000001113359188, from any 2GIS country site) or just the numeric place ID. Search terms are not required when this is filled in.", "items": { "type": "string" } }, "maxPlaces": { "title": "Max places per search term", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper bound on the places one search term may produce. 2GIS serves 12 places per result page. When 2GIS runs out of results first, the row count is 2GIS's limit, not this setting, and the input row shows 2GIS's own total.", "default": 50 }, "includeReviews": { "title": "Also collect public reviews", "type": "boolean", "description": "With this on, every place also gets its public reviews as separate rows, newest first: star rating, review text, publish time, likes, photo count and the owner's reply when there is one. Nothing about the reviewer is collected. Reviews come 50 per request. Off by default.", "default": false }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper bound on the review rows one place may produce. Only used when Also collect public reviews is on.", "default": 50 }, "maxUpstreamRequests": { "title": "Max 2GIS requests", "minimum": 1, "type": "integer", "description": "Hard ceiling on the HTTP requests this run sends to 2GIS: search pages, place pages, reviews requests and retries together. At the ceiling collection stops - the inputs not reached are written with partialReason \"upstream_request_cap\" and the run then ends normally. Leave empty and the Actor works a ceiling out from your inputs and limits, so a run is never unbounded." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The proxy the requests to 2GIS go through. Keep the default. A run that is refused anyway reports blocked with the refusing response's own signature, never zero results.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }