{ "openapi": "3.0.1", "info": { "title": "Google Maps Related Place & Competitor Finder", "description": "Find the related and 'people also search for' places Google Maps shows on a business, hotel, or landmark page. Get each related place's name, rating, review count, category, coordinates, and image, linked back to the place you searched.", "version": "1.0", "x-build-id": "97AjPnapucPrZpz9l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~google-maps-related-place-and-competitor-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-google-maps-related-place-and-competitor-finder", "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/dataspryva~google-maps-related-place-and-competitor-finder/runs": { "post": { "operationId": "runs-sync-dataspryva-google-maps-related-place-and-competitor-finder", "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/dataspryva~google-maps-related-place-and-competitor-finder/run-sync": { "post": { "operationId": "run-sync-dataspryva-google-maps-related-place-and-competitor-finder", "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": { "mode": { "title": "Mode", "enum": [ "byPlace", "byQuery" ], "type": "string", "description": "Choose how to enter the source places.", "default": "byPlace" }, "placeUrls": { "title": "Place URLs or IDs", "type": "array", "description": "Google Maps place URLs, canonical ChIJ Place IDs, or legacy 0x…:0x… feature IDs. Mixed values are allowed (mode=byPlace).", "items": { "type": "string" } }, "searchQueries": { "title": "Place names", "type": "array", "description": "Business, hotel, or landmark names to resolve and analyze (mode=byQuery).", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City or area appended to every place name (mode=byQuery)." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of similar places to return across all sources.", "default": 100 }, "similaritySource": { "title": "Related places source", "enum": [ "auto", "carousel", "sameCategory" ], "type": "string", "description": "Auto uses Google's related carousel and falls back to same-category nearby places when the carousel has fewer than Min similar. Carousel never uses the fallback. Same category skips the carousel.", "default": "auto" }, "minSimilar": { "title": "Min similar", "minimum": 0, "maximum": 20, "type": "integer", "description": "In auto mode, use the same-category fallback when the carousel has fewer usable rows than this number and cannot already fill Max results.", "default": 5 }, "categoryOverride": { "title": "Category override", "type": "string", "description": "Use this category for the same-category fallback instead of the source place's own category." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop related places rated below this value. Places without a published rating are dropped when this is above zero." }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop related places with fewer than this many reviews." }, "maxDistanceKm": { "title": "Maximum distance (km)", "minimum": 0.1, "maximum": 50, "type": "number", "description": "Keep only related places within this straight-line distance from the source. Requires published coordinates." }, "categoryFilter": { "title": "Category contains", "type": "string", "description": "Keep only places whose category list contains this text (case-insensitive)." }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "rating", "reviews", "distance" ], "type": "string", "description": "Order of the returned rows. Recommended keeps Google's carousel and search order.", "default": "recommended" }, "deduplicate": { "title": "Remove duplicates", "type": "boolean", "description": "Keep one row per place, using the canonical Place ID, then the feature ID, then name and coordinates.", "default": true }, "includeDetails": { "title": "Include details", "type": "boolean", "description": "Look up each returned place's own page for its canonical Place ID, address, website, phone, categories, plus code, photo count, and image. Adds one request per row and slows dense runs.", "default": true }, "includeMedia": { "title": "Include images", "type": "boolean", "description": "Include the image URL when Google publishes one.", "default": true }, "language": { "title": "Language", "enum": [ "en", "es", "fr", "de", "it", "pt", "ja", "ko", "zh", "ar", "ru" ], "type": "string", "description": "Google Maps interface language. Affects names, categories, and the fallback category query.", "default": "en" } } }, "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 } } } } } } } } } }