{ "openapi": "3.0.1", "info": { "title": "Instagram Reels Scraper", "description": "Scrape Instagram Reels, Profiles and Posts efficiently and reliably.", "version": "1.2", "x-build-id": "ytflgZNQ8bzKcobgj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hpix~ig-reels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hpix-ig-reels-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~ig-reels-scraper/runs": { "post": { "operationId": "runs-sync-hpix-ig-reels-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~ig-reels-scraper/run-sync": { "post": { "operationId": "run-sync-hpix-ig-reels-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": [ "target", "reels_count" ], "properties": { "profiles": { "title": "Profiles", "minItems": 0, "type": "array", "description": "Instagram usernames or URLs to fetch content from.", "items": { "type": "string" } }, "target": { "title": "Content to scrape", "enum": [ "all", "all_with_posts", "profiles_only", "reels_only", "posts_only", "reels_and_posts_only" ], "type": "string", "description": "Select what will be scraped from the profiles.", "default": "all" }, "reels_count": { "title": "Max posts/reels per profile", "type": "integer", "description": "Number of posts/reels to scrape per profile.", "default": 12 }, "fetch_reels_data": { "title": "Scrape reel details", "type": "boolean", "description": "When enabled, extra metadata (play count, view count, music info, duration) is fetched for each reel. This is most useful when scraping posts and reels together and requires more proxy bandwidth.", "default": false }, "skip_pinned": { "title": "Skip pinned", "type": "boolean", "description": "Don't scrape pinned posts", "default": false }, "post_urls": { "title": "Individual Posts", "type": "array", "description": "Scrape posts using their URL or short code", "items": { "type": "string" } }, "beginDate": { "title": "Starting date", "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": "Only scrape posts created after this date" }, "endDate": { "title": "Ending date", "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": "Only scrape posts created before this date" }, "include_raw_data": { "title": "Include raw data", "type": "boolean", "description": "Include raw data collected from Instagram in the final results. Disable this to reduce the final dataset size.", "default": true }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of concurrent requests to make. Use this to control the load on Instagram's servers and avoid getting blocked.", "default": 200 }, "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." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy configuration to use for requests. Residential proxies are recommended for better performance and reliability.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }