{ "openapi": "3.0.1", "info": { "title": "Instagram Location Scraper", "description": "Scrape Instagram posts by location using this Apify actor. It extracts post captions, image URLs, hashtags, usernames, geotags, and engagement data from any location page. Ideal for local marketing, trend tracking, or research with exportable results in JSON, CSV, or Excel formats.", "version": "0.1", "x-build-id": "xVqN4tUidCkPpgoyx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~instagram-location-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-instagram-location-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/scraper-engine~instagram-location-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-instagram-location-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/scraper-engine~instagram-location-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-instagram-location-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "🔎 Location URLs, Usernames, or Keywords", "type": "array", "description": "List of Instagram location URLs, usernames, or keywords. Examples: 'https://www.instagram.com/explore/locations/213131048/berlin-germany/' (URL), 'mrbeast' (username), 'berlin' (keyword)", "items": { "type": "string" } }, "maxItems": { "title": "📦 Maximum Items", "minimum": 0, "type": "integer", "description": "Maximum number of posts to extract (0 for unlimited)", "default": 20 }, "sessionId": { "title": "🔐 Instagram Session ID", "type": "string", "description": "Instagram session ID cookie value (required for authentication). Get this from your browser cookies when logged into Instagram.", "default": "" }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Choose which proxies to use. If Instagram rejects the proxy, a residential proxy will be used as a fallback." }, "dateFilterType": { "title": "⏳ Posts Newer Than", "enum": [ "absolute", "relative" ], "type": "string", "description": "Select whether to use absolute date or relative time", "default": "relative" }, "absoluteStartDate": { "title": "📅 Start Date", "pattern": "^(|\\d{4}-\\d{2}-\\d{2})$", "type": "string", "description": "Start date in YYYY-MM-DD format. Use this when 'Posts newer than' is set to 'absolute'.", "default": "" }, "absoluteEndDate": { "title": "📅 End Date", "pattern": "^(|\\d{4}-\\d{2}-\\d{2})$", "type": "string", "description": "End date in YYYY-MM-DD format. Use this when 'Posts newer than' is set to 'absolute'. Leave empty for current date.", "default": "" }, "relativeValue": { "title": "🔢 Relative Value", "minimum": 0, "type": "integer", "description": "Number of time units. Use this when 'Posts newer than' is set to 'relative'.", "default": 0 }, "relativeUnit": { "title": "🕒 Time Unit", "enum": [ "days", "weeks", "months", "years" ], "type": "string", "description": "Unit of time for relative date", "default": "days" }, "sortOrder": { "title": "↕️ Sort Order", "enum": [ "ranked", "recent" ], "type": "string", "description": "How location posts are ordered. 'ranked' returns Instagram's top posts tab; 'recent' returns the most recent posts tab.", "default": "ranked" }, "includeEngagement": { "title": "💬 Include Engagement Metrics", "type": "boolean", "description": "Include engagement metrics (like count and comment count) on each post. Turn off to null these fields.", "default": true }, "includeVideoMetadata": { "title": "🎥 Include Video Metadata", "type": "boolean", "description": "Include detailed video metadata (width, height, duration) on video posts. Turn off to keep only the video id and url.", "default": 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 } } }, "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 } } } } } } } } } }