{ "openapi": "3.0.1", "info": { "title": "Instagram Scraper", "description": "Scrape Instagram profiles, posts, and Reels at scale.", "version": "1.1", "x-build-id": "3SPFazfaIJWzXhaT7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hpix~instagram-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hpix-instagram-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/hpix~instagram-scraper/runs": { "post": { "operationId": "runs-sync-hpix-instagram-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/hpix~instagram-scraper/run-sync": { "post": { "operationId": "run-sync-hpix-instagram-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": "Profiles", "minItems": 0, "type": "array", "description": "Instagram usernames or URLs", "items": { "type": "string" } }, "scrape_posts": { "title": "Scrape posts", "type": "boolean", "description": "Scrape all posts (images and reels) from profiles.", "default": true }, "scrape_reels": { "title": "Scrape reels", "type": "boolean", "description": "Scrape reels from profiles. To scrape metadata like play count and music info, disable the \"Scrape posts\" option above.", "default": true }, "scrape_profile_data": { "title": "Scrape profile data", "type": "boolean", "description": "Scrape profile information", "default": true }, "posts_per_account": { "title": "Posts per account", "type": "integer", "description": "Number of posts/reels to fetch per user", "default": 12 }, "skip_pinned_timeline": { "title": "Skip pinned posts", "type": "boolean", "description": "Skips posts pinned on the timeline view (first tab) of a profile", "default": false }, "skip_pinned_reels": { "title": "Skip pinned reels", "type": "boolean", "description": "Skips reels pinned on the reels view (second tab) of a profile", "default": false }, "posts": { "title": "Individual Posts", "type": "array", "description": "Scrape posts using their URL or code", "items": { "type": "string" } }, "scrape_restricted_posts": { "title": "[$] Scrape restricted posts", "type": "boolean", "description": "Scrape age-restricted or otherwise limited Instagram posts that are not publicly available by default. This is a paid feature — please refer to the Actor pricing.", "default": false }, "fromDate": { "title": "From date (oldest)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Start scraping from this date (oldest posts to include)" }, "toDate": { "title": "To date (newest)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Stop scraping at this date (newest posts to include)" }, "custom_functions": { "title": "Custom functions", "type": "string", "description": "Functions to customize the crawler's behaviour. Accepts an object with two functions, `shouldSkip` and `shouldContinue`, each taking a data argument which contains the data for the current scraped item." }, "include_raw_data": { "title": "Include raw data", "type": "boolean", "description": "Include the `data` field in the output. Disabling this decreases the size of the output dataset.", "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 } } } } } } } } } }