{ "openapi": "3.0.1", "info": { "title": "Instagram Highlights Scraper", "description": "The Instagram Highlights Scraper automates data extraction from Instagram story highlights. Collect titles, captions, view counts, and media URLs quickly. Ideal for marketers, researchers, and content creators seeking structured insights for analysis, reporting, or archiving.", "version": "0.1", "x-build-id": "cTnKpYEJEN8b7p5id" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~instagram-highlights-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-instagram-highlights-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-highlights-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-instagram-highlights-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-highlights-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-instagram-highlights-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": "📥 Profile URLs, Usernames, Highlight Links, or Shortcodes", "type": "array", "description": "🔗 Add one or more targets — each line is one input. Accepted: full profile URL (https://www.instagram.com/username), username (username or @username), a direct highlight link (https://www.instagram.com/stories/highlights//), or a post/reel/IGTV shortcode (e.g. /p/, /reel/, /tv/ share codes or a bare shortcode token) — each shortcode/highlight-link is genuinely resolved to its owning profile via Instagram's public embed pages, then every highlight (title, ID, cover image, full-res cover, success/error, timestamp) is scraped for that profile. Perfect for bulk extraction across many accounts.", "items": { "type": "string" } }, "maxHighlightsPerProfile": { "title": "📄 Max Highlights Per Profile", "minimum": 0, "type": "integer", "description": "Cap on how many highlights to fetch per profile, across ALL pages of the tray. 0 = unlimited (fetch every page until Instagram reports no more highlights).", "default": 0 }, "archiveCoverImages": { "title": "🖼️ Archive Full-Resolution Covers to Key-Value Store", "type": "boolean", "description": "When enabled, the actor resolves each highlight's genuinely full-resolution cover photo (via Instagram's reels_media endpoint, matched to the tray thumbnail by CDN asset ID — never a mismatched photo) and downloads a permanent copy into this run's Key-Value Store, so the cover survives after Instagram's CDN link (`oe=` timestamp) expires.", "default": true }, "enableProfileSummary": { "title": "📊 Per-Profile Summary Row", "type": "boolean", "description": "Push one extra, uncharged summary row per profile — highlight count, combined titles, first/last highlight ID, and success rate — right after that profile's highlight rows.", "default": true }, "enableLeaderboard": { "title": "🏆 Cross-Profile Leaderboard", "type": "boolean", "description": "Push one extra, uncharged leaderboard row per profile at the end of the run, ranking every profile in this run by highlight count (highest first) — ideal for comparing multiple competitors/influencers in one run.", "default": true }, "proxyConfiguration": { "title": "🛡️ Proxy Configuration", "type": "object", "description": "Choose which proxies to use, including a custom apifyProxyGroups/apifyProxyCountry selection. Strategy: start with your selection (e.g. no proxy or Apify proxy). On HTTP 429 or 403 (platform block), the actor fails fast and falls back: first to datacenter, then to residential — genuinely carrying YOUR chosen proxy group(s) and country through to both fallback tiers (previously they were silently discarded). Residential gets up to 3 retries with a new proxy URL each time; once residential is used, it stays in \"sticky\" mode for all remaining URLs so the run stays stable." } } }, "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 } } } } } } } } } }