{ "openapi": "3.0.1", "info": { "title": "Instagram API Scraper", "description": null, "version": "0.1", "x-build-id": "qN43xRuwsJzlE91O8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraply~instagram-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraply-instagram-api-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/scraply~instagram-api-scraper/runs": { "post": { "operationId": "runs-sync-scraply-instagram-api-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/scraply~instagram-api-scraper/run-sync": { "post": { "operationId": "run-sync-scraply-instagram-api-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": [ "directUrls" ], "properties": { "directUrls": { "title": "๐Ÿ”— Instagram URLs or usernames", "type": "array", "description": "โœจ Drop one or more Instagram URLs or bare usernames. Supports:\nโ€ข ๐Ÿ‘ค Profiles โ€” `https://www.instagram.com/humansofny/` or just `humansofny`\nโ€ข ๐Ÿ“ท Posts โ€” `https://www.instagram.com/p//`\nโ€ข ๐ŸŽฌ Reels โ€” `https://www.instagram.com/reel//`\nโ€ข #๏ธโƒฃ Hashtags โ€” `https://www.instagram.com/explore/tags//`", "items": { "type": "string" } }, "resultsType": { "title": "๐ŸŽฏ What to scrape", "enum": [ "posts", "comments", "details", "mentions", "reels", "stories" ], "type": "string", "description": "Choose the output type for each URL above.\nโ€ข ๐Ÿ“ท **posts** โ€” recent posts from a profile / hashtag / single post\nโ€ข ๐Ÿ’ฌ **comments** โ€” public comments under a post or reel\nโ€ข ๐Ÿชช **details** โ€” profile or post metadata only\nโ€ข ๐Ÿ”– **mentions** โ€” extract `@mentions` from posts, or list hashtag posts\nโ€ข ๐ŸŽฌ **reels** โ€” reels feed from a profile\nโ€ข ๐Ÿ“– **stories** โ€” story-side fetch (best-effort, public only)", "default": "posts" }, "resultsLimit": { "title": "๐Ÿ”ข Max results per URL", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of items to return for each URL (posts, comments, reels, etc.).", "default": 10 }, "onlyPostsNewerThan": { "title": "๐Ÿ“… Only items newer than", "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": "๐Ÿ“† Limit how far back to scrape. Pick an absolute date (`YYYY-MM-DD`) or a relative window (`7 days`, `2 months`, `3 years`). Only items posted on or after this cutoff are returned. Leave empty for no filter. All times are UTC." }, "addParentData": { "title": "๐Ÿงท Attach parent (source) metadata", "type": "boolean", "description": "If enabled, each result item also includes a `parentData` field with the source profile/hashtag info.", "default": false }, "search": { "title": "๐Ÿ”Ž Search query (optional)", "type": "string", "description": "Run an Instagram search instead of (or in addition to) URLs. Leave empty to disable search.", "default": "" }, "searchType": { "title": "๐Ÿ” Search type", "enum": [ "user", "hashtag", "place" ], "type": "string", "description": "What the search query targets.", "default": "hashtag" }, "searchLimit": { "title": "๐Ÿ”ข Search results limit", "minimum": 1, "maximum": 250, "type": "integer", "description": "Number of search results to return (1โ€“250).", "default": 1 }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy configuration", "type": "object", "description": "๐ŸŒ Default: **no proxy** โ€” the actor talks to Instagram directly.\nIf Instagram rejects or blocks requests, the actor automatically escalates: ๐Ÿ” datacenter proxy โ†’ ๐Ÿ  residential proxy (3 retries). Once it falls back to residential, it sticks with residential for the rest of the run.\nYou can override the default by enabling Apify Proxy below.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }