{ "openapi": "3.0.1", "info": { "title": "2GIS Scraper — Places, Reviews, Jobs & Realty", "description": "Scrape 2GIS (2ГИС) places, reviews, jobs and realty in one run — phones, emails, websites, hours, ratings, review replies, vacancy apply links, and CIAN / Domclick housing ads. City + query or any 2gis.ru / .kz / .com search, firm, vacancies, or realty URL. JSON or CSV.", "version": "0.1", "x-build-id": "WUlt9BsSVutU3S7QT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~2gis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~2gis-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~2gis-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "scrapeMode": { "title": "Scrape mode", "enum": [ "places", "reviews", "jobs", "realty", "all" ], "type": "string", "description": "Choose places, reviews, jobs, realty, or all four in one run.", "default": "places" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "What to search for on 2GIS, one query per line. Examples: кафе, барбершоп, pharmacy, hotel. Used when Start URLs are empty.", "items": { "type": "string" } }, "location": { "title": "City / location", "type": "string", "description": "City name in English or Russian, e.g. Moscow, Москва, Dubai, Almaty. Combined with each search query to build a 2GIS listing URL.", "default": "Moscow" }, "country": { "title": "Country domain", "enum": [ "auto", "ru", "kz", "ae", "uz", "by", "kg", "am", "az", "ge", "sa", "bh", "qa", "kw", "om", "cy", "cz", "it", "cl", "md", "iq", "ng", "com" ], "type": "string", "description": "2GIS TLD to use when the city name is ambiguous. Auto picks from the city map (Moscow → 2gis.ru, Dubai → 2gis.com, Almaty → 2gis.kz).", "default": "auto" }, "startUrls": { "title": "2GIS URLs", "type": "array", "description": "Full 2GIS URLs: /{city}/search/{query}, /{city}/firm/{id}, /{city}/vacancies, /{city}/realty/sale. Mix freely.", "items": { "type": "string" } }, "organizationIds": { "title": "Firm / organization IDs", "type": "array", "description": "2GIS firm IDs or firm URLs. Scraped directly. Combined with Start URLs when both are set.", "items": { "type": "string" } }, "includeContacts": { "title": "Include contacts (phone, website, email)", "type": "boolean", "description": "Fetch each firm page so phones, websites, emails and social links are filled. Search cards alone do not carry contacts.", "default": true }, "skipClosedPlaces": { "title": "Skip closed places", "type": "boolean", "description": "Drop places whose name looks permanently closed.", "default": false }, "rubricIds": { "title": "Rubric IDs or names", "type": "array", "description": "Numeric 2GIS rubric IDs (e.g. 161) or names (Кафе). IDs go on the search URL.", "items": { "type": "string" } }, "filterHasSite": { "title": "Has website", "type": "boolean", "description": "Only places with a website on the firm page.", "default": false }, "filterHasPhotos": { "title": "Has photos", "type": "boolean", "description": "Only places that expose at least one photo.", "default": false }, "filterDelivery": { "title": "Delivery", "type": "boolean", "description": "Home delivery (covid_homedelivery on the listing URL).", "default": false }, "filterTakeaway": { "title": "Takeaway", "type": "boolean", "description": "Food takeaway / навынос.", "default": false }, "filterWifi": { "title": "Wi-Fi", "type": "boolean", "description": "Places that advertise Wi-Fi.", "default": false }, "filterPaymentCard": { "title": "Card payment", "type": "boolean", "description": "Places that accept cards.", "default": false }, "filterHasGoods": { "title": "Has prices / goods", "type": "boolean", "description": "Places with a 2GIS price list (sorting_has_goods).", "default": false }, "filterOpen24h": { "title": "Open 24 hours", "type": "boolean", "description": "Around-the-clock places.", "default": false }, "filterCreatedRecently": { "title": "New places", "type": "boolean", "description": "2GIS created_recently listing filter (new in the city).", "default": false }, "filterMinRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Drop places below this star rating (1–5). Also picks a matching 2GIS rating URL filter." }, "filterAvgPriceMin": { "title": "Average check from", "minimum": 0, "type": "integer", "description": "Minimum average bill when 2GIS exposes one. Places with no bill still pass." }, "filterAvgPriceMax": { "title": "Average check to", "minimum": 0, "type": "integer", "description": "Maximum average bill when 2GIS exposes one." }, "skipRealty": { "title": "Skip realty / housing", "type": "boolean", "description": "Drop places whose rubrics look like apartments or real-estate agencies.", "default": false }, "districts": { "title": "Districts", "type": "array", "description": "District names or IDs, e.g. Пресненский.", "items": { "type": "string" } }, "metros": { "title": "Metro stations", "type": "array", "description": "Station names when 2GIS puts them on the firm card.", "items": { "type": "string" } }, "buildings": { "title": "Buildings", "type": "array", "description": "Building names from the firm address.", "items": { "type": "string" } }, "customGeolocation": { "title": "GeoJSON (Point / Polygon)", "type": "object", "description": "GeoJSON Point (coordinates [lon, lat], optional radiusKm, default 5) or Polygon / MultiPolygon. Draw at geojson.io. Places outside the shape are dropped and not charged." }, "maxPhotosPerPlace": { "title": "Max photos per place", "minimum": 0, "maximum": 200, "type": "integer", "description": "Photo URLs kept on the place row. Default 20. No extra charge.", "default": 20 }, "photoCategories": { "title": "Photo categories", "type": "array", "description": "Keep only these kinds when 2GIS labels them: food, menu, interior, outside, rooms, pool, spa, parking.", "items": { "type": "string" } }, "followOrgBranches": { "title": "Walk every branch of the org", "type": "boolean", "description": "After a place with orgBranchCount > 1, open /branches/{orgId} and scrape the other firms. Each extra firm is one place-scraped.", "default": false }, "followInsideBuildings": { "title": "Walk /inside/ buildings", "type": "boolean", "description": "Follow /inside/{id} links found on firm pages and scrape firms in that building. Each extra firm is one place-scraped.", "default": false }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "How many reviews to pull for each place. 0 disables reviews unless scrape mode is Reviews (then it defaults to 20).", "default": 0 }, "reviewSortBy": { "title": "Review sort", "enum": [ "date_edited", "date_created", "rating" ], "type": "string", "description": "Order used on the 2GIS reviews API.", "default": "date_edited" }, "reviewRatings": { "title": "Review sentiment", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "positive = rating ≥ 4, negative = rating ≤ 2.", "default": "all" }, "repliesOnly": { "title": "Only reviews with an official reply", "type": "boolean", "description": "Keep reviews that have officialAnswer.text.", "default": false }, "reviewKeywords": { "title": "Review keywords", "type": "array", "description": "Keep a review if its text (or the official reply) contains any of these strings.", "items": { "type": "string" } }, "reviewSource": { "title": "Review source", "enum": [ "all", "2gis", "flamp", "booking" ], "type": "string", "description": "2GIS sometimes mirrors Flamp or Booking text on the same branch.", "default": "all" }, "reviewDateFrom": { "title": "Reviews from date", "type": "string", "description": "Inclusive start (YYYY-MM-DD or a relative date)." }, "reviewDateTo": { "title": "Reviews to date", "type": "string", "description": "Inclusive end date." }, "includeUnratedReviews": { "title": "Include unrated reviews", "type": "boolean", "description": "Ask the reviews API for rated=false (unverified / unrated rows).", "default": false }, "includeReviewerData": { "title": "Include reviewer name / id", "type": "boolean", "description": "When off, userId and userName are cleared before the row is saved.", "default": true }, "realtyCategory": { "title": "Property category", "enum": [ "sale_residential", "sale_commercial", "rent_residential", "rent_commercial", "daily_rent" ], "type": "string", "description": "Sale / rent, residential or commercial, or daily rent.", "default": "sale_residential" }, "realtySort": { "title": "Property sort", "enum": [ "", "price_asc", "price_desc", "area_asc", "area_desc" ], "type": "string", "description": "Passed to the 2GIS realty API when it honours sort.", "default": "" }, "rooms": { "title": "Rooms", "type": "array", "description": "Studio, 1–4, or 5+.", "items": { "type": "string", "enum": [ "studio", "1", "2", "3", "4", "5" ], "enumTitles": [ "Studio", "1", "2", "3", "4", "5+" ] } }, "propertyType": { "title": "Property type", "type": "array", "description": "Matched on the 2GIS «Тип помещения» attribute.", "items": { "type": "string", "enum": [ "flat", "house", "land", "cottage", "room", "townhouse", "share", "part_house" ], "enumTitles": [ "Apartment", "House", "Land", "Cottage", "Room", "Townhouse", "Share", "Part of house" ] } }, "newBuilding": { "title": "New building / resale", "type": "array", "description": "New-build vs resale, from the listing text when 2GIS does not expose a dedicated flag.", "items": { "type": "string", "enum": [ "secondary", "new" ], "enumTitles": [ "Resale", "New building" ] } }, "priceMin": { "title": "Price from", "minimum": 0, "type": "integer", "description": "Minimum listing price (same currency as 2GIS, usually RUB)." }, "priceMax": { "title": "Price to", "minimum": 0, "type": "integer", "description": "Maximum listing price." }, "pricePerMeterMin": { "title": "Price per m² from", "minimum": 0, "type": "integer", "description": "Minimum price per square metre." }, "pricePerMeterMax": { "title": "Price per m² to", "minimum": 0, "type": "integer", "description": "Maximum price per square metre." }, "areaMin": { "title": "Area from, m²", "minimum": 0, "type": "integer", "description": "Minimum total area in square metres." }, "areaMax": { "title": "Area to, m²", "minimum": 0, "type": "integer", "description": "Maximum total area in square metres." }, "floorMin": { "title": "Floor from", "minimum": 0, "type": "integer", "description": "Minimum floor number." }, "floorMax": { "title": "Floor to", "minimum": 0, "type": "integer", "description": "Maximum floor number." }, "notFirstFloor": { "title": "Not first floor", "type": "boolean", "description": "Drop listings on floor 1 when the floor is known.", "default": false }, "notLastFloor": { "title": "Not last floor", "type": "boolean", "description": "Needs «Этажей в доме» on the card. Listings without that attribute still pass.", "default": false }, "floorsInBuildingMin": { "title": "Floors in building from", "minimum": 0, "type": "integer", "description": "Minimum number of floors in the building when 2GIS exposes it." }, "floorsInBuildingMax": { "title": "Floors in building to", "minimum": 0, "type": "integer", "description": "Maximum number of floors in the building when 2GIS exposes it." }, "metroTime": { "title": "Walk to metro, minutes", "enum": [ "", "0,5", "0,10", "0,20" ], "type": "string", "description": "Uses the nearest-station distance on the card (about 80 m/min).", "default": "" }, "provider": { "title": "Listing site", "type": "array", "description": "CIAN or Domclick, from the 2GIS card.", "items": { "type": "string", "enum": [ "cian", "domclick" ], "enumTitles": [ "CIAN", "Domclick" ] } }, "maxItems": { "title": "Maximum items", "minimum": 1, "type": "integer", "description": "Hard cap across places, reviews, jobs and properties combined. Each dataset row counts as one item.", "default": 100 }, "monitoringMode": { "title": "Only new places since last run", "type": "boolean", "description": "Skip firm IDs already delivered to this user. First run after enabling still returns the full match set and seeds the store.", "default": false }, "resetMonitoringState": { "title": "Reset monitoring state", "type": "boolean", "description": "Clear the per-user seen-ID store at the start of this run. Has no effect when monitoring is off.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "How many firm pages and review requests to run in parallel.", "default": 8 }, "minConcurrency": { "title": "Min concurrency", "minimum": 1, "type": "integer", "description": "Minimum parallel requests on the Crawlee fallback path.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Retries before a failed request is dropped on the Crawlee fallback path.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Optional override. Paying runs already use a built-in residential proxy. 2GIS listing pages work without a proxy from many networks; set this if you hit blocks." } } }, "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 } } }, "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 } } } } } } } } } }