{ "openapi": "3.0.1", "info": { "title": "Instagram Stories Scraper - Live Stories and Highlights", "description": "Scrape stories and pinned highlights from public Instagram profiles: media type, image and video links, posting time, caption, mentions, links and hashtags, location, sponsored flag and highlight tray. A story is gone 24 hours after it goes up, so a run sees what is live now. $2.50 per 1,000 rows.", "version": "0.1", "x-build-id": "9YWmNuiuwHUTAx5BS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~instagram-stories-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-instagram-stories-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/dami_studio~instagram-stories-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-instagram-stories-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/dami_studio~instagram-stories-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-instagram-stories-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": { "profiles": { "title": "Public Instagram profiles", "maxItems": 10, "type": "array", "description": "Up to ten public Instagram usernames, @handles, or profile URLs. Empty input returns exactly one labeled, uncharged sample row.", "items": { "type": "string" } }, "maxStoriesPerProfile": { "title": "Maximum current stories per profile", "minimum": 1, "maximum": 100, "type": "integer", "description": "Most rows returned for each profile, counting current stories and highlights together. Highlights can hold hundreds of items, so this is what keeps a run's size and cost predictable.", "default": 25 }, "includeHighlights": { "title": "Also get story highlights", "type": "boolean", "description": "Highlights are the trays pinned to a profile. They do not expire, so this is how you get a profile's older stories rather than only what is live today. It is on by default, so a run returns both unless you untick it. A run with highlights is bigger and so costs more, since you pay per row either way, and a profile with nothing pinned returns nothing extra. Highlights need a paid Apify plan: on the free plan a run returns live stories only.", "default": true }, "mode": { "title": "What to read", "enum": [ "both", "storiesOnly", "highlightsOnly" ], "type": "string", "description": "Both is the default and reads live stories and highlights. Live stories only skips the highlight trays, the same as unticking the box above. Highlights only skips the live stories and reads the pinned trays alone; it does not use an account cookie.", "default": "both" }, "maxHighlightTrays": { "title": "Maximum highlight trays per profile", "minimum": 1, "maximum": 100, "type": "integer", "description": "Read only the first this many highlight trays of each profile, in the order Instagram shows them. Leave it empty to read every tray." }, "highlightTitlesOnly": { "title": "Highlight titles only", "type": "boolean", "description": "One row per highlight tray, with its title, cover picture and how many items it holds, without opening the tray. Each tray row is billed as one result, the same as a story.", "default": false }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 5, "maximum": 30, "type": "integer", "description": "Timeout for each Instagram request.", "default": 15 }, "maxRunSeconds": { "title": "Maximum run seconds", "minimum": 20, "maximum": 180, "type": "integer", "description": "Hard wall-clock bound for profile resolution and story retrieval.", "default": 120 }, "sessionCookies": { "title": "Account cookies (not needed)", "minItems": 0, "maxItems": 20, "type": "array", "description": "Optional: your own session, used only for your run. You are responsible for using it within the site's terms. Runs work without it.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Leave this alone unless you need the run to go out through a particular network. Your own proxy servers are used exactly as given." }, "maxAttempts": { "title": "Maximum attempts per request", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many times a failed request is tried again before the run gives up on it.", "default": 6 } } }, "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 } } } } } } } } } }