{ "openapi": "3.0.1", "info": { "title": "Google Maps Rank Tracker", "description": "Track Google Maps rankings across a geo-grid heatmap. Get SoLV score, competitor leaderboard, gap analysis, zone breakdown, trend tracking & interactive HTML dashboard. Bulk scan up to 10 businesses. White-label reports. Free LocalFalcon & BrightLocal alternative β€” 50% cheaper, no monthly fees.", "version": "1.1", "x-build-id": "gVhDmYegVsNGZDTmN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vasram~google-maps-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vasram-google-maps-rank-tracker", "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/vasram~google-maps-rank-tracker/runs": { "post": { "operationId": "runs-sync-vasram-google-maps-rank-tracker", "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/vasram~google-maps-rank-tracker/run-sync": { "post": { "operationId": "run-sync-vasram-google-maps-rank-tracker", "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", "required": [ "keyword" ], "properties": { "businessName": { "title": "Business Name", "minLength": 2, "maxLength": 200, "type": "string", "description": "πŸ“ Your business name **exactly** as it appears on Google Maps (2-200 characters)" }, "keyword": { "title": "Search Keyword", "minLength": 2, "maxLength": 100, "type": "string", "description": "πŸ” The keyword to track (e.g., 'plumber near me', 'best restaurant'). 2-100 characters." }, "location": { "title": "Location (Address / City)", "type": "string", "description": "πŸ“Œ City name or full address β€” we'll auto-detect coordinates. Example: `Brooklyn, NY` or `Connaught Place, Delhi`" }, "gridSize": { "title": "Grid Size", "enum": [ "3x3", "5x5", "7x7", "9x9" ], "type": "string", "description": "πŸ“ Grid dimensions β€” larger grids give more detail but cost more", "default": "3x3" }, "businesses": { "title": "Businesses to Scan", "maxItems": 10, "type": "array", "description": "πŸ“¦ Provide a JSON array of businesses. Max 10 per run.\n\nExample:\n```json\n[\n {\n \"businessName\": \"Joe's Pizza\",\n \"keyword\": \"best pizza near me\",\n \"location\": \"Brooklyn, NY\"\n }\n]\n```" }, "placeId": { "title": "Place ID", "type": "string", "description": "🏒 Google Place ID for exact matching (starts with 'ChI'). Leave empty to match by name." }, "lat": { "title": "Center Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "πŸ—ΊοΈ Latitude of grid center (-90 to 90). Leave empty if you provided a Location above." }, "lng": { "title": "Center Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "πŸ—ΊοΈ Longitude of grid center (-180 to 180). Leave empty if you provided a Location above." }, "radius": { "title": "Radius", "minimum": 0.1, "maximum": 100, "type": "number", "description": "β­• Search radius from center point. Set measurement unit below.", "default": 5 }, "measurement": { "title": "Measurement Unit", "enum": [ "km", "miles" ], "type": "string", "description": "πŸ“ Unit for the radius β€” kilometers or miles", "default": "km" }, "language": { "title": "Language", "enum": [ "en", "hi", "es", "fr", "de", "pt", "ar", "ja", "ko", "zh" ], "type": "string", "description": "🌐 Language for Google Maps search results (e.g., English, Hindi)", "default": "en" }, "country": { "title": "Search Country", "enum": [ "us", "in", "uk", "ca", "au", "nz", "za", "sg", "ie", "ph", "ae", "de", "fr", "it", "es", "br", "mx", "jp", "kr", "cn", "id", "my", "th", "vn", "nl", "be", "ch", "at", "se", "no", "dk", "fi", "pl", "tr", "ru", "sa", "eg", "ng", "ke", "ar", "cl", "co", "pe" ], "type": "string", "description": "🏳️ Primary country for Google Maps (Auto-detected if Location is provided)", "default": "us" }, "maxCompetitorsPerPoint": { "title": "Competitors per Grid Point", "minimum": 1, "maximum": 20, "type": "integer", "description": "πŸ“Š How many competitor details to store per point (1-20)", "default": 5 }, "fetchReviews": { "title": "Fetch Review Breakdown", "type": "boolean", "description": "⭐ Fetch star distribution (1β˜…-5β˜…) for your business. Uses 1 extra API credit.", "default": true }, "gridSpacingKm": { "title": "Custom Grid Spacing (km)", "minimum": 0.1, "maximum": 50, "type": "number", "description": "πŸ“ Optional: Override automatic grid spacing. Use smaller values for dense urban areas (e.g., 0.5 km). Leave empty for auto-calculation based on radius." }, "agencyName": { "title": "Agency / Brand Name", "type": "string", "description": "🏷️ Your agency or brand name. Replaces the default 'Local Rank Grid Tracker' branding in the HTML report header and footer." }, "agencyLogo": { "title": "Agency Logo URL", "type": "string", "description": "πŸ–ΌοΈ URL of your agency logo (PNG, JPG, SVG). Displayed in the HTML report navbar. Recommended size: 120Γ—40px." } } }, "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 } } } } } } } } } }